From 4e2ab785d6dcd87b06921a453af18626c44f1c26 Mon Sep 17 00:00:00 2001 From: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> Date: Mon, 3 Aug 2020 13:22:58 -0700 Subject: [PATCH] Docs: Add preferences and password docs (#26628) * Create change-your-password.md * linked to menu * Create preferences.md * Update menu.yaml * Update preferences.md * Update docs/sources/administration/preferences.md Co-authored-by: Emil Tullstedt * Update docs/sources/administration/change-your-password.md Co-authored-by: Emil Tullstedt * Update docs/sources/administration/change-your-password.md Co-authored-by: Emil Tullstedt * Update preferences.md * Update _index.md Co-authored-by: Emil Tullstedt --- docs/sources/administration/_index.md | 2 +- .../administration/change-your-password.md | 29 ++++++++++ docs/sources/administration/preferences.md | 58 +++++++++++++++++++ docs/sources/menu.yaml | 4 ++ 4 files changed, 92 insertions(+), 1 deletion(-) create mode 100644 docs/sources/administration/change-your-password.md create mode 100644 docs/sources/administration/preferences.md diff --git a/docs/sources/administration/_index.md b/docs/sources/administration/_index.md index 2d0a326dadf..dfed44eb18e 100644 --- a/docs/sources/administration/_index.md +++ b/docs/sources/administration/_index.md @@ -10,4 +10,4 @@ weight = 2 # Administration -This section provides resources for Grafana administrators. +This section provides resources for Grafana administrators and users performing administrative tasks. diff --git a/docs/sources/administration/change-your-password.md b/docs/sources/administration/change-your-password.md new file mode 100644 index 00000000000..65357ad7e87 --- /dev/null +++ b/docs/sources/administration/change-your-password.md @@ -0,0 +1,29 @@ ++++ +title = "Change your password" +description = "How to change your Grafana password" +keywords = ["grafana", "password", "change", "preferences"] +type = "docs" +[menu.docs] +weight = 100 ++++ + +# Change your Grafana password + +You can change your password in the Change Password tab. + +> **Note:** If your Grafana instance uses an external authentication provider, then you might not be able to change your password. Contact your Grafana administrator for more information. + +## Change your password + +1. Hover your mouse over your user icon in the lower left corner of the screen. +1. Click **Change Password**. Grafana opens the Change Password tab. +1. Enter your **Old password** to authorize the change. +1. Enter your **New password** and then **Confirm password**. +1. Click **Change Password**. + +## Admin user management resources + +Grafana admins can use the following tools: + +- Use the [User API]({{< relref "../http_api/user.md" >}}) to change your password programmatically or to manage users. +- The [Manage users]({{< relref "../manage-users/_index.md" >}}) section explains how to manage users and teams. diff --git a/docs/sources/administration/preferences.md b/docs/sources/administration/preferences.md new file mode 100644 index 00000000000..0bb5176d620 --- /dev/null +++ b/docs/sources/administration/preferences.md @@ -0,0 +1,58 @@ ++++ +title = "Change your preferences" +description = "How to change your Grafana preferences" +keywords = ["grafana", "profile", "change", "preferences"] +type = "docs" +[menu.docs] +weight = 100 ++++ + +# Change your Grafana preferences + +You can perform several tasks in the Preferences tab. You can edit your profile, change your Grafana preferences, and view information about your profile and Grafana usage. + +## Edit your Grafana profile + +Your profile includes your name, user name, and email address. + +1. Navigate to the Preferences tab. Hover your cursor over your user icon in the lower left corner of the screen, and then click **Preferences.** +1. In the Edit Profile section, you can edit any of the following: + - **Name -** Edit this field to change the display name associated with your profile. + - **Email -** Edit this field to change the email address associated with your profile. + - **Username -** Edit this field to change your user name. +1. Click **Save**. + +## Edit your Grafana preferences + +Your Grafana preferences include whether uses the dark or light theme, your home dashboard, and your timezone. + +> **Note:** Settings on your personal instance override settings made by your administrator at the instance or team level. + +1. Navigate to the Preferences tab. Hover your cursor over your user icon in the lower left corner of the screen, and then click **Preferences.** +1. In the Preferences section, you can edit any of the following: + - **UI Theme -** Click to set the **Dark** or **Light** to select a theme. **Default** is either the dark theme or the theme selected by your Grafana administrator. + - **Home Dashboard -** Refer to [Set your personal home dashboard]({{< relref "change-home-dashboard.md#set-your-personal-home-dashboard" >}}) for more information. + - **Timezone -** Click to select an option in the **Timezone** list. Refer to [Time range controls]({{< relref "../dashboards/time-range-controls.md" >}}) for more information about Grafana time settings. +1. Click **Save**. + +## View your assigned organizations + +Every user is a member of at least one organization. You can have different roles in every organization that you are a member of. + +1. Navigate to the Preferences tab. Hover your cursor over your user icon in the lower left corner of the screen, and then click **Preferences.** +1. Scroll down to the Organizations section. + - **Name -** The name of the organizations you are a member of in that Grafana instance. + - **Role -** The role you are assigned in the organization. Refer to [Organization roles]({{< relref "../permissions/organization_roles.md" >}}) about permissions assigned to each role. + - **Current -** Grafana tags the organization that you are currently signed in to as _Current_. + +## View your Grafana sessions + +Grafana logs your sessions in each Grafana instance. You can review this section if you suspect someone has misused your Grafana credentials. + +1. Navigate to the Preferences tab. Hover your cursor over your user icon in the lower left corner of the screen, and then click **Preferences.** +1. Scroll down to the Sessions section. Grafana displays the following: + - **Last seen -** How long ago you logged on. + - **Logged on -** The date you logged on to the current Grafana instance. + - **IP address -** The IP address that you logged on from. + - **Browser & OS -** The web browser and operating system used to log on to Grafana. + - If you are a Grafana Admin for the instance, then you can revoke a session by clicking the red signout icon in the session row. diff --git a/docs/sources/menu.yaml b/docs/sources/menu.yaml index b23ad710c7d..3f121c32de2 100644 --- a/docs/sources/menu.yaml +++ b/docs/sources/menu.yaml @@ -35,6 +35,10 @@ - name: Administration link: /administration/ children: + - name: Change password + link: /administration/change-your-password/ + - name: Change preferences + link: /administration/preferences/ - name: Configuration link: /administration/configuration/ - name: Configure Docker image