docs: grammar and readability for "Configure authentication" page (#64709)

docs: grammar and readability for configure-authentication/_index.md
pull/64754/head
Aaron Godin 3 years ago committed by GitHub
parent dca5adeb98
commit 4d789827e9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 24
      docs/sources/setup-grafana/configure-security/configure-authentication/_index.md

@ -36,24 +36,24 @@ The following table shows all supported authentication providers and the feature
## Grafana Auth ## Grafana Auth
Grafana of course has a built in user authentication system with password authentication enabled by default. You can Grafana of course has a built in user authentication system with password authentication enabled by default. You can
disable authentication by enabling anonymous access. You can also hide login form and only allow login through an auth disable authentication by enabling anonymous access. You can also hide the login form and only allow login through an auth
provider (listed above). There are also options for allowing self sign up. provider (listed above). There are also options for allowing self sign up.
### Login and short-lived tokens ### Login and short-lived tokens
> The following applies when using Grafana's built in user authentication, LDAP (without Auth proxy) or OAuth integration. > The following applies when using Grafana's built in user authentication, LDAP (without Auth proxy) or OAuth integration.
Grafana are using short-lived tokens as a mechanism for verifying authenticated users. Grafana uses short-lived tokens as a mechanism for verifying authenticated users.
These short-lived tokens are rotated each `token_rotation_interval_minutes` for an active authenticated user. These short-lived tokens are rotated on an interval specified by `token_rotation_interval_minutes` for active authenticated users.
An active authenticated user that gets it token rotated will extend the `login_maximum_inactive_lifetime_duration` time from "now" that Grafana will remember the user. Inactive authenticated users will remain logged in for a duration specified by `login_maximum_inactive_lifetime_duration`.
This means that a user can close its browser and come back before `now + login_maximum_inactive_lifetime_duration` and still being authenticated. This means that a user can close a Grafana window and return before `now + login_maximum_inactive_lifetime_duration` to continue their session.
This is true as long as the time since user login is less than `login_maximum_lifetime_duration`. This is true as long as the time since last user login is less than `login_maximum_lifetime_duration`.
#### Remote logout #### Remote logout
You can logout from other devices by removing login sessions from the bottom of your profile page. If you are You can logout from other devices by removing login sessions from the bottom of your profile page. If you are
a Grafana admin user you can also do the same for any user from the Server Admin / Edit User view. a Grafana admin user, you can also do the same for any user from the Server Admin / Edit User view.
## Settings ## Settings
@ -65,15 +65,13 @@ Example:
# Login cookie name # Login cookie name
login_cookie_name = grafana_session login_cookie_name = grafana_session
# The maximum lifetime (duration) an authenticated user can be inactive before being required to login at next visit. Default is 7 days (7d). This setting should be expressed as a duration, e.g. 5m (minutes), 6h (hours), 10d (days), 2w (weeks), 1M (month). The lifetime resets at each successful token rotation (token_rotation_interval_minutes). # The maximum lifetime (duration) an authenticated user can be inactive before being required to login at next visit. Default is 7 days (7d). This setting should be expressed as a duration, e.g. 5m (minutes), 6h (hours), 10d (days), 2w (weeks), 1M (month). The lifetime resets at each successful token rotation (token_rotation_interval_minutes).
login_maximum_inactive_lifetime_duration = login_maximum_inactive_lifetime_duration =
# The maximum lifetime (duration) an authenticated user can be logged in since login time before being required to login. Default is 30 days (30d). This setting should be expressed as a duration, e.g. 5m (minutes), 6h (hours), 10d (days), 2w (weeks), 1M (month). # The maximum lifetime (duration) an authenticated user can be logged in since login time before being required to login. Default is 30 days (30d). This setting should be expressed as a duration, e.g. 5m (minutes), 6h (hours), 10d (days), 2w (weeks), 1M (month).
login_maximum_lifetime_duration = login_maximum_lifetime_duration =
# How often should auth tokens be rotated for authenticated users when being active. The default is each 10 minutes. # How often should auth tokens be rotated for authenticated users when being active. The default is every 10 minutes.
token_rotation_interval_minutes = 10 token_rotation_interval_minutes = 10
# The maximum lifetime (seconds) an API key can be used. If it is set all the API keys should have limited lifetime that is lower than this value. # The maximum lifetime (seconds) an API key can be used. If it is set all the API keys should have limited lifetime that is lower than this value.
@ -97,11 +95,11 @@ org_name = Main Org.
org_role = Viewer org_role = Viewer
``` ```
If you change your organization name in the Grafana UI this setting needs to be updated to match the new name. If you change your organization name in the Grafana UI, this setting needs to be updated to match the new name.
### Basic authentication ### Basic authentication
Basic auth is enabled by default and works with the built in Grafana user password authentication system and LDAP Basic auth is enabled by default and works with the built-in Grafana user-password authentication system and LDAP
authentication integration. authentication integration.
To disable basic auth: To disable basic auth:
@ -113,7 +111,7 @@ enabled = false
### Disable login form ### Disable login form
You can hide the Grafana login form using the below configuration settings. Hide the Grafana login form using the below configuration settings.
```bash ```bash
[auth] [auth]

Loading…
Cancel
Save