Portainer

Tested Versions #

• Authelia
  • v4.35.5
• Portainer CE and EE
  • 2.12.2

Before You Begin #

Common Notes #

1. The OpenID Connect 1.0 client_id parameter:
   1. This must be a unique value for every client.
   2. The value used in this guide is merely for demonstration purposes and you can theoretically use nearly any alphanumeric string.
2. The OpenID Connect 1.0 secret parameter:
   1. The value used in this guide is merely for demonstration purposes and you should absolutely not use this in production and should instead utilize the How Do I Generate Client Secrets FAQ.
   2. This string may be stored as plaintext in the Authelia configuration but this behaviour is deprecated and is not guaranteed to be supported in the future. See the Plaintext guide for more information.
3. The Configuration example for Authelia is only a portion of the required configuration and it should be used as a guide in conjunction with the standard OpenID Connect 1.0 Configuration guide.

Assumptions #

This example makes the following assumptions:

• Application Root URL: https://portainer.example.com
• Authelia Root URL: https://auth.example.com
• Client ID: portainer
• Client Secret: insecure_secret

Configuration #

Application #

To configure Portainer to utilize Authelia as an OpenID Connect 1.0 Provider:

1. Visit Settings
2. Visit Authentication
3. Set the following values:
   1. Authentication Method: OAuth
   2. Provider: Custom
   3. Enable Automatic User Provision if you want users to automatically be created in Portainer.
   4. Client ID: portainer
   5. Client Secret: insecure_secret
   6. Authorization URL: https://auth.example.com/api/oidc/authorization
   7. Access Token URL: https://auth.example.com/api/oidc/token
   8. Resource URL: https://auth.example.com/api/oidc/userinfo
   9. Redirect URL: https://portainer.example.com
   10. User Identifier: preferred_username
   11. Scopes: openid profile groups email

Authelia #

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

identity_providers:
  oidc:
    ## The other portions of the mandatory OpenID Connect 1.0 configuration go here.
    ## See: https://www.authelia.com/c/oidc
    clients:
    - id: portainer
      description: Portainer
      secret: '$pbkdf2-sha512$310000$c8p78n7pUMln0jzvd4aK4Q$JNRBzwAo0ek5qKn50cFzzvE9RXV88h1wJn5KGiHrD0YKtZaR/nCb2CJPOsKaPK0hjf.9yHxzQGZziziccp6Yng'  # The digest of 'insecure_secret'.
      public: false
      authorization_policy: two_factor
      redirect_uris:
        - https://portainer.example.com
      scopes:
        - openid
        - profile
        - groups
        - email
      userinfo_signing_algorithm: none

See Also #

• Portainer OAuth Documentation