Modern Docker Management, Designed for Everyone
Go composecontainer-managementcontainersdockerdocker-composedocker-managementgoself-hostedsveltekittypescriptweb-ui
docs: add oidc documentation for ui config
Kyle Mendell5e3c6ba8005c
diff --git a/docs/docs/getting-started/oidc-configuration.md b/docs/docs/getting-started/oidc-configuration.mdindex 1eff97d52..6b15288d0 100644--- a/docs/docs/getting-started/oidc-configuration.md+++ b/docs/docs/getting-started/oidc-configuration.md@@ -32,13 +32,16 @@ You will also need to configure a **Redirect URI** (also known as a Callback URL## Configuring Arcane for OIDC-You'll primarily configure OIDC for Arcane using environment variables when running it in Docker.+Arcane offers two primary ways to configure OIDC:-### Environment Variables+1. **Environment Variables (Recommended for Docker/Production):** This is the most common method when running Arcane in a containerized environment. Settings provided via environment variables take precedence.+2. **Application UI (Settings Page):** If environment variables for OIDC are not set, you can configure OIDC directly through the Arcane web interface. These settings are stored securely in Arcane's data directory.-These are the "sticky notes" you give to Arcane when it starts up to tell it about your OIDC provider.+### Method 1: Environment Variables-- **`PUBLIC_OIDC_ENABLED`**: Set this to `true` to enable OIDC login.+These are the "sticky notes" you give to Arcane when it starts up to tell it about your OIDC provider. If these are set, they will generally override any OIDC settings configured via the UI.++- **`PUBLIC_OIDC_ENABLED`**: Set this to `true` to enable OIDC login. If set to `true` and other OIDC environment variables are missing, Arcane will prompt for configuration via the UI on first setup or if settings are incomplete.- Example: `PUBLIC_OIDC_ENABLED=true`- **`OIDC_CLIENT_ID`**: The Client ID from your OIDC provider.- Example: `OIDC_CLIENT_ID="your_arcane_client_id_from_provider"`@@ -84,16 +87,43 @@ services:# ... other settings ...```-## Enabling in Arcane UI+### Method 2: Application UI++If you prefer not to use environment variables for all OIDC settings, or if `PUBLIC_OIDC_ENABLED` is set to `true` but other OIDC environment variables are missing, you can configure (or complete the configuration for) OIDC through Arcane's settings page.++1. Ensure Arcane is running.+2. Open the Arcane web UI and navigate to **Settings** -> **Authentication**.+3. Locate the "OIDC Authentication" section.+4. If OIDC is not forced on by `PUBLIC_OIDC_ENABLED`, you can enable it using the switch.+5. If OIDC is enabled (either by the switch or forced by environment variables) but not fully configured (either via environment variables or previous UI settings), you will be prompted or can click a button (e.g., "Configure OIDC" or "Manage Them") to open a dialog.+6. In the dialog, you can enter:+ - Client ID+ - Client Secret (this will be stored encrypted)+ - Redirect URI+ - Authorization Endpoint URL+ - Token Endpoint URL+ - Userinfo Endpoint URL+ - Scopes+7. Save the configuration. These settings will be stored securely by Arcane.++**Note on Precedence:**++- If `PUBLIC_OIDC_ENABLED=true` is set as an environment variable, OIDC will be active.+- Specific OIDC parameters (like Client ID, Client Secret, etc.) set via environment variables will always take precedence over those set in the UI.+- If a specific OIDC environment variable (e.g., `OIDC_CLIENT_ID`) is _not_ set, Arcane will then look for the corresponding value configured via the UI (if OIDC is enabled).++## Enabling and Verifying-Once the environment variables are set and Arcane is restarted:+Once OIDC is configured (either via environment variables, the UI, or a combination):1. Go to the Arcane web UI.2. Navigate to **Settings** -> **Authentication**.-3. You should see options related to OIDC. Ensure "Enable OIDC" (or a similar option) is checked if it's not automatically enabled by `PUBLIC_OIDC_ENABLED=true`.- _(Note: The exact UI option might vary or be controlled entirely by the environment variable)._+3. The "OIDC Authentication" section will show the status.+ - If configured via environment variables, it will indicate this, and you can view the (non-secret) values.+ - If configured via the UI, you can manage the settings there.+4. Ensure the OIDC toggle switch is enabled (if not forced on by `PUBLIC_OIDC_ENABLED`).-After configuration, you should see an option to "Login with OIDC" (or similar) on the Arcane login page.+After successful configuration and enablement, you should see an option to "Login with OIDC" (or similar) on the Arcane login page.## Troubleshooting