mirror of
https://github.com/grafana/grafana.git
synced 2024-11-25 02:10:45 -06:00
docs: Updated auth docs
This commit is contained in:
parent
a25b594506
commit
d6f9ebab63
@ -4,7 +4,7 @@ description = "Grafana OAuthentication Guide "
|
||||
keywords = ["grafana", "configuration", "documentation", "oauth"]
|
||||
type = "docs"
|
||||
[menu.docs]
|
||||
name = "GitHub OAuth2"
|
||||
name = "GitHub"
|
||||
identifier = "github_oauth2"
|
||||
parent = "authentication"
|
||||
weight = 4
|
||||
|
@ -4,7 +4,7 @@ description = "Grafana OAuthentication Guide "
|
||||
keywords = ["grafana", "configuration", "documentation", "oauth"]
|
||||
type = "docs"
|
||||
[menu.docs]
|
||||
name = "GitLab OAuth2"
|
||||
name = "GitLab"
|
||||
identifier = "gitlab_oauth"
|
||||
parent = "authentication"
|
||||
weight = 5
|
||||
@ -45,7 +45,7 @@ section.
|
||||
Add the following to your Grafana configuration file to enable GitLab
|
||||
authentication:
|
||||
|
||||
```ini
|
||||
```bash
|
||||
[auth.gitlab]
|
||||
enabled = false
|
||||
allow_sign_up = false
|
||||
|
@ -4,7 +4,7 @@ description = "Grafana OAuthentication Guide "
|
||||
keywords = ["grafana", "configuration", "documentation", "oauth"]
|
||||
type = "docs"
|
||||
[menu.docs]
|
||||
name = "Google OAuth2"
|
||||
name = "Google"
|
||||
identifier = "ggogle_oauth2"
|
||||
parent = "authentication"
|
||||
weight = 3
|
||||
|
@ -16,29 +16,25 @@ The LDAP integration in Grafana allows your Grafana users to login with their LD
|
||||
group memberships and Grafana Organization user roles. Below we detail grafana.ini config file
|
||||
settings and ldap.toml config file options.
|
||||
|
||||
## [auth.ldap]
|
||||
## Enable LDAP
|
||||
|
||||
### enabled
|
||||
Set to `true` to enable LDAP integration (default: `false`)
|
||||
|
||||
### config_file
|
||||
Path to the LDAP specific configuration file (default: `/etc/grafana/ldap.toml`)
|
||||
|
||||
### allow_sign_up
|
||||
|
||||
Allow sign up should almost always be true (default) to allow new Grafana users to be created (if ldap authentication is ok). If set to
|
||||
false only pre-existing Grafana users will be able to login (if ldap authentication is ok).
|
||||
|
||||
<hr>
|
||||
|
||||
Grafana (2.1 and newer) ships with a strong LDAP integration feature.
|
||||
## Configuration
|
||||
You turn on LDAP in the [main config file]({{< relref "configuration.md#auth-ldap" >}}) as well as specify the path to the LDAP
|
||||
You turn on LDAP in the [main config file]({{< relref "installation/configuration.md" >}}) as well as specify the path to the LDAP
|
||||
specific configuration file (default: `/etc/grafana/ldap.toml`).
|
||||
|
||||
### Example config
|
||||
```bash
|
||||
[auth.ldap]
|
||||
# Set to `true` to enable LDAP integration (default: `false`)
|
||||
enabled = true
|
||||
# Path to the LDAP specific configuration file (default: `/etc/grafana/ldap.toml`)
|
||||
config_file = /etc/grafana/ldap.toml`
|
||||
# Allow sign up should almost always be true (default) to allow new Grafana users to be created (if ldap authentication is ok). If set to
|
||||
# false only pre-existing Grafana users will be able to login (if ldap authentication is ok).
|
||||
allow_sign_up = true
|
||||
```
|
||||
|
||||
```toml
|
||||
## LDAP Configuration
|
||||
|
||||
```bash
|
||||
# To troubleshoot and get more log info enable ldap debug logging in grafana.ini
|
||||
# [log]
|
||||
# filters = ldap:debug
|
||||
@ -135,7 +131,7 @@ The search filter and search bases settings are still needed to perform the LDAP
|
||||
## POSIX schema (no memberOf attribute)
|
||||
If your ldap server does not support the memberOf attribute add these options:
|
||||
|
||||
```toml
|
||||
```bash
|
||||
## Group search filter, to retrieve the groups of which the user is a member (only set if memberOf attribute is not available)
|
||||
group_search_filter = "(&(objectClass=posixGroup)(memberUid=%s))"
|
||||
## An array of the base DNs to search through for groups. Typically uses ou=groups
|
||||
|
@ -14,7 +14,7 @@ weight = 1
|
||||
Grafana provides many ways to authenticate users. Some authentication integrations also enable syncing user
|
||||
permissions and org memberships.
|
||||
|
||||
## OAuth2 Integrations
|
||||
## OAuth Integrations
|
||||
|
||||
- [Google OAuth]({{< relref "auth/google.md" >}})
|
||||
- [GitHub OAuth]({{< relref "auth/github.md" >}})
|
||||
|
@ -324,7 +324,7 @@ Defaults to `false`.
|
||||
Grafana provides many ways to authenticate users. The docs for authentication has been split in to many differnet pages
|
||||
below.
|
||||
|
||||
- [Anonymous access]({{< relref "auth/overview.md" >}}) (auth.anonymous)
|
||||
- [Authentication Overview]({{< relref "auth/overview.md" >}}) (anonymous access options, hide login and more)
|
||||
- [Google OAuth]({{< relref "auth/google.md" >}}) (auth.google)
|
||||
- [GitHub OAuth]({{< relref "auth/github.md" >}}) (auth.github)
|
||||
- [Gitlab OAuth]({{< relref "auth/gitlab.md" >}}) (auth.gitlab)
|
||||
|
Loading…
Reference in New Issue
Block a user