Skip to content

Adjust oidc web config #717

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JammingBen merged 1 commit into from
Mar 17, 2026
Merged

Adjust oidc web config #717

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 7 additions & 12 deletions docs/dev/web/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,18 +67,13 @@ Controls the Web apps to be loaded. This is not for adding external apps, but fo

### `openIdConnect`

Options for the connection to the oIDC provider. Expects an object with the following possible options:

- `openIdConnect.authority` URL of the OIDC/OAuth2 provider.
- `openIdConnect.metadata_url` URL of the OIDC configuration.
- `openIdConnect.client_id` The client id registered with the OIDC/OAuth2 provider.
- `openIdConnect.client_secret`
- `openIdConnect.dynamic`
- `openIdConnect.post_logout_redirect_uri`
- `openIdConnect.response_type`
- `openIdConnect.scope`

See the [oidc-client-ts documentation](https://authts.github.io/oidc-client-ts/interfaces/OidcClientSettings.html) for more information.
The Web client forwards all configuration options under `openIdConnect` to the [oidc-client-ts library](https://authts.github.io/oidc-client-ts/). Setting the following 3 options however won't have any effect, as they get discovered automatically via the `/.well-known/webfinger` endpoint:

- `client_id`
- `scope`
- `authority`

See the [oidc-client-ts documentation](https://authts.github.io/oidc-client-ts/interfaces/OidcClientSettings.html) for information on the available configuration options for the library.

### `customTranslations`

Expand Down