2018-08-13 07:28:41 -05:00
|
|
|
+++
|
|
|
|
title = "Overview"
|
|
|
|
description = "Overview for auth"
|
|
|
|
type = "docs"
|
|
|
|
[menu.docs]
|
|
|
|
name = "Overview"
|
|
|
|
identifier = "overview-auth"
|
|
|
|
parent = "authentication"
|
|
|
|
weight = 1
|
|
|
|
+++
|
|
|
|
|
2018-09-06 05:11:56 -05:00
|
|
|
# User Authentication Overview
|
2018-08-13 07:28:41 -05:00
|
|
|
|
2018-09-06 05:11:56 -05:00
|
|
|
Grafana provides many ways to authenticate users. Some authentication integrations also enable syncing user
|
|
|
|
permissions and org memberships.
|
2018-08-31 00:15:07 -05:00
|
|
|
|
2018-09-06 06:15:36 -05:00
|
|
|
## OAuth Integrations
|
2018-08-31 00:15:07 -05:00
|
|
|
|
2018-09-06 05:11:56 -05:00
|
|
|
- [Google OAuth]({{< relref "auth/google.md" >}})
|
|
|
|
- [GitHub OAuth]({{< relref "auth/github.md" >}})
|
|
|
|
- [Gitlab OAuth]({{< relref "auth/gitlab.md" >}})
|
2018-09-06 06:21:11 -05:00
|
|
|
- [Generic OAuth]({{< relref "auth/generic-oauth.md" >}}) (Okta2, BitBucket, Azure, OneLogin, Auth0)
|
2018-08-31 00:15:07 -05:00
|
|
|
|
2018-09-06 05:11:56 -05:00
|
|
|
## LDAP integrations
|
2018-08-31 00:15:07 -05:00
|
|
|
|
2018-09-06 05:11:56 -05:00
|
|
|
- [LDAP Authentication]({{< relref "auth/ldap.md" >}}) (OpenLDAP, ActiveDirectory, etc)
|
2018-08-13 07:28:41 -05:00
|
|
|
|
2018-09-06 05:11:56 -05:00
|
|
|
## Auth proxy
|
2018-08-13 07:28:41 -05:00
|
|
|
|
2018-09-06 05:11:56 -05:00
|
|
|
- [Auth Proxy]({{< relref "auth/auth-proxy.md" >}}) If you want to handle authentication outside Grafana using a reverse
|
|
|
|
proxy.
|
2018-08-13 07:28:41 -05:00
|
|
|
|
2018-09-06 05:11:56 -05:00
|
|
|
## Grafana Auth
|
2018-08-13 07:28:41 -05:00
|
|
|
|
2018-09-20 08:16:43 -05:00
|
|
|
Grafana of course has a built in user authentication system with password authentication enabled by default. You can
|
2018-09-06 05:11:56 -05:00
|
|
|
disable authentication by enabling anonymous access. You can also hide login form and only allow login through an auth
|
|
|
|
provider (listed above). There is also options for allowing self sign up.
|
2018-08-13 07:28:41 -05:00
|
|
|
|
2018-09-20 08:16:43 -05:00
|
|
|
### Anonymous authentication
|
2018-09-06 05:11:56 -05:00
|
|
|
|
|
|
|
You can make Grafana accessible without any login required by enabling anonymous access in the configuration file.
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
```bash
|
|
|
|
[auth.anonymous]
|
|
|
|
enabled = true
|
|
|
|
|
|
|
|
# Organization name that should be used for unauthenticated users
|
|
|
|
org_name = Main Org.
|
|
|
|
|
|
|
|
# Role for unauthenticated users, other valid values are `Editor` and `Admin`
|
|
|
|
org_role = Viewer
|
|
|
|
```
|
|
|
|
|
|
|
|
If you change your organization name in the Grafana UI this setting needs to be updated to match the new name.
|
|
|
|
|
|
|
|
### Basic authentication
|
|
|
|
|
|
|
|
Basic auth is enabled by default and works with the built in Grafana user password authentication system and LDAP
|
|
|
|
authenticaten integration.
|
|
|
|
|
|
|
|
To disable basic auth:
|
|
|
|
|
|
|
|
```bash
|
|
|
|
[auth.basic]
|
|
|
|
enabled = false
|
|
|
|
```
|
|
|
|
|
|
|
|
### Disable login form
|
|
|
|
|
|
|
|
You can hide the Grafana login form using the below configuration settings.
|
|
|
|
|
|
|
|
```bash
|
|
|
|
[auth]
|
|
|
|
disable_login_form ⁼ true
|
|
|
|
```
|
|
|
|
|
|
|
|
### Hide sign-out menu
|
|
|
|
|
|
|
|
Set to the option detailed below to true to hide sign-out menu link. Useful if you use an auth proxy.
|
|
|
|
|
|
|
|
```bash
|
|
|
|
[auth]
|
|
|
|
disable_signout_menu = true
|
|
|
|
```
|