IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

docs: modify user preferences refactor (#45553)

Browse Source 
* docs: modify user preferences refactor

* yarn prettier

* add missing procedures

* fix link

* Update docs/sources/manage-user-preferences/_index.md

Co-authored-by: Ursula Kallio <ursula.kallio@grafana.com>

* minor edits and moved docs to admin chapter

* Eve comment out note relref

* yarn prettier

Co-authored-by: Mitchel Seaman <mitchel.seaman@gmail.com>
Co-authored-by: Ursula Kallio <ursula.kallio@grafana.com>
Co-authored-by: Eve832 <eve.meelan@grafana.com>
This commit is contained in:
Christopher Moyer 2022-03-02 13:47:39 -06:00 committed by GitHub
parent e8a54d58c5
commit b677318277
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 101 additions and 86 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

100
docs/sources/administration/manage-user-preferences/_index.md Normal file
View File

@ -0,0 +1,100 @@
+++
title = "Manage user preferences"
weight = 400
description = "Learn how to update your user preferences and switch organizations"
keywords = ["password", "change", "organization", "change"]
aliases = ["/docs/grafana/latest/administration/change-your-password/", "docs/sources/administration/manage-user-preferences/_index.md"]
+++
# Manage user preferences
Grafana allows you to manage certain aspects of your user account, including your user name, email, and password.
You can also view important information about your account, such as the organizations and roles to which you are assigned and the Grafana sessions associated with your account.
## Change your Grafana password
You can change your Grafana password at any time.
> **Note**: If your Grafana instance uses an <!--[external authentication provider]({{< relref "../../auth/_index.md">}})--> external authentication provider, then you might not be able to change your password in Grafana. Contact your Grafana administrator for more information.
**To change your password**:
1. Sign in to Grafana.
1. Hover your mouse over the user icon in the lower-left corner of the page.
1. Click **Change Password**.
Grafana opens the **Change Password** tab.
1. Enter your old password and a new password.
1. Confirm your new password.
1. Click **Change Password**.
## Edit your profile
Your profile includes your name, user name, and email address, which you can update.
**To edit your profile**:
1. Sign in to Grafana.
1. Hover your cursor over the user icon in the lower-left corner of the page and click **Preferences**.
1. In the **Edit Profile** section, update your profile and click **Save**.
## Edit your preferences
You can choose the way you would like data to appear in Grafana, including the UI theme, home dashboard, timezone, and first day of the week. You can set these preferences for your own account, for a team, for an organization, or Grafana-wide using configuration settings. Your user preferences take precedence over team, organization, and Grafana default preferences. For more information, see [Grafana preferences]({{< relref "../../administration/preferences/_index.md">}}).
- **UI theme** determines whether Grafana appears in light mode or dark mode. By default, UI theme is set to dark mode.
- **Home dashboard** refers to the dashboard you see when you sign in to Grafana. By default, this is set to the Home dashboard.
- **Timezone** is used by dashboards when you set time ranges, so that you view data in your timezone instead of UTC.
- **Week start** is the first day of the week you want to use in dashboard time ranges, for example, `This week`.
**To edit your preferences**:
1. Sign in to Grafana.
1. Hover your cursor over the user icon in the lower-left corner of the page, and click **Preferences**.
1. Update any of the values in the **Preferences** section.
1. Click **Save** at the bottom of the Preferences section.
## Switch organizations
When you sign in to Grafana, the system signs you in to a default organization. If you are assigned to multiple organizations, then you might need to switch organizations. For example, if you need to view a dashboard not associated with your current organization, then you should switch organizations to view associated dashboards.
**To switch organizations**:
1. Sign in to Grafana.
1. Hover your cursor over the user icon in the lower-left corner of the page and click **Switch organization**.
1. Next to the organization that you want to sign in to, click **Switch to**.
## View your assigned organizations
Every user is a member of at least one organization. You can have different roles in each organization of which you are a member.
**To view your assigned organizations**:
1. Sign in to Grafana.
1. Hover your cursor over the user icon in the lower-left corner of the page and click **Preferences**.
1. Scroll down to the **Organizations** section and review the following information:
- **Name**: The name of the organizations of which you are a member.
- **Role**: The role to which you are assigned in the organization. For more information about roles and permissions, refer to [Organization users and permissions]({{< relref "../../administration/manage-users-and-permissions/about-users-and-permissions.md#organization-users-and-permissions" >}}).
- **Current**: Grafana indicates the organization that you are currently signed into as _Current_. If you are a member of multiple organizations, you can click **Select** to switch to that organization.
## 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.
**To view your Grafana sessions**:
1. Sign in to Grafana.
1. Hover your cursor over the user icon in the lower-left corner of the page, and click **Preferences**.
1. Scroll down to the **Sessions** section.
## Sign out a user session
You can sign out other sessions using your account in order to prevent other people from accessing Grafana using your credentials.
**To sign out one of your Grafana sessions**:
1. Sign in to Grafana.
1. Hover your cursor over the user icon in the lower-left corner of the page, and click **Preferences**.
1. Scroll down to the **Sessions** section.
1. Click the red "sign out" icon next to the session you would like to sign out.

2
docs/sources/administration/preferences/change-grafana-name.md
View File

@ -53,4 +53,4 @@ To change the team name or email, follow these steps:
## Change user name or email
To learn how to edit your user information, refer to [Grafana user account profile]({{< relref "../../manage-users/user-admin/user-profile.md" >}}).
To learn how to edit your user information, refer to [Edit your profile]({{< relref "../../manage-user-preferences/_index.md#edit-your-profile" >}}).

10
docs/sources/manage-users/user-admin/_index.md
View File

@ -1,10 +0,0 @@
+++
title = "User account tasks"
weight = 400
+++
# User account tasks
Grafana allows you to manage certain aspects of your user account, including the user name, email, and password.
You can also view important aspects of your account, such as the organizations and roles assigned and the Grafana sessions associated with the account.

21
docs/sources/manage-users/user-admin/change-your-password.md
View File

@ -1,21 +0,0 @@
+++
title = "Change your password"
description = "How to change your Grafana password"
keywords = ["grafana", "password", "change", "preferences"]
aliases = ["/docs/grafana/latest/administration/change-your-password/"]
weight = 200
+++
# Change your Grafana password
You can change your Grafana 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**.

12
docs/sources/manage-users/user-admin/switch-org.md
View File

@ -1,12 +0,0 @@
+++
title = "Switch organization"
description = "Change which organization you are logged in with"
weight = 300
+++
# Change the organization you are signed in to
When you sign in to Grafana, you are always signed in with a particular organization. If you are assigned to multiple organizations, then you might need to switch which organization you are signed in to. For example, if you need to view a dashboard associated with a different org, then you might switch organizations.
1. Hover your cursor over your user icon in the lower left corner of the screen, then click **Switch**.
1. Next to the organization that you want to sign in to, click **Switch to**.

42
docs/sources/manage-users/user-admin/user-profile.md
View File

@ -1,42 +0,0 @@
+++
title = "User account profile"
description = "View and edit your Grafana user profile"
weight = 100
+++
# Grafana user account profile
You can edit and view important information about your Grafana user account, including your assigned organizations, your sessions, and the information associated with your account.
## Edit your 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**.
## 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 users and permissions]({{< relref "../../administration/manage-users-and-permissions/about-users-and-permissions.md#organization-users-and-permissions" >}}) for more information about permissions assigned to each role.
- **Current -** Grafana tags the organization that you are currently signed in to as _Current_. If you are part of multiple organizations, then you can click **Select** to switch to that organization.
## 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.