Back to Authelia

Pangolin

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

4.39.193.5 KB
Original Source

Tested Versions

{{% oidc-common bugs="claims-hydration" %}}

Assumptions

This example makes the following assumptions:

  • Authelia Root URL: https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}/
  • Client ID: pangolin
  • 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 Pangolin 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: 'pangolin'
        client_name: 'Pangolin'
        client_secret: '$pbkdf2-sha512$310000$c8p78n7pUMln0jzvd4aK4Q$JNRBzwAo0ek5qKn50cFzzvE9RXV88h1wJn5KGiHrD0YKtZaR/nCb2CJPOsKaPK0hjf.9yHxzQGZziziccp6Yng'  # The digest of 'insecure_secret'.
        public: false
        authorization_policy: 'two_factor'
        require_pkce: true
        pkce_challenge_method: 'S256'
        redirect_uris:
          - '<provided by pangolin>'
        scopes:
          - 'openid'
          - 'profile'
          - 'email'
          - 'groups'
        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'

Configuration Escape Hatch

{{% oidc-escape-hatch-claims-hydration client_id="pangolin" %}}

Application

To configure Pangolin there is one method, using the Web GUI.

Web GUI

{{< callout context="caution" title="Important Note" icon="outline/alert-triangle" >}} Unless you have a Pangolin license, you will need to manually create the user in Access Control > Users before attempting login. {{< /callout >}}

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

  1. Visit your [Pangolin Web GUI]
  2. Visit Server Admin
  3. Visit Identity Providers
  4. Select Add Identity Provider
  5. Select OpenID Connect
  6. Configure the following options:
    • Name: Authelia
    • Provider Type: OAuth2/OIDC
    • Client ID: pangolin
    • Client Secret: insecure_secret
    • Auth URL: https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}/api/oidc/authorization
    • Token URL: https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}/api/oidc/token
    • Identifier Path: sub
    • Email Path: email
    • Name Path: name
    • Scopes: openid profile email
  7. Click Create Identity Provider.
  8. On page refresh, note the Redirection URL, and enter it into your Authelia config under redirect_uris.

See Also