Skip to content

Commit 103a006

Browse files
gantoineCopilot
andauthored
Apply suggestions from code review
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
1 parent f360294 commit 103a006

2 files changed

Lines changed: 11 additions & 11 deletions

File tree

docs/administration/oidc/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Whichever provider you pick, set these in the `romm` service's environment:
3939
```yaml
4040
environment:
4141
- OIDC_ENABLED=true
42-
- OIDC_PROVIDER=<authelia|authentik|keycloak|pocketid|zitadel|voidauth|generic>
42+
- OIDC_PROVIDER=<authelia|authentik|keycloak|pocket-id|zitadel|voidauth|generic>
4343
- OIDC_CLIENT_ID=<from your provider>
4444
- OIDC_CLIENT_SECRET=<from your provider>
4545
- OIDC_SERVER_APPLICATION_URL=https://auth.example.com

docs/administration/oidc/voidauth.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,34 +9,34 @@ description: Wire up SSO to VoidAuth
99

1010
## 1. Prerequisites
1111

12-
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
13-
Your RomM instance will be referenced as https://demo.romm.app .
12+
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`.
13+
Your RomM instance will be referenced as `https://demo.romm.app`.
1414

1515
## 2. Create a new app
1616

17-
Login as an admin in VoidAuth web interface. Create a new OIDC Apps (e.g. `RomM`).
17+
Log in as an admin in the VoidAuth web interface. Create a new OIDC app (e.g. `RomM`).
1818

1919
- **Name**: `RomM`
2020
- **Home Page URL**: `https://demo.romm.app`
21-
- **Logo URL**: `https://github.com/HydrelioxGitHub/romm-docs/blob/main/.github/resources/isotipo.png?raw=true`
21+
- **Logo URL**: `https://docs.romm.app/resources/romm/isotipo.png`
2222
- **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.
23-
- **Skip Consent** and **MFA Required** : This options could be checked or not as you wish.
24-
- **Client ID**: Generate an ID using the button
25-
- **Auth Method**: `Client Secred Basic`
26-
- **Client Secret**: Generate a secret using the button
23+
- **Skip Consent** and **MFA Required**: These options can be enabled or left disabled as you prefer.
24+
- **Client ID**: Generate an ID using the button.
25+
- **Auth Method**: `Client Secret Basic`
26+
- **Client Secret**: Generate a secret using the button.
2727
- **Redirect URLs**: add `https://demo.romm.app/api/oauth/openid`
2828
- **Response Types**: check `code`
2929
- **Grant Types**: check `authorization_code` and `refresh_token`
3030
- **Post Logout URL**: `https://demo.romm.app/`
3131

32-
Don't forget to click on the `Create` button to valid your app.
32+
Don't forget to click the `Create` button to validate your app.
3333

3434
## 3. Configure
3535

3636
```yaml
3737
environment:
3838
- OIDC_ENABLED=true
39-
- OIDC_PROVIDER=VoidAuth
39+
- OIDC_PROVIDER=voidauth
4040
- OIDC_CLIENT_ID=<from VoidAuth>
4141
- OIDC_CLIENT_SECRET=<from VoidAuth>
4242
- OIDC_REDIRECT_URI=https://demo.romm.app/api/oauth/openid

0 commit comments

Comments
 (0)