Skip to content

Commit 1bc5251

Browse files
committed
fix: update OIDC provider setup documentation for redirect URI and screenshots
- Changed the format of screenshot descriptions to italic for consistency. - Updated redirect URI examples to remove the port number for standard configurations. - Clarified instructions regarding the use of correct ports in non-standard setups.
1 parent 3a10871 commit 1bc5251

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

api/docs/public/oidc-provider-setup.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This guide walks you through configuring OIDC (OpenID Connect) providers for SSO
1717
### OIDC Providers Interface Overview
1818

1919
![Login Page with SSO Options](./images/sso-with-options.png)
20-
_Screenshot: Login page showing traditional login form with SSO options - "Login With Unraid.net" and "Sign in with Google" buttons_
20+
*Login page showing traditional login form with SSO options - "Login With Unraid.net" and "Sign in with Google" buttons*
2121

2222
The interface includes:
2323

@@ -67,7 +67,7 @@ Advanced mode provides granular control using claim-based rules. You can:
6767
## Authorization Rules
6868

6969
![Authorization Rules Configuration](./images/advanced-rules.png)
70-
_Screenshot: Advanced authorization rules showing JWT claim configuration with email endsWith operator for domain-based access control_
70+
*Advanced authorization rules showing JWT claim configuration with email endsWith operator for domain-based access control*
7171

7272
### Simple Mode Examples
7373

@@ -194,7 +194,7 @@ When "advanced" mode is selected, you'll see:
194194
All providers must be configured with this redirect URI:
195195

196196
```
197-
http://YOUR_UNRAID_IP:3001/graphql/api/auth/oidc/callback
197+
http://YOUR_UNRAID_IP/graphql/api/auth/oidc/callback
198198
```
199199

200200
Replace `YOUR_UNRAID_IP` with your actual server IP address.
@@ -217,7 +217,7 @@ The **Issuer URL** field accepts both formats, but **base URL is strongly recomm
217217
## Testing Your Configuration
218218

219219
![Login Page with SSO Buttons](./images/sso-with-options.png)
220-
_Screenshot: Unraid login page displaying both traditional username/password authentication and SSO options with customized provider buttons_
220+
*Unraid login page displaying both traditional username/password authentication and SSO options with customized provider buttons*
221221

222222
1. Save your provider configuration
223223
2. Log out (if logged in)
@@ -246,7 +246,7 @@ _Screenshot: Unraid login page displaying both traditional username/password aut
246246
#### "Invalid redirect URI"
247247

248248
- Ensure the redirect URI in your provider matches exactly
249-
- Include the port number (:3001)
249+
- Include the correct port if using a non-standard configuration
250250
- Use HTTP for local, HTTPS for production
251251

252252
#### Cannot see login button
@@ -294,10 +294,10 @@ The Unraid.net provider is built-in and pre-configured. You only need to configu
294294
**Configuration:**
295295
- **Issuer URL**: Pre-configured (built-in provider)
296296
- **Client ID/Secret**: Pre-configured (built-in provider)
297-
- **Redirect URI**: `http://YOUR_UNRAID_IP:3001/graphql/api/auth/oidc/callback`
297+
- **Redirect URI**: `http://YOUR_UNRAID_IP/graphql/api/auth/oidc/callback`
298298

299299
:::warning[Security Notice]
300-
**Always use HTTPS for production redirect URIs!** The examples above use HTTP for initial setup and testing only. In production environments, you MUST use HTTPS (e.g., `https://YOUR_UNRAID_IP:3001/graphql/api/auth/oidc/callback`) to ensure secure communication and prevent credential interception. Most OIDC providers will reject HTTP redirect URIs for security reasons.
300+
**Always use HTTPS for production redirect URIs!** The examples above use HTTP for initial setup and testing only. In production environments, you MUST use HTTPS (e.g., `https://YOUR_UNRAID_IP/graphql/api/auth/oidc/callback`) to ensure secure communication and prevent credential interception. Most OIDC providers will reject HTTP redirect URIs for security reasons.
301301
:::
302302

