ContextQMD
Back to Authelia

Arcane

docs/content/integration/openid-connect/clients/arcane/index.md

4.39.194.1 KB
Original Source

Tested Versions

{{% oidc-common %}}

Assumptions

This example makes the following assumptions:

  • Application Root URL: https://arcane.{{< sitevar name="domain" nojs="example.com" >}}/
    • This option determines the redirect URI in the format of https://arcane.{{< sitevar name="domain" nojs="example.com" >}}/login. This means if you change this value, you need to update the redirect URI.
  • Authelia Root URL: https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}/
  • Client ID: arcane
  • Client Secret: insecure_secret

Some of the values presented in this guide can automatically be replaced with documentation variables.

{{< sitevar-preferences >}}

Configuration

Authelia

The following YAML configuration is an example Authelia client configuration for use with Arcane which will operate with the application example:

yaml
identity_providers:
  oidc:
    ## The other portions of the mandatory OpenID Connect 1.0 configuration go here.
    ## See: https://www.authelia.com/c/oidc
    clients:
      - client_id: 'arcane'
        client_name: 'Arcane'
        client_secret: '$pbkdf2-sha512$310000$c8p78n7pUMln0jzvd4aK4Q$JNRBzwAo0ek5qKn50cFzzvE9RXV88h1wJn5KGiHrD0YKtZaR/nCb2CJPOsKaPK0hjf.9yHxzQGZziziccp6Yng'  # The digest of 'insecure_secret'.
        public: false
        authorization_policy: 'two_factor'
        require_pkce: false
        pkce_challenge_method: ''
        redirect_uris:
          - 'https://arcane.{{< sitevar name="domain" nojs="example.com" >}}/auth/oidc/callback'
        scopes:
          - 'openid'
          - 'email'
          - 'profile'
        response_types:
          - 'code'
        grant_types:
          - 'authorization_code'
        access_token_signed_response_alg: 'none'
        userinfo_signed_response_alg: 'none'
        token_endpoint_auth_method: 'client_secret_basic'

Application

To configure Arcane there are two methods, using Environment Variables, or using the Web GUI.

Environment Variables

To configure Arcane to utilize Authelia as an OpenID Connect 1.0 Provider, use the following environment variables:

Standard
shell
APP_URL=https://arcane.{{< sitevar name="domain" nojs="example.com" >}}
OIDC_ENABLED=true
OIDC_ISSUER_URL=https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}
OIDC_CLIENT_ID=arcane
OIDC_CLIENT_SECRET=insecure_secret
OIDC_SCOPES=openid email profile
Docker Compose
yaml
services:
  arcane:
    environment:
      APP_URL: 'https://arcane.{{< sitevar name="domain" nojs="example.com" >}}'
      OIDC_ENABLED: 'true'
      OIDC_ISSUER_URL: 'https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}'
      OIDC_CLIENT_ID: 'arcane'
      OIDC_CLIENT_SECRET: 'insecure_secret'
      OIDC_SCOPES: 'openid email profile'

Web GUI

{{< callout context="tip" title="Help Wanted" icon="outline/rocket" >}} We would love screenshots of this configuration! {{< /callout >}}

To configure Arcane to utilize Authelia as an OpenID Connect 1.0 Provider, use the following instructions:

  1. Navigate to Settings.
  2. Navigate to Authentication.
  3. Configure the following options:
    • Issuer URL: https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}
    • Client ID: arcane
    • Client Secret: insecure_secret
    • Redirect URI: 'https://arcane.{{< sitevar name="domain" nojs="example.com" >}}/auth/oidc/callback'
  4. Click Save.

See Also