Add VoidAuth OIDC documentation#85
Open
HydrelioxGitHub wants to merge 2 commits into
Open
Conversation
gantoine
approved these changes
May 12, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new OIDC provider guide for VoidAuth, intended to mirror the existing per-provider OIDC setup documentation.
Changes:
- Added a new
OIDC with VoidAuthsetup guide with VoidAuth-side registration steps and RomM env var configuration. - Documented VoidAuth-specific discovery/metadata endpoint usage.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+12
to
+32
| VoidAuth installed and running via their [self-hosted deployment docs](https://voidauth.app/#/?id=quick-start). We will use the APP_URL provided in the compose.yml exemple for reference in this documentation : https://auth.example.com | ||
| Your RomM instance will be referenced as https://demo.romm.app . | ||
|
|
||
| ## 2. Create a new app | ||
|
|
||
| Login as an admin in VoidAuth web interface. Create a new OIDC Apps (e.g. `RomM`). | ||
|
|
||
| - **Name**: `RomM` | ||
| - **Home Page URL**: `https://romm.example.com` | ||
| - **Logo URL**: `https://github.com/HydrelioxGitHub/romm-docs/blob/main/.github/resources/isotipo.png?raw=true` | ||
| - **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** : This options could be checked or not as you wish. | ||
| - **Client ID**: Generate an ID using the button | ||
| - **Auth Method**: `Client Secred 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 on the `Create` button to valid your app. |
|
|
||
| ## 2. Create a new app | ||
|
|
||
| Login as an admin in VoidAuth web interface. Create a new OIDC Apps (e.g. `RomM`). |
|
|
||
| - **Name**: `RomM` | ||
| - **Home Page URL**: `https://romm.example.com` | ||
| - **Logo URL**: `https://github.com/HydrelioxGitHub/romm-docs/blob/main/.github/resources/isotipo.png?raw=true` |
Comment on lines
+12
to
+32
| VoidAuth installed and running via their [self-hosted deployment docs](https://voidauth.app/#/?id=quick-start). We will use the APP_URL provided in the compose.yml exemple for reference in this documentation : https://auth.example.com | ||
| Your RomM instance will be referenced as https://demo.romm.app . | ||
|
|
||
| ## 2. Create a new app | ||
|
|
||
| Login as an admin in VoidAuth web interface. Create a new OIDC Apps (e.g. `RomM`). | ||
|
|
||
| - **Name**: `RomM` | ||
| - **Home Page URL**: `https://romm.example.com` | ||
| - **Logo URL**: `https://github.com/HydrelioxGitHub/romm-docs/blob/main/.github/resources/isotipo.png?raw=true` | ||
| - **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** : This options could be checked or not as you wish. | ||
| - **Client ID**: Generate an ID using the button | ||
| - **Auth Method**: `Client Secred 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 on the `Create` button to valid your app. |
| - **Grant Types**: check `authorization_code` and `refresh_token` | ||
| - **Post Logout URL**: `https://demo.romm.app/` | ||
|
|
||
| Don't forget to click on the `Create` button to valid your app. |
| ```yaml | ||
| environment: | ||
| - OIDC_ENABLED=true | ||
| - OIDC_PROVIDER=VoidAuth |
|
|
||
| ## 4. Test | ||
|
|
||
| Restart, navigate to `/login` and click the **Login with VoidAuth** button. You're redirected to VoidAuth → authenticate → bounced back and signed in! |
|
|
||
| # 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. |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Documentation based on the Zitadel file.