Grafana

Tested Versions

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://grafana.example.com
  • Authelia Root URL: https://auth.example.com
  • Client ID: grafana
  • Client Secret: insecure_secret

Configuration

Application

To configure Grafana to utilize Authelia as an OpenID Connect 1.0 Provider you have two effective options:

Configuration File

Add the following Generic OAuth configuration to the Grafana configuration:

[server]
root_url = https://grafana.example.com
[auth.generic_oauth]
enabled = true
name = Authelia
icon = signin
client_id = grafana
client_secret = insecure_secret
scopes = openid profile email groups
empty_scopes = false
auth_url = https://auth.example.com/api/oidc/authorization
token_url = https://auth.example.com/api/oidc/token
api_url = https://auth.example.com/api/oidc/userinfo
login_attribute_path = preferred_username
groups_attribute_path = groups
name_attribute_path = name
use_pkce = true

Environment Variables

Configure the following environment variables:

VariableValue
GF_SERVER_ROOT_URLhttps://grafana.example.com
GF_AUTH_GENERIC_OAUTH_ENABLEDtrue
GF_AUTH_GENERIC_OAUTH_NAMEAuthelia
GF_AUTH_GENERIC_OAUTH_CLIENT_IDgrafana
GF_AUTH_GENERIC_OAUTH_CLIENT_SECRETinsecure_secret
GF_AUTH_GENERIC_OAUTH_SCOPESopenid profile email groups
GF_AUTH_GENERIC_OAUTH_EMPTY_SCOPESfalse
GF_AUTH_GENERIC_OAUTH_AUTH_URLhttps://auth.example.com/api/oidc/authorization
GF_AUTH_GENERIC_OAUTH_TOKEN_URLhttps://auth.example.com/api/oidc/token
GF_AUTH_GENERIC_OAUTH_API_URLhttps://auth.example.com/api/oidc/userinfo
GF_AUTH_GENERIC_OAUTH_LOGIN_ATTRIBUTE_PATHpreferred_username
GF_AUTH_GENERIC_OAUTH_GROUPS_ATTRIBUTE_PATHgroups
GF_AUTH_GENERIC_OAUTH_NAME_ATTRIBUTE_PATHname
GF_AUTH_GENERIC_OAUTH_USE_PKCEtrue

Authelia

The following YAML configuration is an example Authelia client configuration for use with Grafana 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: grafana
      description: Grafana
      secret: '$pbkdf2-sha512$310000$c8p78n7pUMln0jzvd4aK4Q$JNRBzwAo0ek5qKn50cFzzvE9RXV88h1wJn5KGiHrD0YKtZaR/nCb2CJPOsKaPK0hjf.9yHxzQGZziziccp6Yng'  # The digest of 'insecure_secret'.
      public: false
      authorization_policy: two_factor
      redirect_uris:
        - https://grafana.example.com/login/generic_oauth
      scopes:
        - openid
        - profile
        - groups
        - email
      userinfo_signing_algorithm: none

See Also