303303
Configure authorization rules using Simple Mode (allowed email domains/addresses) or Advanced Mode for complex requirements.
@@ -317,7 +317,7 @@ Set up OAuth 2.0 credentials in [Google Cloud Console](https://console.cloud.goo
317317
- **Issuer URL**: `https://accounts.google.com`
318318
- **Client ID/Secret**: From your OAuth 2.0 client credentials
319319
- **Required Scopes**: `openid`, `profile`, `email`
320-
- **Redirect URI**: `http://YOUR_UNRAID_IP:3001/graphql/api/auth/oidc/callback`
320+
- **Redirect URI**: `http://YOUR_UNRAID_IP/graphql/api/auth/oidc/callback`
321321

322322
:::warning[Google Domain Requirements]
323323
**Google requires valid domain names for OAuth redirect URIs.** Local IP addresses and `.local` domains are not accepted. To use Google OAuth with your Unraid server, you'll need:
@@ -341,7 +341,7 @@ Configure OIDC client in your Authelia `configuration.yml` with client ID `unrai
341341
- **Client ID**: `unraid-api` (or as configured in Authelia)
342342
- **Client Secret**: Your unhashed secret
343343
- **Required Scopes**: `openid`, `profile`, `email`, `groups`
344-
- **Redirect URI**: `http://YOUR_UNRAID_IP:3001/graphql/api/auth/oidc/callback`
344+
- **Redirect URI**: `http://YOUR_UNRAID_IP/graphql/api/auth/oidc/callback`
345345

346346
Use Advanced Mode with `groups` claim for group-based authorization.
347347

@@ -355,7 +355,7 @@ Register a new app in [Azure Portal](https://portal.azure.com/) under Azure Acti
355355
- **Client ID**: Your Application (client) ID
356356
- **Client Secret**: Generated client secret
357357
- **Required Scopes**: `openid`, `profile`, `email`
358-
- **Redirect URI**: `http://YOUR_UNRAID_IP:3001/graphql/api/auth/oidc/callback`
358+
- **Redirect URI**: `http://YOUR_UNRAID_IP/graphql/api/auth/oidc/callback`
359359

360360
Authorization rules can be configured in the interface using email domains or advanced claims.
361361

@@ -369,7 +369,7 @@ Create a new confidential client in Keycloak Admin Console with `openid-connect`
369369
- **Client ID**: `unraid-api` (or as configured in Keycloak)
370370
- **Client Secret**: From Keycloak Credentials tab
371371
- **Required Scopes**: `openid`, `profile`, `email`
372-
- **Redirect URI**: `http://YOUR_UNRAID_IP:3001/graphql/api/auth/oidc/callback`
372+
- **Redirect URI**: `http://YOUR_UNRAID_IP/graphql/api/auth/oidc/callback`
373373

374374
For role-based authorization, use Advanced Mode with `realm_access.roles` or `resource_access` claims.
375375

@@ -383,7 +383,7 @@ Create a new OAuth2/OpenID Provider in Authentik, then create an Application and
383383
- **Client ID**: From Authentik provider configuration
384384
- **Client Secret**: From Authentik provider configuration
385385
- **Required Scopes**: `openid`, `profile`, `email`
386-
- **Redirect URI**: `http://YOUR_UNRAID_IP:3001/graphql/api/auth/oidc/callback`
386+
- **Redirect URI**: `http://YOUR_UNRAID_IP/graphql/api/auth/oidc/callback`
387387

388388
Authorization rules can be configured in the interface.
389389

@@ -397,6 +397,6 @@ Create a new OIDC Web Application in Okta Admin Console and assign appropriate u
397397
- **Client ID**: From Okta application configuration
398398
- **Client Secret**: From Okta application configuration
399399
- **Required Scopes**: `openid`, `profile`, `email`
400-
- **Redirect URI**: `http://YOUR_UNRAID_IP:3001/graphql/api/auth/oidc/callback`
400+
- **Redirect URI**: `http://YOUR_UNRAID_IP/graphql/api/auth/oidc/callback`
401401

402402
Authorization rules can be configured in the interface using email domains or advanced claims.

0 commit comments

Comments
 (0)