tyler.durden/dashy
1
0
Fork 0
mirror of https://github.com/Lissy93/dashy.git synced 2025-09-23 17:58:35 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
Liss-Bot 2025-08-03 13:05:45 +00:00
parent 91f2a23fd1
commit 22bb23f7a8
2 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/authentication.md
View File

@ -286,6 +286,7 @@ appConfig:
clientId: [registered client id] clientId: [registered client id]
endpoint: [OIDC endpoint] endpoint: [OIDC endpoint]
scope: [The scope(s) to request from the OIDC provider] scope: [The scope(s) to request from the OIDC provider]
adminGroup: admin
``` ```
Because Dashy is a SPA, a [public client](https://datatracker.ietf.org/doc/html/rfc6749#section-2.1) registration with PKCE is needed. Because Dashy is a SPA, a [public client](https://datatracker.ietf.org/doc/html/rfc6749#section-2.1) registration with PKCE is needed.

2
docs/configuring.md
View File

@ -204,6 +204,8 @@ For more info, see the **[Authentication Docs](/docs/authentication)**
--- | --- | --- | --- --- | --- | --- | ---
**`clientId`** | `string` | Required | The client id registered in the OIDC server **`clientId`** | `string` | Required | The client id registered in the OIDC server
**`endpoint`** | `string` | Required | The URL of the OIDC server that should be used. **`endpoint`** | `string` | Required | The URL of the OIDC server that should be used.
**`adminRole`** | `string` | _Optional_ | The role that will be considered as admin.
**`adminGroup`** | `string` | _Optional_ | The group that will be considered as admin.
**`scope`** | `string` | Required | The scope(s) to request from the OIDC provider **`scope`** | `string` | Required | The scope(s) to request from the OIDC provider
**[⬆️ Back to Top](#top)** **[⬆️ Back to Top](#top)**