2022-06-15 07:51:47 +00:00
---
title: "Grafana"
2022-07-01 03:07:02 +00:00
description: "Integrating Grafana with the Authelia OpenID Connect Provider."
2022-06-15 07:51:47 +00:00
lead: ""
2022-06-28 05:27:14 +00:00
date: 2022-06-15T17:51:47+10:00
2022-06-15 07:51:47 +00:00
draft: false
images: []
menu:
integration:
parent: "openid-connect"
weight: 620
toc: true
community: true
---
## Tested Versions
* [Authelia]
* [v4.35.5 ](https://github.com/authelia/authelia/releases/tag/v4.35.5 )
* [Grafana]
* 8.0.0
## Before You Begin
2023-02-02 01:30:06 +00:00
{{% oidc-common %}}
2022-10-20 04:42:22 +00:00
2022-10-20 04:27:09 +00:00
### Assumptions
2022-06-15 07:51:47 +00:00
This example makes the following assumptions:
* __Application Root URL:__ `https://grafana.example.com`
* __Authelia Root URL:__ `https://auth.example.com`
* __Client ID:__ `grafana`
2023-02-02 01:30:06 +00:00
* __Client Secret:__ `insecure_secret`
2022-06-15 07:51:47 +00:00
## Configuration
### Application
2023-01-25 23:59:18 +00:00
To configure [Grafana] to utilize Authelia as an [OpenID Connect 1.0] Provider you have two effective options:
2022-06-15 07:51:47 +00:00
2022-08-26 03:26:58 +00:00
#### Configuration File
2022-06-15 07:51:47 +00:00
2022-08-26 03:26:58 +00:00
Add the following Generic OAuth configuration to the [Grafana] configuration:
```ini
2022-07-31 03:23:41 +00:00
[server]
root_url = https://grafana.example.com
2022-06-15 07:51:47 +00:00
[auth.generic_oauth]
enabled = true
name = Authelia
icon = signin
client_id = grafana
2023-02-02 01:30:06 +00:00
client_secret = insecure_secret
2022-06-15 07:51:47 +00:00
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
```
2022-08-26 03:26:58 +00:00
#### Environment Variables
Configure the following environment variables:
| Variable | Value |
|:-------------------------------------------:|:-----------------------------------------------:|
| GF_SERVER_ROOT_URL | https://grafana.example.com |
| GF_AUTH_GENERIC_OAUTH_ENABLED | true |
| GF_AUTH_GENERIC_OAUTH_NAME | Authelia |
| GF_AUTH_GENERIC_OAUTH_CLIENT_ID | grafana |
2023-02-02 01:30:06 +00:00
| GF_AUTH_GENERIC_OAUTH_CLIENT_SECRET | insecure_secret |
2022-08-26 03:26:58 +00:00
| GF_AUTH_GENERIC_OAUTH_SCOPES | openid profile email groups |
| GF_AUTH_GENERIC_OAUTH_EMPTY_SCOPES | false |
| GF_AUTH_GENERIC_OAUTH_AUTH_URL | https://auth.example.com/api/oidc/authorization |
| GF_AUTH_GENERIC_OAUTH_TOKEN_URL | https://auth.example.com/api/oidc/token |
| GF_AUTH_GENERIC_OAUTH_API_URL | https://auth.example.com/api/oidc/userinfo |
| GF_AUTH_GENERIC_OAUTH_LOGIN_ATTRIBUTE_PATH | preferred_username |
| GF_AUTH_GENERIC_OAUTH_GROUPS_ATTRIBUTE_PATH | groups |
| GF_AUTH_GENERIC_OAUTH_NAME_ATTRIBUTE_PATH | name |
| GF_AUTH_GENERIC_OAUTH_USE_PKCE | true |
2022-08-26 01:42:12 +00:00
2022-06-15 07:51:47 +00:00
### Authelia
The following YAML configuration is an example __Authelia__
2023-04-19 04:27:10 +00:00
[client configuration ](../../../configuration/identity-providers/openid-connect/clients.md ) for use with [Grafana]
2022-06-15 07:51:47 +00:00
which will operate with the above example:
```yaml
2023-04-02 03:12:01 +00:00
identity_providers:
oidc:
## The other portions of the mandatory OpenID Connect 1.0 configuration go here.
## See: https://www.authelia.com/c/oidc
clients:
2023-05-07 06:39:17 +00:00
- id: 'grafana'
description: 'Grafana'
2023-04-02 03:12:01 +00:00
secret: '$pbkdf2-sha512$310000$c8p78n7pUMln0jzvd4aK4Q$JNRBzwAo0ek5qKn50cFzzvE9RXV88h1wJn5KGiHrD0YKtZaR/nCb2CJPOsKaPK0hjf.9yHxzQGZziziccp6Yng' # The digest of 'insecure_secret'.
public: false
2023-05-07 06:39:17 +00:00
authorization_policy: 'two_factor'
2023-04-02 03:12:01 +00:00
redirect_uris:
2023-05-07 06:39:17 +00:00
- 'https://grafana.example.com/login/generic_oauth'
2023-04-02 03:12:01 +00:00
scopes:
2023-05-07 06:39:17 +00:00
- 'openid'
- 'profile'
- 'groups'
- 'email'
2023-05-11 06:45:20 +00:00
userinfo_signing_alg: 'none'
2022-06-15 07:51:47 +00:00
```
## See Also
* [Grafana OAuth Documentation ](https://grafana.com/docs/grafana/latest/auth/generic-oauth/ )
[Authelia]: https://www.authelia.com
[Grafana]: https://grafana.com/
2023-01-25 23:59:18 +00:00
[OpenID Connect 1.0]: ../../openid-connect/introduction.md