Ryan/drop
1
0
Fork 0
mirror of https://github.com/Drop-OSS/drop.git synced 2026-08-23 14:52:04 +10:00
Code Issues Packages Projects Releases Wiki Activity

Docs/fix typo in OIDC docs (#473)

Browse Source 
* Fix typo instances of "odic" in docs #443

* Update contributing guide link

* Update starlight-links-validator to fix build errors

---------

Co-authored-by: Trevor Wallis <trevor@twallis.com>
This commit is contained in:
Trevor Wallis
2026-08-15 13:54:02 +10:00
committed by GitHub
co-authored by Trevor Wallis
parent 12c81eb1ac
commit e654cdf52e
5 changed files with 414 additions and 312 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+1 -1
View File
@@ -32,6 +32,6 @@ See our documentation on how to [deploy Drop](https://droposs.org/docs/admin/qui
## Contributing ## Contributing
Please see the [in-depth contributing guide](CONTRIBUTING.md). The guide includes information on how to set up the project, how to contribute code, how to report issues, and even how to effectively translate Drop. Please see the [in-depth contributing guide](https://developer.droposs.org/contributing). The guide includes information on how to set up the project, how to contribute code, how to report issues, and even how to effectively translate Drop.
[![Drop Translation Progress](https://translate.droposs.org/widget/drop/horizontal-auto.svg)](https://translate.droposs.org/engage/drop/) [![Drop Translation Progress](https://translate.droposs.org/widget/drop/horizontal-auto.svg)](https://translate.droposs.org/engage/drop/)
pnpm-lock.yaml
Generated
+406 -304
View File
File diff suppressed because it is too large Load Diff
sites/docs/package.json
+2 -2
View File
@@ -10,11 +10,11 @@
"astro": "astro" "astro": "astro"
}, },
"dependencies": { "dependencies": {
"@astrojs/starlight": "^0.40.0", "@astrojs/starlight": "^0.41.7",
"astro": "^7.1.1", "astro": "^7.1.1",
"sharp": "^0.35.3", "sharp": "^0.35.3",
"starlight-image-zoom": "^0.14.2", "starlight-image-zoom": "^0.14.2",
"starlight-links-validator": "^0.24.1", "starlight-links-validator": "^0.25.3",
"starlight-theme-rapide": "^0.5.2" "starlight-theme-rapide": "^0.5.2"
} }
} }
sites/docs/src/content/docs/admin/authentication/oidc.md
+3 -3
View File
@@ -48,10 +48,10 @@ Drop recommends using the OIDC well-known option **instead** of manually specify
## Redirect URL ## Redirect URL
Drop uses the `EXTERNAL_URL` environment variable to create the callback URL: `$EXTERNAL_URL/api/v1/auth/odic/callback`. Drop uses the `EXTERNAL_URL` environment variable to create the callback URL: `$EXTERNAL_URL/api/v1/auth/oidc/callback`.
For example: if `EXTERNAL_URL` was set to `http://localhost:3000/`, then the redirect URL would be `http://localhost:3000/api/v1/auth/odic/callback`. For example: if `EXTERNAL_URL` was set to `http://localhost:3000/`, then the redirect URL would be `http://localhost:3000/api/v1/auth/oidc/callback`.
## Logout URL ## Logout URL
Drop supports OIDC back-channel logout, enabling the OIDC provider to logout users. Using the example above, the back-channel logout URL would be `http://localhost:3000/api/v1/auth/odic/logout`. Drop supports OIDC back-channel logout, enabling the OIDC provider to logout users. Using the example above, the back-channel logout URL would be `http://localhost:3000/api/v1/auth/oidc/logout`.
sites/docs/src/content/docs/admin/going-further/setting-up-oidc.mdx
+2 -2
View File
@@ -18,8 +18,8 @@ For this guide, `drop.tld` is used as a placeholder for your Drop instance's dom
1. Select OpenID Connect as the provider type 1. Select OpenID Connect as the provider type
1. Configure the provider 1. Configure the provider
- Copy the client ID, and secret, you'll need them for Drop - Copy the client ID, and secret, you'll need them for Drop
- Set the redirect as `Strict` and the URL to `https://drop.tld/api/v1/auth/odic/callback` - Set the redirect as `Strict` and the URL to `https://drop.tld/api/v1/auth/oidc/callback`
- Set the logout URL to `https://drop.tld/api/v1/auth/odic/logout` - Set the logout URL to `https://drop.tld/api/v1/auth/oidc/logout`
- Make sure to set the logout URL as a `back-channel` logout in the dropdown - Make sure to set the logout URL as a `back-channel` logout in the dropdown
1. Configure everything else as you see fit 1. Configure everything else as you see fit