Add docs for user management (#24277)

* Add docs for user management

* WIP
This commit is contained in:
Marcus Olsson
2020-05-08 17:33:59 +02:00
committed by GitHub
parent 7e6ac12b9a
commit a9f39a4149
11 changed files with 197 additions and 6 deletions

View File

@ -0,0 +1,32 @@
+++
title = "Manage users"
type = "docs"
[menu.docs]
name = "Manage users"
identifier = "manage-users"
weight = 3
+++
# Manage users
Create users and teams and configure [Permissions]({{< relref "../permissions/overview.md" >}}) to make sure that users only have access to the resources they need.
Only Administrators can manage users and teams.
## Users
Users are named accounts in Grafana that can be granted permissions to access resources throughout Grafana.
- [Add or remove a user]({{< relref "./add-or-remove-user.md" >}})
- [Enable or disable a user]({{< relref "./enable-or-disable-user.md" >}})
## Teams
Teams allow you to grant permissions for a group of users.
- [Create or remove a team]({{< relref "./create-or-remove-team.md" >}})
- [Add or remove a user from a team]({{< relref "./add-or-remove-user-from-team.md" >}})
## Learn more
Set up users and teams in our tutorial on how to [Create users and teams](https://grafana.com/tutorials/create-users-and-teams).

View File

@ -0,0 +1,29 @@
+++
title = "Add or remove a user from a team"
keywords = ["grafana", "configuration", "documentation", "users",
"teams"]
type = "docs"
[menu.docs]
identifier = "add-or-remove-user-from-team"
parent = "manage-users"
weight = 10
+++
# Add or remove a user from a team
This page explains how to add or remove users from teams in Grafana.
## Add a user to a team
1. In the sidebar, hover your mouse over the **Configuration** (gear) icon and then click **Teams**.
1. Click the team you want to add the user to.
1. Click **Add member**.
1. In the **Add team member** box, select the user you want to add to the team.
1. Click **Add to team**.
## Remove a user from a team
1. In the sidebar, hover your mouse over the **Configuration** (gear) icon and then click **Teams**.
1. Click the team you want to remove the user from.
1. Click **X** to the right of the user's name.
1. Click **Delete** to confirm.

View File

@ -0,0 +1,32 @@
+++
title = "Add or remove a user"
keywords = ["grafana", "configuration", "documentation", "users"]
type = "docs"
[menu.docs]
identifier = "add-or-remove-user"
parent = "manage-users"
weight = 10
+++
# Add or remove a user
This page explains how to add or remove user accounts in Grafana.
For more information, refer to [Users]({{< relref "./_index.md#users" >}}).
## Add a user
1. In the sidebar, hover your mouse over the **Server Admin** (shield) icon and then click **Users**.
1. In the Users tab, click **New user**.
1. In **Name**, enter the name of the user.
1. In **E-mail**, enter the email of the user.
1. In **Username**, enter the username that the user will use to log in.
1. In **Password**, enter a password. The user can change their password once they log in.
1. Click **Create** to create the user account.
## Remove a user
1. In the sidebar, hover your mouse over the **Server Admin** (shield) icon and then click **Users**.
1. Click to select the user you want to remove.
1. Click **Delete User**.
1. Click **Delete user** in the dialog to confirm.

View File

@ -0,0 +1,29 @@
+++
title = "Create or remove a team"
keywords = ["grafana", "configuration", "documentation", "users",
"teams"]
type = "docs"
[menu.docs]
identifier = "create-or-remove-team"
parent = "manage-users"
weight = 10
+++
# Create or remove a team
Create or remove teams to manage groups of users.
For more information, refer to [Teams]({{< relref "./_index.md#teams" >}}).
## Create a team
1. In the sidebar, hover your mouse over the **Configuration** (gear) icon and then click **Teams**.
1. Click **New team**.
1. In **Name**, enter the name of the team.
1. Click **Create**.
## Remove a team
1. In the sidebar, hover your mouse over the **Configuration** (gear) icon and then click **Teams**.
1. Click **X** to the right of the team's name.
1. Click **Delete** to confirm.

View File

@ -0,0 +1,26 @@
+++
title = "Enable or disable a user"
keywords = ["grafana", "configuration", "documentation", "users"]
type = "docs"
[menu.docs]
identifier = "enable-or-disable-user"
parent = "manage-users"
weight = 10
+++
# Enable or disable a user
This page explains how to enable or disable user accounts in Grafana.
## Enable a user
1. In the sidebar, hover your mouse over the **Server Admin** (shield) icon and then click **Users**.
1. Click to select the user you want to enable.
1. Click **Enable User**.
## Disable a user
1. In the sidebar, hover your mouse over the **Server Admin** (shield) icon and then click **Users**.
1. Click to select the user you want to disable.
1. Click **Disable User**.
1. Click **Disable user** in the dialog to confirm.

View File

@ -85,6 +85,19 @@
link: /tutorials/ha_setup/
- name: Troubleshooting
link: /installation/troubleshooting/
- name: Manage users
link: /manage-users
children:
- link: /manage-users/
name: Overview
- link: /manage-users/add-or-remove-user/
name: Add or remove a user
- link: /manage-users/enable-or-disable-user/
name: Enable or disable a user
- link: /manage-users/create-or-remove-team/
name: Create or remove a team
- link: /manage-users/add-or-remove-user-from-team/
name: Add or remove user from team
- name: Panels
link: /features/panels/
children:

View File

@ -7,7 +7,7 @@ type = "docs"
name = "Dashboard and Folder"
identifier = "dashboard-folder-permissions"
parent = "permissions"
weight = 3
weight = 40
+++
# Dashboard and Folder Permissions

View File

@ -7,7 +7,7 @@ type = "docs"
name = "Datasource"
identifier = "datasource-permissions"
parent = "permissions"
weight = 4
weight = 50
+++
# Data source permissions

View File

@ -0,0 +1,32 @@
+++
title = "Grant dashboard and folder permissions"
keywords = ["grafana", "configuration", "documentation", "dashboard", "folder", "permissions", "teams"]
type = "docs"
[menu.docs]
identifier = "grant-dashboard-and-folder-permissions"
parent = "permissions"
weight = 10
+++
# Grant dashboard and folder permissions
Grant permission to dashboards and folders to control who can access them.
## Grant folder permissions
1. In the sidebar, hover your mouse over the **Dashboards** (squares) icon and then click **Manage**.
1. Hover your mouse cursor over a folder and click the gear icon to the right.
1. Go to the **Permissions** tab, and then click **Add Permission**.
1. In the **Add Permission For** dialog, select **User** or **Team**.
1. In the second box, select the user or team to add permission for.
1. In the third box, select the permission you want to add.
1. Click **Save**.
## Grant dashboard permissions
1. In the top right corner of your dashboard, click the cog icon to go to **Dashboard settings**.
1. Go to the **Permissions** tab, and click **Add Permission**.
1. In the **Add Permission For** dialog, select **User** or **Team**.
1. In the second box, select the user or team to add permission for.
1. In the third box, select the permission you want to add.
1. Click **Save**.

View File

@ -7,7 +7,7 @@ type = "docs"
name = "Organization Roles"
identifier = "organization-roles"
parent = "permissions"
weight = 2
weight = 30
+++
# Organization Roles

View File

@ -20,9 +20,7 @@ Grafana users have permissions that are determined by their:
- Via permissions assigned directly to user (on folders, dashboards, data sources)
- The Grafana Admin (i.e. Super Admin) user flag.
## User
A *user* is a named account in Grafana. A user can belong to one or more organizations and can be assigned different levels of privileges through roles.
## Users
Grafana supports a wide variety of internal and external ways for users to authenticate themselves. These include from its own integrated database, from an external SQL server, or from an external LDAP server.