| [User account](user/profile/index.md) | Manage your account. |
| [Authentication](topics/authentication/index.md) | Account security with two-factor authentication, set up your SSH keys, and deploy keys for secure access to your projects. |
| [Profile settings](user/profile/index.md#profile-settings) | Manage your profile settings, two factor authentication, and more. |
| [User settings](user/profile/index.md#user-settings) | Manage your user settings, two factor authentication, and more. |
| [User permissions](user/permissions.md) | Learn what each role in a project can do. |
@@ -18,12 +18,15 @@ The following assumes you already have Vault installed and running.
1.**Get the OpenID Connect client ID and secret from GitLab:**
First you must create a GitLab application to obtain an application ID and secret for authenticating into Vault. To do this, sign in to GitLab and follow these steps:
1. On GitLab, click your avatar on the top-right corner, and select your user **Settings > Applications**.
1. Fill out the application **Name** and [**Redirect URI**](https://www.vaultproject.io/docs/auth/jwt#redirect-uris),
making sure to select the **OpenID** scope.
1. Save application.
First you must create a GitLab application to obtain an application ID and secret for authenticating into Vault.
To do this, sign in to GitLab and follow these steps:
1. In the top-right corner, select your avatar.
1. Select **Edit profile**.
1. In the left sidebar, select **Applications**.
1. Fill out the application **Name** and [**Redirect URI**](https://www.vaultproject.io/docs/auth/jwt#redirect-uris).
1. Select the **OpenID** scope.
1. Select **Save application**.
1. Copy client ID and secret, or keep the page open for reference.
1. In the left sidebar, select **[Usage Quotas](https://gitlab.com/profile/usage_quotas#pipelines-quota-tab)**.
Only pipeline minutes for GitLab shared runners are restricted. If you have a
specific runner set up for your projects, there is no limit to your build time on GitLab SaaS.
...
...
@@ -282,10 +285,12 @@ To purchase additional minutes for your group on GitLab SaaS:
To purchase additional minutes for your personal namespace:
1. Click your avatar, then go to **Settings > Usage Quotas**.
1. In the top-right corner, select your avatar.
1. Select **Edit profile**.
1. In the left sidebar, select **Usage Quotas**.
1. Select **Buy additional minutes** and GitLab redirects you to the Customers Portal.
1. Locate the subscription card that's linked to your personal namespace on GitLab SaaS, click **Buy more CI minutes**, and complete the details about the transaction. Once we have processed your payment, the extra CI minutes are synced to your personal namespace.
1. To confirm the available CI minutes for your personal projects, click your avatar, then go to **Settings > Usage Quotas**.
1. To confirm the available CI minutes for your personal projects, go to the **Usage Quotas** settings again.
The **Additional minutes** displayed now includes the purchased additional CI minutes, plus any minutes rolled over from last month.
@@ -22,7 +22,7 @@ SAML SSO is not supported at the subgroup level.
## Configuring your Identity Provider
1. Navigate to the group and click**Settings > SAML SSO**.
1. Navigate to the group and select**Settings > SAML SSO**.
1. Configure your SAML server using the **Assertion consumer service URL**, **Identifier**, and **GitLab single sign-on URL**. Alternatively GitLab provides [metadata XML configuration](#metadata-configuration). See [specific identity provider documentation](#providers) for more details.
1. Configure the SAML response to include a NameID that uniquely identifies each user.
1. Configure [required assertions](group_managed_accounts.md#assertions) if using [Group Managed Accounts](group_managed_accounts.md).
...
...
@@ -57,7 +57,7 @@ We recommend setting the NameID format to `Persistent` unless using a field (suc
GitLab provides metadata XML that can be used to configure your Identity Provider.
1. Navigate to the group and click**Settings > SAML SSO**.
1. Navigate to the group and select**Settings > SAML SSO**.
1. Copy the provided **GitLab metadata URL**.
1. Follow your Identity Provider's documentation and paste the metadata URL when it's requested.
...
...
@@ -69,8 +69,8 @@ After you set up your identity provider to work with GitLab, you must configure
1. Find the SSO URL from your Identity Provider and enter it the **Identity provider single sign-on URL** field.
1. Find and enter the fingerprint for the SAML token signing certificate in the **Certificate** field.
1. Select the access level to be applied to newly added users in the **Default membership role** field. The default access level is 'Guest'.
1.Click the **Enable SAML authentication for this group** toggle switch.
1.Click the **Save changes** button.
1.Select the **Enable SAML authentication for this group** toggle switch.
1.Select the **Save changes** button.
...
...
@@ -216,7 +216,7 @@ To link SAML to your existing GitLab.com account:
1. Sign in to your GitLab.com account.
1. Locate and visit the **GitLab single sign-on URL** for the group you're signing in to. A group owner can find this on the group's **Settings > SAML SSO** page. If the sign-in URL is configured, users can connect to the GitLab app from the Identity Provider.
1.Click**Authorize**.
1.Select**Authorize**.
1. Enter your credentials on the Identity Provider if prompted.
1. You are then redirected back to GitLab.com and should now have access to the group. In the future, you can use SAML to sign in to GitLab.com.
...
...
@@ -225,7 +225,7 @@ On subsequent visits, you should be able to go [sign in to GitLab.com with SAML]
### Signing in to GitLab.com with SAML
1. Sign in to your identity provider.
1. From the list of apps, click on the "GitLab.com" app (The name is set by the administrator of the identity provider).
1. From the list of apps, select the "GitLab.com" app. (The name is set by the administrator of the identity provider.)
1. You are then signed in to GitLab.com and redirected to the group.
### Configure user settings from SAML response
...
...
@@ -293,10 +293,15 @@ Users can unlink SAML for a group from their profile page. This can be helpful i
- Your SAML NameID has changed and so GitLab can no longer find your user.
WARNING:
Unlinking an account removes all roles assigned to that user within the group.
Unlinking an account removes all roles assigned to that user in the group.
If a user re-links their account, roles need to be reassigned.
For example, to unlink the `MyOrg` account, the following **Disconnect** button is available under **Profile > Accounts**:
For example, to unlink the `MyOrg` account:
1. In the top-right corner, select your avatar.
1. Select **Edit profile**.
1. In the left sidebar, select **Account**.
1. In the **Social sign-in** section, select **Disconnect** next to the connected account.
@@ -8,7 +8,7 @@ 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](#profile-settings)
contains information about you, and your GitLab activity. Your [settings](#user-settings)
allow you to customize some aspects of GitLab to suit yourself.
## Creating users
...
...
@@ -29,8 +29,8 @@ See [Unknown Sign-In Notification](unknown_sign_in_notification.md) for more det
To access your profile:
1.Click on your avatar.
1. Select **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:
...
...
@@ -42,12 +42,12 @@ On your profile page, you can see the following information:
- Starred projects: projects you starred
- Snippets: your personal code [snippets](../snippets.md#personal-snippets)
## Profile settings
## User settings
To access your profile settings:
To access your user settings:
1.Click on your avatar.
1. Select **Settings**.
1.In the top-right corner, select your avatar.
1. Select **Edit profile**.
From there, you can:
...
...
@@ -78,11 +78,12 @@ From there, you can:
## Changing your password
1. Navigate to your [profile's](#profile-settings)**Settings > 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. Click the 'Save password' button.
1. Go to your [user settings](#user-settings).
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. Select **Save password**.
If you don't know your current password, select the 'I forgot my password' link.
...
...
@@ -97,12 +98,13 @@ before proceeding.
To change your `username`:
1. Navigate to your [profile's](#profile-settings)**Settings > Account**.
1. Navigate to your [user settings](#user-settings).
1. In the left sidebar, select **Account**.
1. Enter a new username under **Change username**.
1.Click**Update username**.
1.Select**Update username**.
WARNING:
It is currently not possible to change your username if it contains a
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.
...
...
@@ -127,33 +129,31 @@ The following information is hidden from the user profile page (`https://gitlab.
- Starred projects tab
- Snippets tab
To enable private profile:
To make your profile private:
1. Click your avatar.
1. Select **Profile**.
1. Click **Edit profile** (pencil icon).
1. Check the **Private profile** option in the **Main settings** section.
1. Click **Update profile settings**.
1. In the top-right corner, select your avatar.
1. Select **Edit profile**.
1. Select the **Private profile** checkbox.
1. Select **Update profile settings**.
NOTE:
All your profile information can be seen by yourself, and GitLab admins, even if
All your profile information can be seen by yourself and GitLab administrators even if
the **Private profile** option is enabled.
## Add details of external accounts
GitLab allows you to 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.
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.
To add links to other accounts:
1. Click your avatar.
1. Select **Profile**.
1. Click **Edit profile** (pencil icon).
1. Complete the desired fields for external accounts, in the **Main settings**
section:
1. In the top-right corner, select your avatar.
1. Select **Edit profile**.
1. Edit the desired fields for external accounts:
- Skype
- Twitter
- LinkedIn
1. Click **Update profile settings**.
- Twitter
1. Select **Update profile settings**.
## Private contributions
...
...
@@ -163,11 +163,10 @@ Enabling private contributions includes contributions to private projects, in th
To enable private contributions:
1. Click on your avatar.
1. Select **Profile**.
1. Click **Edit profile** (pencil icon).
1. Check the **Private contributions** option.
1. Click **Update profile settings**.
1. In the top-right corner, select your avatar.
1. Select **Edit profile**.
1. Select the **Private contributions** checkbox.
1. Select **Update profile settings**.
## Current status
...
...
@@ -183,23 +182,23 @@ They may however contain emoji codes such as `I'm on vacation :palm_tree:`.
To set your current status:
1.Click your avatar.
1.Click**Set status**, or **Edit status** if you have already set a status.
1. Set the desired emoji and/or status message.
1.Click **Set status**. Alternatively, you can click**Remove status** to remove your user status entirely.
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**. Alternatively, you can select**Remove status** to remove your user status entirely.
or
1.Click your avatar.
1. Select **Profile**.
1.Click **Edit profile** (pencil icon).
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.Click **Add status emoji** (smiley face), and select the desired emoji.
1.Click**Update profile settings**.
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).
If you previously selected the "Busy" checkbox, remember to deselect it when you become available again.
If you previously selected the **Busy** checkbox, remember to deselect it when you become available again.
## Busy status indicator
...
...
@@ -210,7 +209,7 @@ If you previously selected the "Busy" checkbox, remember to deselect it when you
> - It's not recommended for production use.
> - For GitLab self-managed instances, GitLab administrators can opt to [disable it](#disable-busy-status-feature).
To indicate to others that you are busy, you can set an indicator
To indicate to others that you are busy, you can set an indicator.
...
...
@@ -218,16 +217,15 @@ To set the busy status indicator, either:
- Set it directly:
1.Click your avatar.
1.Click**Set status**, or **Edit status** if you have already set a status.
1. Select the **Busy** checkbox
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 the **Busy** checkbox.
- Set it on your profile:
1. Click your avatar.
1. Select **Profile**.
1. Click **Edit profile** (**{pencil}**).
1. Select the **Busy** checkbox
1. In the top-right corner, select your avatar.
1. Select **Edit profile**.
1. Select the **Busy** checkbox.
### Disable busy status feature
...
...
@@ -256,12 +254,11 @@ Any of your own verified email addresses can be used as the commit email.
To change your commit email:
1. Click your avatar.
1. Select **Profile**.
1. Click **Edit profile** (pencil icon).
1. Click **Commit email** dropdown.
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.Click**Update profile settings**.
1.Select**Update profile settings**.
### Private commit email
...
...
@@ -272,14 +269,13 @@ which allows the user to keep their email information private.
To enable this option:
1. Click your avatar.
1. Select **Profile**.
1. Click **Edit profile** (pencil icon).
1. Click **Commit email** dropdown.
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.Click**Update profile settings**.
1.Select**Update profile settings**.
Once this option is enabled, every Git-related action is performed using the private commit email.
After this option is enabled, every Git-related action is performed using 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:
...
...
@@ -298,7 +294,7 @@ and expires after "Application settings -> Session duration (minutes)"/`session_
(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`
**Remember me** option which sets the `remember_user_token`
`config/initializers/devise.rb` -> `config.remember_for` (defaults to 2 weeks).
...
...
@@ -326,7 +322,8 @@ GitLab uses both session and persistent cookies:
- Session cookie: Session cookies are normally removed at the end of the browser session when
the browser is closed. The `_gitlab_session` cookie has no fixed expiration date. However,
it expires based on its [`session_expire_delay`](#why-do-i-keep-getting-signed-out).
- Persistent cookie: The `remember_user_token` is a cookie with an expiration date of two weeks. GitLab activates this cookie if you click Remember Me when you sign in.
- Persistent cookie: The `remember_user_token` is a cookie with an expiration date of two weeks.
GitLab activates this cookie if you select **Remember Me** when you sign in.
By default, the server sets a time-to-live (TTL) of 1-week on any session that is used.
...
...
@@ -336,15 +333,3 @@ 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.
<!-- ## Troubleshooting
Include any troubleshooting steps that you can foresee. If you know beforehand what issues
one might have when setting this up, or when something is changed, or on upgrading, it's
important to describe those, too. Think of things that may go wrong and include them here.
This is important to minimize requests for support, and to avoid doc comments with
questions that you know someone might ask.
Each scenario can be a third-level heading, e.g. `### Getting error message X`.
If you have none to add when creating a doc, leave this section in place
but commented out to help encourage others to add to it in the future. -->
Dark theme currently only works with the 'Dark' syntax highlighting.
Dark theme only works with the **Dark** syntax highlighting theme.
## Syntax highlighting theme
NOTE:
GitLab uses the [rouge Ruby library](http://rouge.jneen.net/"Rouge website")
for syntax highlighting outside of any Editor context. The WebIDE (like Snippets)
uses [Monaco Editor](https://microsoft.github.io/monaco-editor/) and it's provided [Monarch](https://microsoft.github.io/monaco-editor/monarch.html) library for
uses [Monaco Editor](https://microsoft.github.io/monaco-editor/) and it's provided
[Monarch](https://microsoft.github.io/monaco-editor/monarch.html) library for
syntax highlighting. For a list of supported languages, visit the documentation of
the respective libraries.
...
...
@@ -121,7 +121,7 @@ You have 8 options here that you can use for your default dashboard view:
@@ -82,11 +82,10 @@ Click **Expand file** on any file to view the changes for that file.
For larger merge requests, consider reviewing one file at a time. To enable this feature:
1. In the top right corner of the navigation bar, click your user avatar.
1. Click **Settings**.
1. In the left sidebar, go to **Preferences**.
1. In the top-right corner, select your avatar.
1. Select **Preferences**.
1. Scroll to the **Behavior** section and select **Show one file at a time on merge request's Changes tab**.
1.Click **Save changes** to apply.
1.Select **Save changes**.
After you enable this setting, GitLab displays only one file at a time in the **Changes** tab when you review merge requests. You can click **Prev** and **Next** to view other changed files.
...
...
@@ -97,7 +96,7 @@ this behavior, you can do so from your **User preferences** (as explained above)
merge request:
1. Go to the merge request's **Changes** tab.
1.Click the cog icon (**{settings}**) to reveal the merge request's settings dropdown.
1.Select the cog icon (**{settings}**) to reveal the merge request's settings dropdown.
1. Select or deselect the checkbox **Show one file at a time** to change the setting accordingly.
This change overrides the choice you made in your user preferences and persists until you clear your
...
...
@@ -109,11 +108,11 @@ browser's cookies or change this behavior again.
To seamlessly navigate among commits in a merge request:
1.Click the **Commits** tab.
1.Click a commit to open it in the single-commit view.
1.Select the **Commits** tab.
1.Select a commit to open it in the single-commit view.
1. Navigate through the commits by either:
-Clicking **Prev** and **Next** buttons on the top-right of the page.
-Selecting **Prev** and **Next** buttons on the top-right of the page.
- Using the <kbd>X</kbd> and <kbd>C</kbd> keyboard shortcuts.
@@ -116,7 +116,7 @@ LDAP Users remain confirmed if all of the following conditions are met:
- The ["User email confirmation at sign-up" option](../security/user_email_confirmation.md) is set to false.
- The first sign-in is based on user LDAP credentials.
- The user has added and verified [a secondary email address](profile/index.md#profile-settings) some time later.
- The user has added and verified [a secondary email address](profile/index.md#user-settings) some time later.
NOTE:
Confirmation timestamps (primary vs. secondary) are different.
...
...
@@ -124,6 +124,6 @@ Confirmation timestamps (primary vs. secondary) are different.
Users remain unconfirmed by the background migration if any of the following conditions are met:
- They [create an account through GitLab](profile/account/create_accounts.md).
- They [swap their primary email address](profile/index.md#profile-settings) and verify it.
- They [swap their primary email address](profile/index.md#user-settings) and verify it.
- If they have two email addresses with the same `confirmed_at` timestamp due to the linked [security issue](https://gitlab.com/gitlab-org/gitlab/-/issues/121664).
-[LDAP is introduced](../administration/auth/ldap/index.md), and users' primary email address matches that in LDAP.
# Note this context ensures that the example it contains is executed after the example above. Be aware of the order of execution if you add new examples in either context.
context'after adding an ssh key'do
it'can delete an ssh key',testcase: 'https://gitlab.com/gitlab-org/quality/testcases/-/issues/930'do
