From eb1c85d4e4eb4a5a93d791327a6b6dfe5fbd4332 Mon Sep 17 00:00:00 2001 From: Glenn de Haan Date: Thu, 3 Oct 2024 11:09:03 +0200 Subject: [PATCH] Added 'AUTH_OIDC_ENABLED' to integration documentation --- .docs/oidc/authentik/README.md | 11 ++++++----- .docs/oidc/keycloak/README.md | 11 ++++++----- .docs/oidc/uid/README.md | 11 ++++++----- .docs/oidc/zitadel/README.md | 11 ++++++----- 4 files changed, 24 insertions(+), 20 deletions(-) diff --git a/.docs/oidc/authentik/README.md b/.docs/oidc/authentik/README.md index 6f085d5..36e2ef3 100644 --- a/.docs/oidc/authentik/README.md +++ b/.docs/oidc/authentik/README.md @@ -44,12 +44,13 @@ Now, configure your UniFi Voucher Site to use the Authentik client. -1. Set the `AUTH_OIDC_CLIENT_ID` as configured in Authentik (found in the Authentik provider configuration). -2. Provide the `AUTH_OIDC_CLIENT_SECRET` (found in the Authentik provider configuration). -3. Provide the `AUTH_OIDC_ISSUER_BASE_URL` from your Authentik provider. +1. In your UniFi Voucher Site configuration, set `AUTH_OIDC_ENABLED` to `true`. +2. Set the `AUTH_OIDC_CLIENT_ID` as configured in Authentik (found in the Authentik provider configuration). +3. Provide the `AUTH_OIDC_CLIENT_SECRET` (found in the Authentik provider configuration). +4. Provide the `AUTH_OIDC_ISSUER_BASE_URL` from your Authentik provider. - You can find this under **Providers > unifi-voucher-provider > OpenID Configuration URL** in Authentik. -4. Provide the `AUTH_OIDC_APP_BASE_URL` from your UniFi Voucher Site instance (e.g., `https://voucher.example.com`). -5. Restart the container after these changes +5. Provide the `AUTH_OIDC_APP_BASE_URL` from your UniFi Voucher Site instance (e.g., `https://voucher.example.com`). +6. Restart the container after these changes --- diff --git a/.docs/oidc/keycloak/README.md b/.docs/oidc/keycloak/README.md index 6303bb6..0069066 100644 --- a/.docs/oidc/keycloak/README.md +++ b/.docs/oidc/keycloak/README.md @@ -50,11 +50,12 @@ You’ll see various tabs for configuring the client. Set the following fields: Now, configure your UniFi Voucher Site to use the Keycloak client. -1. Set the `AUTH_OIDC_CLIENT_ID` as configured in Keycloak (e.g., `unifi-voucher-site`). -2. Provide the `AUTH_OIDC_CLIENT_SECRET` (found in the Credentials tab in Keycloak). -3. Provide the `AUTH_OIDC_ISSUER_BASE_URL` from your Keycloak server (e.g., `https://auth.example.com/realms/{realm}/.well-known/openid-configuration`). -4. Provide the `AUTH_OIDC_APP_BASE_URL` from your UniFi Voucher Site instance (e.g., `https://voucher.example.com`). -5. Restart the container after these changes +1. In your UniFi Voucher Site configuration, set `AUTH_OIDC_ENABLED` to `true`. +2. Set the `AUTH_OIDC_CLIENT_ID` as configured in Keycloak (e.g., `unifi-voucher-site`). +3. Provide the `AUTH_OIDC_CLIENT_SECRET` (found in the Credentials tab in Keycloak). +4. Provide the `AUTH_OIDC_ISSUER_BASE_URL` from your Keycloak server (e.g., `https://auth.example.com/realms/{realm}/.well-known/openid-configuration`). +5. Provide the `AUTH_OIDC_APP_BASE_URL` from your UniFi Voucher Site instance (e.g., `https://voucher.example.com`). +6. Restart the container after these changes --- diff --git a/.docs/oidc/uid/README.md b/.docs/oidc/uid/README.md index a6f1fd2..2bba036 100644 --- a/.docs/oidc/uid/README.md +++ b/.docs/oidc/uid/README.md @@ -38,11 +38,12 @@ Now, configure your UniFi Voucher Site to use the UID client. -1. Set the `AUTH_OIDC_CLIENT_ID` as found within the UID Application. -2. Provide the `AUTH_OIDC_CLIENT_SECRET` as found within the UID Application. -3. Provide the `AUTH_OIDC_ISSUER_BASE_URL` from your UID domain (e.g., `https://your-site.ui.com/gw/idp/api/v1/public/oauth/your-secret-token/.well-known/openid-configuration`). -4. Provide the `AUTH_OIDC_APP_BASE_URL` from your UniFi Voucher Site instance (e.g., `https://voucher.example.com`). -5. Restart the container after these changes +1. In your UniFi Voucher Site configuration, set `AUTH_OIDC_ENABLED` to `true`. +2. Set the `AUTH_OIDC_CLIENT_ID` as found within the UID Application. +3. Provide the `AUTH_OIDC_CLIENT_SECRET` as found within the UID Application. +4. Provide the `AUTH_OIDC_ISSUER_BASE_URL` from your UID domain (e.g., `https://your-site.ui.com/gw/idp/api/v1/public/oauth/your-secret-token/.well-known/openid-configuration`). +5. Provide the `AUTH_OIDC_APP_BASE_URL` from your UniFi Voucher Site instance (e.g., `https://voucher.example.com`). +6. Restart the container after these changes --- diff --git a/.docs/oidc/zitadel/README.md b/.docs/oidc/zitadel/README.md index 536e392..c03b3e6 100644 --- a/.docs/oidc/zitadel/README.md +++ b/.docs/oidc/zitadel/README.md @@ -46,11 +46,12 @@ Now, create an application under the project you just created. Now, configure your UniFi Voucher Site to use the ZITADEL client. -1. Set the `AUTH_OIDC_CLIENT_ID` as the ClientId found within the ZITADEL Popup. -2. Provide the `AUTH_OIDC_CLIENT_SECRET` as the ClientSecret found within the ZITADEL Popup. -3. Provide the `AUTH_OIDC_ISSUER_BASE_URL` from your Keycloak server (e.g., `https://auth.example.com/.well-known/openid-configuration`). -4. Provide the `AUTH_OIDC_APP_BASE_URL` from your UniFi Voucher Site instance (e.g., `https://voucher.example.com`). -5. Restart the container after these changes +1. In your UniFi Voucher Site configuration, set `AUTH_OIDC_ENABLED` to `true`. +2. Set the `AUTH_OIDC_CLIENT_ID` as the ClientId found within the ZITADEL Popup. +3. Provide the `AUTH_OIDC_CLIENT_SECRET` as the ClientSecret found within the ZITADEL Popup. +4. Provide the `AUTH_OIDC_ISSUER_BASE_URL` from your Keycloak server (e.g., `https://auth.example.com/.well-known/openid-configuration`). +5. Provide the `AUTH_OIDC_APP_BASE_URL` from your UniFi Voucher Site instance (e.g., `https://voucher.example.com`). +6. Restart the container after these changes ---