Drop-OSS/archived-drop-docs
1
0
Fork 0
mirror of https://github.com/Drop-OSS/drop-docs.git synced 2026-01-30 20:55:17 +01:00
Code Issues Packages Projects Releases Wiki Activity

Adds documentation for the new environment variable OIDC_PROVIDER_NAME (#32)

Browse Source 
Documentation for Drop-OSS/drop#327
This commit is contained in:
Paco
2026-01-22 01:32:53 +00:00
committed by GitHub
parent a932dc3aec
commit b5064a6eb1
1 changed files with 12 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
docs/authentication/oidc.md
View File

@@ -6,21 +6,22 @@ OpenID Connect is a OAuth2 extension support by most identity providers.
To configure OIDC, you must set the following environment variables:
| Variable | Usage |
| -------------------------------- | --------------------------------------------------------------------------------------------------- |
| `OIDC_CLIENT_ID` | Client ID from your identity provider. |
| `OIDC_CLIENT_SECRET` | Client secret from your identity provider. |
| `OIDC_ADMIN_GROUP` | Grant admin to users with this group configured in your identity provider. Tested with Authentik. |
| `DISABLE_SIMPLE_AUTH` (optional) | Disable simple auth |
| `OIDC_USERNAME_CLAIM` (optional) | Change the field that Drop pulls the username claim from. Users are merged based on their usernames |
| Variable | Usage |
| -------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `OIDC_CLIENT_ID` | Client ID from your identity provider. |
| `OIDC_CLIENT_SECRET` | Client secret from your identity provider. |
| `OIDC_ADMIN_GROUP` | Grant admin to users with this group configured in your identity provider. Tested with Authentik. |
| `DISABLE_SIMPLE_AUTH` (optional) | Disable simple auth |
| `OIDC_USERNAME_CLAIM` (optional) | Change the field that Drop pulls the username claim from. Users are merged based on their usernames |
| `OIDC_PROVIDER_NAME` (optional) | Change the name of the oidc provider that is displayed on the sign-in page. Default is `external provider`. |
And then, you must configure **either**:
#### `OIDC_WELLKNOWN`: A unprotected endpoint that returns a OIDC well-known JSON. Fetched on startup.
#### `OIDC_WELLKNOWN`: A unprotected endpoint that returns a OIDC well-known JSON. Fetched on startup
---
#### Individual endpoints:
#### Individual endpoints
| Variable | Usage |
| -------------------- | ------------------------------------------------------------------------- |
@@ -29,6 +30,6 @@ And then, you must configure **either**:
| `OIDC_USERINFO` | Userinfo endpoint. Usually ends with `userinfo`. |
| `OIDC_SCOPES` | Comma separated list of scopes. Requires, at least, `openid` and `email`. |
## Redirect URL
Drop uses the `EXTERNAL_URL` environment variable to create the callback URL: `$EXTERNAL_URL/auth/callback/oidc`.
Drop uses the `EXTERNAL_URL` environment variable to create the callback URL: `$EXTERNAL_URL/auth/callback/oidc`.