From fd63640daa45ebf050f4fe1fb891fc12fd94c0ba Mon Sep 17 00:00:00 2001 From: Liss-Bot Date: Sat, 17 Aug 2024 14:34:23 +0000 Subject: [PATCH] Update documentation --- docs/authentication.md | 1 + docs/configuring.md | 1 + 2 files changed, 2 insertions(+) diff --git a/docs/authentication.md b/docs/authentication.md index 8a21f3af..37a94b56 100644 --- a/docs/authentication.md +++ b/docs/authentication.md @@ -285,6 +285,7 @@ appConfig: oidc: clientId: [registered client id] endpoint: [OIDC endpoint] + scope: [The scope(s) to request from the OIDC provider] ``` Because Dashy is a SPA, a [public client](https://datatracker.ietf.org/doc/html/rfc6749#section-2.1) registration with PKCE is needed. diff --git a/docs/configuring.md b/docs/configuring.md index bc8721e9..cfcb080a 100644 --- a/docs/configuring.md +++ b/docs/configuring.md @@ -202,6 +202,7 @@ For more info, see the **[Authentication Docs](/docs/authentication)** --- | --- | --- | --- **`clientId`** | `string` | Required | The client id registered in the OIDC server **`endpoint`** | `string` | Required | The URL of the OIDC server that should be used. +**`scope`** | `string` | Required | The scope(s) to request from the OIDC provider **[⬆️ Back to Top](#top)**