-
Notifications
You must be signed in to change notification settings - Fork 34
Add VoidAuth OIDC documentation #85
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.
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
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| --- | ||
| title: OIDC with VoidAuth | ||
| description: Wire up SSO to VoidAuth | ||
| --- | ||
|
|
||
| # OIDC with VoidAuth | ||
|
|
||
| [VoidAuth](https://voidauth.app/) is an open-source SSO authentication and user management provider that stands guard in front of your self-hosted application. Before starting, read the [OIDC Setup overview](index.md), as it covers the RomM-side settings common to every provider. | ||
|
|
||
| ## 1. Prerequisites | ||
|
|
||
| VoidAuth installed and running via their [self-hosted deployment docs](https://voidauth.app/#/?id=quick-start). We'll use the `APP_URL` from the example `compose.yml` in those docs as `https://auth.example.com`. | ||
| Your RomM instance will be referenced as `https://demo.romm.app`. | ||
|
|
||
| ## 2. Create a new app | ||
|
|
||
| Log in as an admin in the VoidAuth web interface. Create a new OIDC app (e.g. `RomM`). | ||
|
|
||
| - **Name**: `RomM` | ||
| - **Home Page URL**: `https://demo.romm.app` | ||
| - **Logo URL**: `https://docs.romm.app/resources/romm/isotipo.png` | ||
| - **Group**: You could add a group that the user must belong to get access to your RomM instance. If left empty, any user created in your VoidAuth instance will be allowed. | ||
| - **Skip Consent** and **MFA Required**: These options can be enabled or left disabled as you prefer. | ||
| - **Client ID**: Generate an ID using the button. | ||
| - **Auth Method**: `Client Secret Basic` | ||
| - **Client Secret**: Generate a secret using the button. | ||
| - **Redirect URLs**: add `https://demo.romm.app/api/oauth/openid` | ||
| - **Response Types**: check `code` | ||
| - **Grant Types**: check `authorization_code` and `refresh_token` | ||
| - **Post Logout URL**: `https://demo.romm.app/` | ||
|
|
||
| Don't forget to click the `Create` button to validate your app. | ||
|
|
||
| ## 3. Configure | ||
|
|
||
| ```yaml | ||
| environment: | ||
| - OIDC_ENABLED=true | ||
| - OIDC_PROVIDER=voidauth | ||
| - OIDC_CLIENT_ID=<from VoidAuth> | ||
| - OIDC_CLIENT_SECRET=<from VoidAuth> | ||
| - OIDC_REDIRECT_URI=https://demo.romm.app/api/oauth/openid | ||
| - OIDC_SERVER_APPLICATION_URL=https://auth.example.com | ||
| - OIDC_SERVER_METADATA_URL=https://auth.example.com/oidc/.well-known/openid-configuration | ||
| - ROMM_BASE_URL=https://demo.romm.app | ||
| ``` | ||
|
|
||
| VoidAuth's OIDC discovery URL can be found at the top of your OIDC App page, by clicking on OIDC Endpoints. | ||
|
|
||
| For role mapping from VoidAuth, see [OIDC Setup → Role mapping](index.md#role-mapping). | ||
|
|
||
| ## 4. Test | ||
|
|
||
| Restart, navigate to `/login` and click the **Login with VoidAuth** button. You're redirected to VoidAuth → authenticate → bounced back and signed in! | ||
|
gantoine marked this conversation as resolved.
|
||
|
|
||
| If it doesn't work, head to [Authentication Troubleshooting](../../troubleshooting/authentication.md). | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.