Docs: removing docs debt in install docs (#101750)

* Docs: removing docs debt in install docs

* cleaning up set up docs debt

* fixing some vale errors

* fixing broken admonition shortcode

* fixing broken shortcode

* fixing broken shortcode

* working to the grafana authentication config

* updating some more files

* editing down to ldap in the repo

* editing ldap doc except final section with link needed

* Finishing doc debt cleanup through configure authetication

* fixing shortcodes reverted by merge conflict fix

* fixing admonition

* fixing more broken shortcodes

* adjusting some wordings ot make vale happy

* updating feature toggle info
This commit is contained in:
Jacob Valdez
2025-04-09 09:02:51 -05:00
committed by GitHub
parent af6c536c22
commit 8dfb0874a0
24 changed files with 243 additions and 236 deletions

View File

@ -18,22 +18,22 @@ This page explains how to configure LDAP authentication in Grafana using the Gra
Benefits of using the Grafana user interface to configure LDAP authentication include:
- There is no need to edit the configuration file manually.
- No need to edit the configuration file manually.
- Quickly test the connection to the LDAP server.
- There is no need to restart Grafana after making changes.
- No need to restart Grafana after making changes.
{{% admonition type="note" %}}
{{< admonition type="note" >}}
Any configuration changes made through the Grafana user interface (UI) will take precedence over settings specified in the Grafana configuration file or through environment variables. If you modify any configuration settings in the UI, they will override any corresponding settings set via environment variables or defined in the configuration file.
{{% /admonition %}}
{{< /admonition >}}
## Before you begin
Prerequisites:
To follow these instructions, you need:
- Knowledge of LDAP authentication and how it works.
- Grafana instance v11.3.0 or later.
- A Grafana instance v11.3.0 or later.
- Permissions `settings:read` and `settings:write` with `settings:auth.ldap:*` scope.
- This feature requires the `ssoSettingsLDAP` feature toggle to be enabled.
- The `ssoSettingsLDAP` feature toggle enabled.
## Steps to configure LDAP authentication
@ -86,7 +86,7 @@ Map LDAP groups to Grafana roles.
1. **Group name attribute**: Identifies users within group entries.
1. **Manage group mappings**:
When managing group mappings, the following fields will become available. To add a new group mapping, click the **Add group mapping** button.
When managing group mappings, the following fields are available. To add a new group mapping, click the **Add group mapping** button.
1. **Add a group DN mapping**: The name of the key used to extract the ID token.
1. **Add an organization role mapping**: Select the Basic Role mapped to this group.