Skip to content

Commit

Permalink
docs(navigation): fix 404 for configuration docs (#5834)
Browse files Browse the repository at this point in the history
* docs(navigation): fix 404 for attribute doc

Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>

* docs(cli): refactor cli standalone install instructions

Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>

---------

Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>
  • Loading branch information
ossdhaval authored Aug 11, 2023
1 parent 5379b36 commit 1718679
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 39 deletions.
17 changes: 17 additions & 0 deletions docs/admin/config-guide/config-tools/jans-cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -336,3 +336,20 @@ To run operations on Janssen Server, CLI client will need to be authenticated an
4. After successful user authentication, the next screen allows the user to enter the user code. Use the user code presented on command-line instruction in step 1 above.
5. After successful code validation, the user is presented with OAuth permissions screen. This screen would list all the permissions requested by Jans CLI. The user can choose to `Allow` or `Not Allow` granting of these permissions.
6. After allowing the grant of requested permissions, the user should come back to the command-line interface and hit <<Enter>> as instructed. This will enable CLI to run operations on the corresponding Janssen server.

## Stand-alone Installation

- Follow [these instructions](../jans-tui/README.md#1-build-pyz-self-executable-file) and create a self-executable file
- Run the file as shown in the example below to enter CLI mode. Here, supplying the argument `--no-tui` is necessary,
otherwise it will switch to TUI mode.
```
$ ./jans-cli-tui.pyz --no-tui --host test.jans.io --client-id 2000.562981df-1623-4136-b1d0-aaa277edc48c --client-secret KU6ydImJZK6S --operation-id get-acrs
Please wait while retrieving data ...
Access token was not found.
Please visit verification url https://test.jans.io/device-code?user_code=LKHC-PBTR and authorize this device within 1800 secods
Please press «Enter» when ready
{
"defaultAcr": "simple_password_auth"
}
```

24 changes: 0 additions & 24 deletions docs/admin/config-guide/config-tools/jans-cli/install.md

This file was deleted.

29 changes: 14 additions & 15 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -109,23 +109,22 @@ nav:
- Configuration Guide:
- Configuration Tools:
- Config API:
- admin/config-guide/config-api/README.md
- Settings: admin/config-guide/config-api/config.md
- Attributes: admin/config-guide/config-api/attribute.md
- Security: admin/config-guide/config-api/security.md
- Logs: admin/config-guide/config-api/logs.md
- Monitoring: admin/config-guide/config-api/monitoring.md
- Plugins: admin/config-guide/config-api/plugins.md
- CURL Guide: admin/config-guide/curl-guide.md
- admin/config-guide/config-tools/config-api/README.md
- Settings: admin/config-guide/config-tools/config-api/config.md
- Attributes: admin/config-guide/config-tools/config-api/attribute.md
- Security: admin/config-guide/config-tools/config-api/security.md
- Logs: admin/config-guide/config-tools/config-api/logs.md
- Monitoring: admin/config-guide/config-tools/config-api/monitoring.md
- Plugins: admin/config-guide/config-tools/config-api/plugins.md
- CURL Guide: admin/config-guide/config-tools/curl-guide.md
- Text-Based User Interface (TUI):
- admin/config-guide/jans-tui/README.md
- Navigation Guide: admin/config-guide/jans-tui/navigation-guide.md
- admin/config-guide/config-tools/jans-tui/README.md
- Navigation Guide: admin/config-guide/config-tools/jans-tui/navigation-guide.md
- Command Line Interface (CLI):
- admin/config-guide/jans-cli/README.md
- CLI For Agama Developer Studio: admin/config-guide/jans-cli/cli-agama.md
- SCIM CLI: admin/config-guide/scim-cli.md
- Standalone Installation: admin/config-guide/jans-cli/install.md
- Attribute: admin/config-guide/cli-attribute.md
- admin/config-guide/config-tools/jans-cli/README.md
- CLI For Agama Developer Studio: admin/config-guide/config-tools/jans-cli/cli-agama.md
- SCIM CLI: admin/config-guide/config-tools/scim-cli.md
- Attribute: admin/config-guide/attribute-configuration.md
- Default Authentication: admin/config-guide/default-authentication-method-config.md
- Cache Configuration: admin/config-guide/cache-configuration.md
- Auth Server Configuration: admin/config-guide/jans-authorization-server-config.md
Expand Down

0 comments on commit 1718679

Please sign in to comment.