Skip to content

Commit

Permalink
docs: config guide restructuring (#8932)
Browse files Browse the repository at this point in the history
* docs(nav): restructure config section

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

* docs(nav): add doc file for missing sections

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

* docs(nav): add files

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

* docs(nav): add config guide file for custom assets

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

* docs(nav): move device auth and passwd validation to recipes

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

* docs(fix): update the tag

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

* docs(fix): add placeholder content

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

* docs:remove comments from plugins

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

* docs: relocate files

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

* docs: relocate SCIM guides

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

* docs: move fido2 config doc

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

* docs: update links and paths to point to new file locations

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

* fix(docs): rollback commented section

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

---------

Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>
  • Loading branch information
ossdhaval committed Jul 10, 2024
1 parent ea93e5b commit 9e25c05
Show file tree
Hide file tree
Showing 28 changed files with 146 additions and 92 deletions.
2 changes: 1 addition & 1 deletion docs/admin/auth-server/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ in!
The Configuration Server is a JSON/REST API that writes to the database,
generates the keys, and does much of the other work you need to make your
Janssen Project infrastructure solve your digital identity challenges.
See the [Config API Guide](../config-guide/config-api/README.md) for more information.
See the [Config API Guide](../config-guide/config-tools/config-api/README.md) for more information.

## Tools

Expand Down
2 changes: 1 addition & 1 deletion docs/admin/auth-server/openid-features/acrs.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ All Janssen Server deployments have `default_ldap_server` ACR which can be enabl
remote LDAP-based IDP (e.g. ActiveDirectory). By default, this ACR is disabled. This ACR can only authenticate against
LDAP-based IDP or a local LDAP.

Use the instructions provided in jans-cli [LDAP configuration options](../../config-guide/ldap-configuration.md) documentation to learn how to enable and configure ACRs that use external LDAP as IDP.
Use the instructions provided in jans-cli [LDAP configuration options](../../config-guide/auth-server-config/ldap-configuration.md) documentation to learn how to enable and configure ACRs that use external LDAP as IDP.

### 3. Script-based ACRs

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,21 +18,21 @@ tasks.
=== "Use Command-line"

Use the command line to perform actions from the terminal. Learn how to
use Jans CLI [here](./config-tools/jans-cli/README.md) or jump straight to
use Jans CLI [here](../config-tools/jans-cli/README.md) or jump straight to
the [configuration steps](#using-command-line)

=== "Use Text-based UI"

Use a fully functional text-based user interface from the terminal.
Learn how to use Jans Text-based UI (TUI)
[here](./config-tools/jans-tui/README.md) or jump straight to the
[here](../config-tools/jans-tui/README.md) or jump straight to the
[configuration steps](#using-text-based-ui)

=== "Use REST API"

Use REST API for programmatic access or invoke via tools like CURL or
Postman. Learn how to use Janssen Server Config API
[here](./config-tools/config-api/README.md) or Jump straight to the
[here](../config-tools/config-api/README.md) or Jump straight to the
[configuration steps](#using-configuration-rest-api)


Expand Down Expand Up @@ -226,7 +226,7 @@ by the project name. The command line for this operation is as below:
You can deploy the Agama project in the Janssen Server through the command line
using the `post-agama-prj` operation. Here the `agama-project-file` is an
archive file that holds the bundled Agama project and follows the
[.gama](../../agama/gama-format.md) specification.
[.gama](../../../agama/gama-format.md) specification.

```bash title="Sample Command"
/opt/jans/jans-cli/config-cli.py --operation-id post-agama-prj \
Expand Down Expand Up @@ -350,7 +350,7 @@ DSL related errors, use the `agama-syntax-check` operation as below:
## Using Text-based UI

In Janssen, You can deploy and customize an Agama project using
the [Text-Based UI](./config-tools/jans-tui/README.md) also.
the [Text-Based UI](../config-tools/jans-tui/README.md) also.

You can start TUI using the command below:

Expand All @@ -371,22 +371,22 @@ in the image below.
dialogue. Using this dialogue, navigate the file system and select
the `.gama` archive for the new project.

![image](../../assets/tui-agama-project-list.png)
![image](../../../assets/tui-agama-project-list.png)

### Agama Project Help Menu

TUI provides key-press commands to open various dialogues that help manage and
configure Agama projects. All the key-press commands are listed in the help menu.
Press `F1` to bring up the help menu as shown in the screen below.

![image](../../assets/tui-agama-project-help.png)
![image](../../../assets/tui-agama-project-help.png)

### Agama Project Detail Screen

Use the appropriate key-press command from [help screen](#agama-project-help-menu)
to bring up the project detail screen which is shown in the image below.

![image](../../assets/tui-agama-project-details.png)
![image](../../../assets/tui-agama-project-details.png)

The project details screen shows important details about the Agama project.
In case the project deployment is facing an error, this screen also shows
Expand All @@ -398,7 +398,7 @@ Fully qualified names are useful when invoking flows.
The project details screen also shows the JSON configuration by navigating to and
pressing the `View Configuration` button.

![image](../../assets/tui-agama-project-view-conf.png)
![image](../../../assets/tui-agama-project-view-conf.png)

### Agama Project Configuration Screen

Expand All @@ -411,11 +411,11 @@ below.
make the necessary changes to it and import it back to correctly
configure the project.

![image](../../assets/tui-agama-project-manage-conf.png)
![image](../../../assets/tui-agama-project-manage-conf.png)


## Using Configuration REST API

Janssen Server Configuration REST API exposes relevant endpoints for managing
and configuring Agama projects. Endpoint details are published in the [Swagger
document](./../reference/openapi.md).
document](./../../reference/openapi.md).
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ tasks.
=== "Use Command-line"

Use the command line to perform actions from the terminal. Learn how to
use Jans CLI [here](./config-tools/jans-cli/README.md) or jump straight to
use Jans CLI [here](../config-tools/jans-cli/README.md) or jump straight to
the [Using Command Line](#using-command-line)

=== "Use Text-based UI"
Expand All @@ -26,7 +26,7 @@ tasks.

Use REST API for programmatic access or invoke via tools like CURL or
Postman. Learn how to use Janssen Server Config API
[here](./config-tools/config-api/README.md) or Jump straight to the
[here](../config-tools/config-api/README.md) or Jump straight to the
[Using Configuration REST API](#using-configuration-rest-api)


Expand Down Expand Up @@ -113,7 +113,7 @@ To get sample schema type /opt/jans/jans-cli/config-cli.py --schema <schema>, fo
The `patch-config-cache` operation uses the
[JSON Patch](https://jsonpatch.com/#the-patch) schema to describe
the configuration change. Refer
[here](config-tools/jans-cli/README.md#patch-request-schema) to know more about
[here](../config-tools/jans-cli/README.md#patch-request-schema) to know more about
schema.

For instance, to perform a `replace` operation at
Expand Down Expand Up @@ -187,10 +187,10 @@ the following command line:
```

It will change the value with the given one. There are few options to do
such quick patch operations. Please check them out from [here](config-tools/jans-cli/README.md#quick-patch-operations).
such quick patch operations. Please check them out from [here](../config-tools/jans-cli/README.md#quick-patch-operations).

## Using Configuration REST API

Janssen Server Configuration REST API exposes relevant endpoints for managing
and configuring Cache. Endpoint details are published in the [Swagger
document](./../reference/openapi.md).
and configuring Cache. Endpoint details are published in the
[Swagger document](./../../reference/openapi.md).
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ tags:

# Couchbase Database Configuration

> Prerequisite: Know how to use the Janssen CLI in [command-line mode](config-tools/jans-cli/README.md)
> Prerequisite: Know how to use the Janssen CLI in [command-line mode](../config-tools/jans-cli/README.md)
If your janssen server backend is connected with couchbase database then you can go with these operations instead of [LDAP configuration](ldap-configuration.md).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The Janssen Server provides multiple configuration tools to perform these tasks.
checks if the same authentication is available and active.

See
[script documentation](custom-scripts-config.md#update-an-existing-custom-script)
[script documentation](../custom-scripts-config.md#update-an-existing-custom-script)
to know how to enable/disable authentication methods using custom scripts.


Expand All @@ -31,26 +31,27 @@ The Janssen Server provides multiple configuration tools to perform these tasks.
}
```

Also, to understand how Janssen Server picks the authentication method *in absence* of default authentication method, refer to [ACR documentation](../auth-server/openid-features/acrs.md#flowchart---how-the-jans-as-derives-an-acr-value-for-a-user-session-)
Also, to understand how Janssen Server picks the authentication method *in absence* of default authentication method, refer to
[ACR documentation](../../auth-server/openid-features/acrs.md#flowchart---how-the-jans-as-derives-an-acr-value-for-a-user-session-)

=== "Use Command-line"

Use the command line to perform actions from the terminal. Learn how to
use Jans CLI [here](./config-tools/jans-cli/README.md) or jump straight to
use Jans CLI [here](../config-tools/jans-cli/README.md) or jump straight to
the [Using Command Line](#using-command-line)

=== "Use Text-based UI"

Use a fully functional text-based user interface from the terminal.
Learn how to use Jans Text-based UI (TUI)
[here](./config-tools/jans-tui/README.md) or jump straight to the
[here](../config-tools/jans-tui/README.md) or jump straight to the
[Using Text-based UI](#using-text-based-ui)

=== "Use REST API"

Use REST API for programmatic access or invoke via tools like CURL or
Postman. Learn how to use Janssen Server Config API
[here](./config-tools/config-api/README.md) or Jump straight to the
[here](../config-tools/config-api/README.md) or Jump straight to the
[Using Configuration REST API](#using-configuration-rest-api)

## Using Command Line
Expand Down Expand Up @@ -143,7 +144,7 @@ It will show the updated result.
## Using Text-based UI

In Janssen, You can manage default authentication method using
the [Text-Based UI](./config-tools/jans-tui/README.md) also.
the [Text-Based UI](../config-tools/jans-tui/README.md) also.

You can start TUI using the command below:

Expand All @@ -157,7 +158,7 @@ Navigate to `Auth Server` -> `Authn` to open the `Authn` screen as shown
in the image below. This screen lists the available authentication methods
where the default method is marked with `x` under the `Default` column.

![image](../../assets/tui-curr-authn-method.png)
![image](../../../assets/tui-curr-authn-method.png)


### Update Default Authentication Method
Expand All @@ -172,5 +173,5 @@ authentication method.

Janssen Server Configuration REST API exposes relevant endpoints for managing
and configuring the Default Authentication Method. Endpoint details are published
in the [Swagger document](./../reference/openapi.md).
in the [Swagger document](./../../reference/openapi.md).

Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ tags:

# Janssen Authorization Server

> Prerequisite: Know how to use the Janssen CLI in [command-line mode](config-tools/jans-cli/README.md)
> Prerequisite: Know how to use the Janssen CLI in [command-line mode](../config-tools/jans-cli/README.md)
To get info about Jans Authorization Server operations:

Expand Down Expand Up @@ -627,7 +627,7 @@ It will create a `.json` file in `/tmp` with schema.
Let's modify this schema:
`nano /tmp/patch-jans-auth.json`

![patch jans auth](../../assets/image-cl-patch-jans-auth-03042021.png)
![patch jans auth](../../../assets/image-cl-patch-jans-auth-03042021.png)

This schema has three properties; `op`, `path` & `value`.
Let's perform a `replace` operation at `cibaEnabled` to change it from `false` to `true`.
Expand All @@ -653,7 +653,7 @@ Now, let's do the operation.

If you run the following command line, you must see that `cibaEnabled` is `true`:

![Update result Jans Auth](../../assets/image-cl-update-jans-auth-03042021.png)
![Update result Jans Auth](../../../assets/image-cl-update-jans-auth-03042021.png)

## Get Persistence type for Jans Auth Configuration

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,21 +15,21 @@ tasks.
=== "Use Command-line"

Use the command line to perform actions from the terminal. Learn how to
use Jans CLI [here](./config-tools/jans-cli/README.md) or jump straight to
use Jans CLI [here](../config-tools/jans-cli/README.md) or jump straight to
the [Using Command Line](#using-command-line)

=== "Use Text-based UI"

Use a fully functional text-based user interface from the terminal.
Learn how to use Jans Text-based UI (TUI)
[here](./config-tools/jans-tui/README.md) or jump straight to the
[here](../config-tools/jans-tui/README.md) or jump straight to the
[Using Text-based UI](#using-text-based-ui)

=== "Use REST API"

Use REST API for programmatic access or invoke via tools like CURL or
Postman. Learn how to use Janssen Server Config API
[here](./config-tools/config-api/README.md) or Jump straight to the
[here](../config-tools/config-api/README.md) or Jump straight to the
[Using Configuration REST API](#using-configuration-rest-api)


Expand Down Expand Up @@ -384,7 +384,7 @@ Updated Json Web Key:

We see it has replaced the value of the `use` property from `enc` to `sig`.

Please read about [patch method](config-tools/jans-cli/README.md#quick-patch-operations),
Please read about [patch method](../config-tools/jans-cli/README.md#quick-patch-operations),
You can get some idea of how this patch method works to modify particular properties of any task.

### Delete Json Web Key using kid
Expand All @@ -402,7 +402,7 @@ It will delete the jwk if it matches with the given `kid`.
## Using Text-based UI

In Janssen, you can view the JSON web keys using
the [Text-Based UI](./config-tools/jans-tui/README.md) also.
the [Text-Based UI](../config-tools/jans-tui/README.md) also.

You can start TUI using the command below:

Expand All @@ -420,11 +420,11 @@ You can view Key's list on this page. You cannot perform any operations in text-

* Only you can perform operations using the command line.

![image](../../assets/tui-json-web-key.png)
![image](../../../assets/tui-json-web-key.png)


## Using Configuration REST API

Janssen Server Configuration REST API exposes relevant endpoints for managing
and configuring the Json Web key. Endpoint details are published in the [Swagger
document](./../reference/openapi.md).
and configuring the Json Web key. Endpoint details are published in the
[Swagger document](./../../reference/openapi.md).
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ tasks.
=== "Use Command-line"

Use the command line to perform actions from the terminal. Learn how to
use Jans CLI [here](./config-tools/jans-cli/README.md) or jump straight to
use Jans CLI [here](../config-tools/jans-cli/README.md) or jump straight to
the [Using Command Line](#using-command-line)


Expand All @@ -27,7 +27,7 @@ tasks.

Use REST API for programmatic access or invoke via tools like CURL or
Postman. Learn how to use Janssen Server Config API
[here](./config-tools/config-api/README.md) or Jump straight to the
[here](../config-tools/config-api/README.md) or Jump straight to the
[Using Configuration REST API](#using-configuration-rest-api)

## Using Command Line
Expand Down Expand Up @@ -343,7 +343,7 @@ Operation ID: patch-config-database-ldap-by-name
```
The `patch-config-database-ldap-by-name` uses the [JSON Patch](https://jsonpatch.com/#the-patch)
schema to describe the configuration change. Refer
[here](config-tools/jans-cli/README.md#patch-request-schema)
[here](../config-tools/jans-cli/README.md#patch-request-schema)
to know more about schema.

For example, let's say, we want to change the level of the `test_ldap` configuration. So,
Expand Down Expand Up @@ -394,4 +394,4 @@ It will update the configuration and will show the updated result as below displ

Janssen Server Configuration REST API exposes relevant endpoints for managing
and configuring the Lightweight Directory Access Protocol. Endpoint details are published in the [Swagger
document](./../reference/openapi.md).
document](./../../reference/openapi.md).
Loading

0 comments on commit 9e25c05

Please sign in to comment.