diff options
Diffstat (limited to 'doc/user/profile/index.md')
| -rw-r--r-- | doc/user/profile/index.md | 250 |
1 files changed, 97 insertions, 153 deletions
diff --git a/doc/user/profile/index.md b/doc/user/profile/index.md index d2cbf9e4acd..5bcfafa7196 100644 --- a/doc/user/profile/index.md +++ b/doc/user/profile/index.md @@ -7,133 +7,61 @@ info: To determine the technical writer assigned to the Stage/Group associated w # User account -Each GitLab account has a user profile, and settings. Your [profile](#user-profile) -contains information about you, and your GitLab activity. Your [settings](#user-settings) -allow you to customize some aspects of GitLab to suit yourself. +Each GitLab account has a user profile, which contains information about you and your GitLab activity. -## Creating users +Your profile also includes settings, which you use to customize your GitLab experience. -There are several ways to create users on GitLab. See the [creating users documentation](account/create_accounts.md) for more details. - -## Signing in - -There are several ways to sign into your GitLab account. -See the [authentication topic](../../topics/authentication/index.md) for more details. - -### Unknown sign-in - -GitLab notifies you if a sign-in occurs that is from an unknown IP address or device. -See [Unknown Sign-In Notification](unknown_sign_in_notification.md) for more details. - -## User profile +## Access your user profile To access your profile: 1. In the top-right corner, select your avatar. 1. Select your name or username. -On your profile page, you can see the following information: - -- Personal information -- Activity stream: see your activity streamline and the history of your contributions -- Groups: [groups](../group/index.md) you're a member of -- Contributed projects: [projects](../project/index.md) you contributed to -- Personal projects: your personal projects (respecting the project's visibility level) -- Starred projects: projects you starred -- Snippets: your personal code [snippets](../snippets.md#personal-snippets) -- Followers: people following you -- Following: people you are following - -Profile page with active Following view: - - - -## User settings +## Access your user settings To access your user settings: 1. In the top-right corner, select your avatar. 1. Select **Edit profile**. -From there, you can: - -- Update your personal information, including: - - Full name - - Primary email, public email, and commit email - - Social media handles - - Website URL - - Location - - Job title - - Bio -- Change your [password](#changing-your-password) -- Set a [custom status](#current-status) for your profile -- Manage your [commit email](#commit-email) for your profile -- Manage [2FA](account/two_factor_authentication.md) -- Add details of [external accounts](#add-details-of-external-accounts). -- Change your username and [delete your account](account/delete_account.md) -- Manage applications that can - [use GitLab as an OAuth provider](../../integration/oauth_provider.md#introduction-to-oauth) -- Manage [personal access tokens](personal_access_tokens.md) to access your account via API and authorized applications -- Add and delete emails linked to your account -- Choose which email to use for [notifications](notifications.md), web-based commits, and display on your public profile -- Manage [SSH keys](../../ssh/README.md) to access your account via SSH -- Manage your [preferences](preferences.md#syntax-highlighting-theme) - to customize your own GitLab experience -- [View your active sessions](active_sessions.md) and revoke any of them if necessary -- Access your audit events, a security log of important events involving your account +## Change your password -## Changing your password +To change your password: -1. Go to your [user settings](#user-settings). +1. In the top-right corner, select your avatar. +1. Select **Edit profile**. 1. In the left sidebar, select **Password**. -1. Enter your current password in the **Current password** field. -1. Enter your desired new password twice, once in the **New password** field and - once in the **Password confirmation** field. +1. In the **Current password** field, enter your current password. +1. In the **New password** and **Password confirmation** field, enter your new password. 1. Select **Save password**. -If you don't know your current password, select the 'I forgot my password' link. +If you don't know your current password, select the **I forgot my password** link. + +## Change your username - +Your username has a unique [namespace](../group/index.md#namespaces), +which is updated when you change your username. Before you change your username, read about +[how redirects behave](../project/repository/index.md#redirects-when-changing-repository-paths). +If you do not want to update the namespace, you can create a new user or group and transfer projects to it instead. -## Changing your username +Prerequisites: -Your `username` is a unique [`namespace`](../group/index.md#namespaces) -related to your user ID. Changing it can have unintended side effects, read -[how redirects behave](../project/repository/index.md#redirects-when-changing-repository-paths) -before proceeding. +- Your namespace cannot contain a project with [Container Registry](../packages/container_registry/index.md) tags. +- Your namespace cannot have a project that hosts [GitLab Pages](../project/pages/index.md). For more information, + see [this procedure in the GitLab Team Handbook](https://about.gitlab.com/handbook/tools-and-tips/#how-to-change-your-username-at-gitlabcom). -To change your `username`: +To change your username: -1. Navigate to your [user settings](#user-settings). +1. In the top-right corner, select your avatar. +1. Select **Edit profile**. 1. In the left sidebar, select **Account**. -1. Enter a new username under **Change username**. +1. In the **Change username** section, enter a new username as the path. 1. Select **Update username**. -WARNING: -It is not possible to change your username if it contains a -project with [Container Registry](../packages/container_registry/index.md) tags, -because the project cannot be moved. +## Make your user profile page private -NOTE: -If you want to retain ownership over the original namespace and -protect the URL redirects, then instead of changing a group's path or renaming a -username, you can create a new group and transfer projects to it. -Alternatively, you can follow [this detailed procedure from the GitLab Team Handbook](https://about.gitlab.com/handbook/tools-and-tips/#how-to-change-your-username-at-gitlabcom) -which also covers the case where you have projects hosted with -[GitLab Pages](../project/pages/index.md). - -## Private profile - -The following information is hidden from the user profile page (`https://gitlab.example.com/username`) if this feature is enabled: - -- Atom feed -- Date when account is created -- Activity tab -- Groups tab -- Contributed projects tab -- Personal projects tab -- Starred projects tab -- Snippets tab +You can make your user profile visible to only you and GitLab administrators. To make your profile private: @@ -142,11 +70,13 @@ To make your profile private: 1. Select the **Private profile** checkbox. 1. Select **Update profile settings**. -NOTE: -All your profile information can be seen by yourself and GitLab administrators even if -the **Private profile** option is enabled. +The following is hidden from your user profile page (`https://gitlab.example.com/username`): -## Add details of external accounts +- Atom feed +- Date when account was created +- Tabs for activity, groups, contributed projects, personal projects, starred projects, snippets + +## Add external accounts to your user profile page You can add links to certain other external accounts you might have, like Skype and Twitter. They can help other users connect with you on other platforms. @@ -155,58 +85,47 @@ To add links to other accounts: 1. In the top-right corner, select your avatar. 1. Select **Edit profile**. -1. Edit the desired fields for external accounts: +1. In the **Main settings** section, add your information from: - Skype - LinkedIn - Twitter 1. Select **Update profile settings**. -## Private contributions +## Show private contributions on your user profile page > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/14078) in GitLab 11.3. -Enabling private contributions includes contributions to private projects, in the user contribution calendar graph and user recent activity. +In the user contribution calendar graph and recent activity list, you can show contributions to private projects. -To enable private contributions: +To show private contributions: 1. In the top-right corner, select your avatar. 1. Select **Edit profile**. -1. Select the **Private contributions** checkbox. +1. In the **Main settings** section, select the **Include private contributions on my profile** checkbox. 1. Select **Update profile settings**. -## Current status +## Set your current status > Introduced in GitLab 11.2. You can provide a custom status message for your user profile along with an emoji that describes it. This may be helpful when you are out of office or otherwise not available. -Other users can then take your status into consideration when responding to your issues or assigning work to you. -Please be aware that your status is publicly visible even if your [profile is private](#private-profile). -Status messages are restricted to 100 characters of plain text. -They may however contain emoji codes such as `I'm on vacation :palm_tree:`. +Your status is publicly visible even if your [profile is private](#make-your-user-profile-page-private). To set your current status: 1. In the top-right corner, select your avatar. -1. Select **Set status**, or **Edit status** if you have already set a status. -1. Set the desired emoji and status message. +1. Select **Set status** or, if you have already set a status, **Edit status**. +1. Set the desired emoji and status message. Status messages must be plain text and 100 characters or less. + They can also contain emoji codes like, `I'm on vacation :palm_tree:`. 1. Select **Set status**. Alternatively, you can select **Remove status** to remove your user status entirely. -or - -1. In the top-right corner, select your avatar. -1. Select your name or username. -1. Select the Edit profile icon (**{pencil}**). -1. Enter your status message in the **Your status** text field. -1. Select Add status emoji icon (**{slight-smile}**), and select the desired emoji. -1. Select **Update profile settings**. - -You can also set your current status [using the API](../../api/users.md#user-status). +You can also set your current status by [using the API](../../api/users.md#user-status). -If you previously selected the **Busy** checkbox, remember to deselect it when you become available again. +If you select the **Busy** checkbox, remember to clear it when you become available again. -## Busy status indicator +## Set a busy status indicator > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/259649) in GitLab 13.6. > - It was [deployed behind a feature flag](../feature_flags.md), disabled by default. @@ -217,21 +136,37 @@ If you previously selected the **Busy** checkbox, remember to deselect it when y To indicate to others that you are busy, you can set an indicator. - - To set the busy status indicator, either: - Set it directly: - 1. In the top-right corner, select your avatar. - 1. Select **Set status**, or **Edit status** if you have already set a status. + 1. Select **Set status** or, if you have already set a status, **Edit status**. 1. Select the **Busy** checkbox. - Set it on your profile: - 1. In the top-right corner, select your avatar. 1. Select **Edit profile**. - 1. Select the **Busy** checkbox. + 1. In the **Current status** section, select the **Busy** checkbox. + + The busy status is displayed in the user interface. + + Username: + + | Profile page | Settings menu | User popovers | + | --- | --- | --- | + |  |  |  | + + Issue and merge request sidebar: + + | Sidebar| Collapsed sidebar | + | --- | --- | + |  |  | + + Notes: + + | Notes | Note headers | + | --- | --- | + |  |  | ### Disable busy status feature @@ -250,7 +185,7 @@ To enable it: Feature.enable(:set_user_availability_status) ``` -## Commit email +## Change the email displayed on your commits > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/21598) in GitLab 11.4. @@ -262,29 +197,27 @@ To change your commit email: 1. In the top-right corner, select your avatar. 1. Select **Edit profile**. -1. Select the **Commit email** dropdown. -1. Select any of the verified emails. +1. In the **Commit email** list, select an email address. 1. Select **Update profile settings**. -### Private commit email +### Use an automatically-generated private commit email > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/22560) in GitLab 11.5. -GitLab provides the user with an automatically generated private commit email option, -which allows the user to keep their email information private. +GitLab provides an automatically-generated private commit email address, +so you can keep your email information private. -To enable this option: +To use a private commit email: 1. In the top-right corner, select your avatar. 1. Select **Edit profile**. -1. Select the **Commit email** dropdown. -1. Select **Use a private email** option. +1. In the **Commit email** list, select the **Use a private email** option. 1. Select **Update profile settings**. -After this option is enabled, every Git-related action is performed using the private commit email. +Every Git-related action uses the private commit email. -To stay fully anonymous, you can also copy this private commit email -and configure it on your local machine using the following command: +To stay fully anonymous, you can also copy the private commit email +and configure it on your local machine by using the following command: ```shell git config --global user.email <your email address> @@ -294,16 +227,16 @@ git config --global user.email <your email address> ### Why do I keep getting signed out? -When signing in to the main GitLab application, a `_gitlab_session` cookie is -set. `_gitlab_session` is cleared client-side when you close your browser -and expires after "Application settings -> Session duration (minutes)"/`session_expire_delay` +When you sign in to the main GitLab application, a `_gitlab_session` cookie is +set. When you close your browser, the cookie is cleared client-side +and it expires after "Application settings > Session duration (minutes)"/`session_expire_delay` (defaults to `10080` minutes = 7 days) of no activity. -When signing in to the main GitLab application, you can also check the -**Remember me** option which sets the `remember_user_token` -cookie (via [`devise`](https://github.com/heartcombo/devise)). -`remember_user_token` expires after -`config/initializers/devise.rb` -> `config.remember_for` (defaults to 2 weeks). +When you sign in to the main GitLab application, you can also check the +**Remember me** option. This sets the `remember_user_token` +cookie via [`devise`](https://github.com/heartcombo/devise). +The `remember_user_token` cookie expires after +`config/initializers/devise.rb` -> `config.remember_for`. The default is 2 weeks. When the `_gitlab_session` expires or isn't available, GitLab uses the `remember_user_token` to get you a new `_gitlab_session` and keep you signed in through browser restarts. @@ -339,3 +272,14 @@ The server continues to reset the TTL for that session, independent of whether 2 If you close your browser and open it up again, the `remember_user_token` cookie allows your user to reauthenticate itself. Without the `config.extend_remember_period` flag, you would be forced to sign in again after two weeks. + +## Related topics + +- [Create users](account/create_accounts.md) +- [Sign in to your GitLab account](../../topics/authentication/index.md) +- [Receive emails for sign-ins from unknown IP addresses or devices](unknown_sign_in_notification.md) +- Manage applications that can [use GitLab as an OAuth provider](../../integration/oauth_provider.md#introduction-to-oauth) +- Manage [personal access tokens](personal_access_tokens.md) to access your account via API and authorized applications +- Manage [SSH keys](../../ssh/README.md) to access your account via SSH +- Change your [syntax highlighting theme](preferences.md#syntax-highlighting-theme) +- [View your active sessions](active_sessions.md) and revoke any of them if necessary |