diff options
Diffstat (limited to 'doc/user/admin_area')
| -rw-r--r-- | doc/user/admin_area/custom_project_templates.md | 2 | ||||
| -rw-r--r-- | doc/user/admin_area/index.md | 75 | ||||
| -rw-r--r-- | doc/user/admin_area/license_file.md | 6 | ||||
| -rw-r--r-- | doc/user/admin_area/moderate_users.md | 4 | ||||
| -rw-r--r-- | doc/user/admin_area/reporting/git_abuse_rate_limit.md | 4 | ||||
| -rw-r--r-- | doc/user/admin_area/settings/account_and_limit_settings.md | 13 | ||||
| -rw-r--r-- | doc/user/admin_area/settings/continuous_integration.md | 4 | ||||
| -rw-r--r-- | doc/user/admin_area/settings/help_page.md | 2 | ||||
| -rw-r--r-- | doc/user/admin_area/settings/instance_template_repository.md | 4 | ||||
| -rw-r--r-- | doc/user/admin_area/settings/sign_in_restrictions.md | 5 | ||||
| -rw-r--r-- | doc/user/admin_area/settings/terms.md | 2 | ||||
| -rw-r--r-- | doc/user/admin_area/settings/third_party_offers.md | 2 | ||||
| -rw-r--r-- | doc/user/admin_area/settings/usage_statistics.md | 4 | ||||
| -rw-r--r-- | doc/user/admin_area/settings/visibility_and_access_controls.md | 28 |
14 files changed, 95 insertions, 60 deletions
diff --git a/doc/user/admin_area/custom_project_templates.md b/doc/user/admin_area/custom_project_templates.md index de2856c2320..847f687d051 100644 --- a/doc/user/admin_area/custom_project_templates.md +++ b/doc/user/admin_area/custom_project_templates.md @@ -16,7 +16,7 @@ when you go to **New project > Create from template** and select the **Instance* Every project in the group, but not its subgroups, can be selected when a new project is created, based on the user's access permissions: -- Public projects can be selected by any signed-in user as a template for a new project, +- Public projects can be selected by any authenticated user as a template for a new project, if all enabled [project features](../project/settings/index.md#configure-project-visibility-features-and-permissions) except for **GitLab Pages** and **Security & Compliance** are set to **Everyone With Access**. The same applies to internal projects. diff --git a/doc/user/admin_area/index.md b/doc/user/admin_area/index.md index c9b6a077c73..559aae63da5 100644 --- a/doc/user/admin_area/index.md +++ b/doc/user/admin_area/index.md @@ -135,8 +135,7 @@ For each user, the following are listed: 1. Date of account creation 1. Date of last activity -To edit a user, select the **Edit** button in that user's -row. To delete the user, or delete the user and their contributions, select the cog dropdown list in +To edit a user, in the user's row, select **Edit**. To delete the user, or delete the user and their contributions, select the cog dropdown list in that user's row, and select the desired option. To change the sort order: @@ -256,9 +255,7 @@ To access the Groups page: 1. On the left sidebar, select **Overview > Groups**. For each group, the page displays their name, description, size, number of projects in the group, -number of members, and whether the group is private, internal, or public. To edit a group, select -the **Edit** button in that group's row. To delete the group, select the **Delete** button in -that group's row. +number of members, and whether the group is private, internal, or public. To edit a group, in the group's row, select **Edit**. To delete the group, in the group's row, select **Delete**. To change the sort order, select the sort dropdown list and select the desired order. The default sort order is by **Last created**. @@ -300,33 +297,32 @@ The assigned topics are visible only to everyone with access to the project, but everyone can see which topics exist on the GitLab instance. Do not include sensitive information in the name of a topic. -### Administering Jobs +### Administering Gitaly servers -You can administer all jobs in the GitLab instance from the Admin Area's Jobs page. +You can list all Gitaly servers in the GitLab instance from the Admin Area's **Gitaly Servers** +page. For more details, see [Gitaly](../../administration/gitaly/index.md). -To access the Jobs page: +To access the **Gitaly Servers** page: 1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Overview > Jobs**. All jobs are listed, in descending order of job ID. -1. Select the **All** tab to list all jobs. Select the **Pending**, **Running**, or **Finished** - tab to list only jobs of that status. +1. On the left sidebar, select **Overview > Gitaly Servers**. -For each job, the following details are listed: +For each Gitaly server, the following details are listed: -| Field | Description | -|----------|-------------| -| Status | Job status, either **passed**, **skipped**, or **failed**. | -| Job | Includes links to the job, branch, and the commit that started the job. | -| Pipeline | Includes a link to the specific pipeline. | -| Project | Name of the project, and organization, to which the job belongs. | -| Runner | Name of the CI runner assigned to execute the job. | -| Stage | Stage that the job is declared in a `.gitlab-ci.yml` file. | -| Name | Name of the job specified in a `.gitlab-ci.yml` file. | -| Timing | Duration of the job, and how long ago the job completed. | -| Coverage | Percentage of tests coverage. | +| Field | Description | +|----------------|-------------| +| Storage | Repository storage | +| Address | Network address on which the Gitaly server is listening | +| Server version | Gitaly version | +| Git version | Version of Git installed on the Gitaly server | +| Up to date | Indicates if the Gitaly server version is the latest version available. A green dot indicates the server is up to date. | + +## CI/CD section ### Administering runners +> [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/340859) from **Overview > Runners** to **CI/CD > Runners** in GitLab 15.8. + You can administer all runners in the GitLab instance from the Admin Area's **Runners** page. See [GitLab Runner](https://docs.gitlab.com/runner/) for more information. @@ -380,25 +376,32 @@ For each runner, the following attributes are listed: You can also edit, pause, or remove each runner. -### Administering Gitaly servers +### Administering Jobs -You can list all Gitaly servers in the GitLab instance from the Admin Area's **Gitaly Servers** -page. For more details, see [Gitaly](../../administration/gitaly/index.md). +> [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/386311) from **Overview > Jobs** to **CI/CD > Jobs** in GitLab 15.8. -To access the **Gitaly Servers** page: +You can administer all jobs in the GitLab instance from the Admin Area's Jobs page. + +To access the Jobs page: 1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Overview > Gitaly Servers**. +1. On the left sidebar, select **CI/CD > Jobs**. All jobs are listed, in descending order of job ID. +1. Select the **All** tab to list all jobs. Select the **Pending**, **Running**, or **Finished** + tab to list only jobs of that status. -For each Gitaly server, the following details are listed: +For each job, the following details are listed: -| Field | Description | -|----------------|-------------| -| Storage | Repository storage | -| Address | Network address on which the Gitaly server is listening | -| Server version | Gitaly version | -| Git version | Version of Git installed on the Gitaly server | -| Up to date | Indicates if the Gitaly server version is the latest version available. A green dot indicates the server is up to date. | +| Field | Description | +|----------|-------------| +| Status | Job status, either **passed**, **skipped**, or **failed**. | +| Job | Includes links to the job, branch, and the commit that started the job. | +| Pipeline | Includes a link to the specific pipeline. | +| Project | Name of the project, and organization, to which the job belongs. | +| Runner | Name of the CI runner assigned to execute the job. | +| Stage | Stage that the job is declared in a `.gitlab-ci.yml` file. | +| Name | Name of the job specified in a `.gitlab-ci.yml` file. | +| Timing | Duration of the job, and how long ago the job completed. | +| Coverage | Percentage of tests coverage. | ## Monitoring section diff --git a/doc/user/admin_area/license_file.md b/doc/user/admin_area/license_file.md index 9c35a8c1269..29e43476819 100644 --- a/doc/user/admin_area/license_file.md +++ b/doc/user/admin_area/license_file.md @@ -75,7 +75,7 @@ and issue creation. Your instance becomes read-only and an expiration message displays to all administrators. You have a 14-day grace period before this occurs. -To resume functionality, [renew your subscription](../../subscriptions/self_managed/index.md#renew-a-subscription). +To resume functionality, [renew your subscription](../../subscriptions/self_managed/index.md#renew-subscription-manually). If the license has been expired for more than 30 days, you must purchase a [new subscription](../../subscriptions/self_managed/index.md) to resume functionality. @@ -187,7 +187,7 @@ License.current.data #### Check if a project feature is available on the instance -Features listed in <https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/app/models/license.rb>. +Features listed in [`features.rb`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/app/models/gitlab_subscriptions/features.rb). ```ruby License.current.feature_available?(:jira_dev_panel_integration) @@ -195,7 +195,7 @@ License.current.feature_available?(:jira_dev_panel_integration) #### Check if a project feature is available in a project -Features listed in [`license.rb`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/app/models/license.rb). +Features listed in [`features.rb`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/app/models/gitlab_subscriptions/features.rb). ```ruby p = Project.find_by_full_path('<group>/<project>') diff --git a/doc/user/admin_area/moderate_users.md b/doc/user/admin_area/moderate_users.md index c0daf029b1f..3d96eaf793f 100644 --- a/doc/user/admin_area/moderate_users.md +++ b/doc/user/admin_area/moderate_users.md @@ -142,7 +142,7 @@ A deactivated user: - Cannot access Git repositories or the API. - Does not receive any notifications from GitLab. -- Does not be able to use [slash commands](../../integration/slash_commands.md). +- Cannot use [slash commands](../../integration/slash_commands.md). - Does not consume a [seat](../../subscriptions/self_managed/index.md#billable-users). Personal projects, and group and user history of the deactivated user are left intact. @@ -223,7 +223,7 @@ On self-managed GitLab, by default this feature is available. To hide the feature, ask an administrator to [disable the feature flag](../../administration/feature_flags.md) named `ban_user_feature_flag`. On GitLab.com, this feature is available to GitLab.com administrators only. -GitLab administrators can ban and unban users. Banned users are blocked, and their issues are hidden. +GitLab administrators can ban and unban users. Banned users are blocked, and their issues and merge requests are hidden. The banned user's comments are still displayed. Hiding a banned user's comments is [tracked in this issue](https://gitlab.com/gitlab-org/gitlab/-/issues/327356). ### Ban a user diff --git a/doc/user/admin_area/reporting/git_abuse_rate_limit.md b/doc/user/admin_area/reporting/git_abuse_rate_limit.md index f700b8b1ea3..66d1173058e 100644 --- a/doc/user/admin_area/reporting/git_abuse_rate_limit.md +++ b/doc/user/admin_area/reporting/git_abuse_rate_limit.md @@ -4,12 +4,12 @@ group: Anti-Abuse info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Git abuse rate limit (administration) **(ULTIMATE SELF)** +# Git abuse rate limit (administration) **(ULTIMATE)** > [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/8066) in GitLab 15.2 [with a flag](../../../administration/feature_flags.md) named `git_abuse_rate_limit_feature_flag`. Disabled by default. FLAG: -On self-managed GitLab, by default this feature is not available. To make it available, ask an administrator to [enable the feature flag](../../../administration/feature_flags.md) named `git_abuse_rate_limit_feature_flag`. On GitLab.com, this feature is not available. +On self-managed GitLab, by default this feature is not available. To make it available, ask an administrator to [enable the feature flag](../../../administration/feature_flags.md) named `git_abuse_rate_limit_feature_flag`. On GitLab.com, this feature is available. Git abuse rate limiting is a feature to automatically [ban users](../moderate_users.md#ban-and-unban-users) who download or clone more than a specified number of repositories in any project in the instance within a given time frame. Banned users cannot sign in to the instance and cannot access any non-public group via HTTP or SSH. diff --git a/doc/user/admin_area/settings/account_and_limit_settings.md b/doc/user/admin_area/settings/account_and_limit_settings.md index b235b812416..7f678344955 100644 --- a/doc/user/admin_area/settings/account_and_limit_settings.md +++ b/doc/user/admin_area/settings/account_and_limit_settings.md @@ -102,7 +102,8 @@ to find tokens more quickly, or for use with automation tools. The default prefix is `glpat-` but administrators can change it. -[Project access tokens](../../project/settings/project_access_tokens.md) also inherit this prefix. +[Project access tokens](../../project/settings/project_access_tokens.md) and +[group access tokens](../../group/settings/group_access_tokens.md) also inherit this prefix. ### Set a prefix @@ -291,6 +292,16 @@ By default, new users can create top-level groups. GitLab administrators can pre 1. On the left sidebar, select **Settings > General**, then expand **Account and limit**. 1. Clear the **Allow new users to create top-level groups** checkbox. +## Set profiles of new users to private by default + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/231301) in GitLab 15.8. + +By default, newly created users have a public profile. GitLab administrators can set new users to have a private profile by default: + +1. On the top bar, select **Main menu > Admin**. +1. On the left sidebar, select **Settings > General**, then expand **Account and limit**. +1. Select the **Make new users' profiles private by default** checkbox. + ## Troubleshooting ### 413 Request Entity Too Large diff --git a/doc/user/admin_area/settings/continuous_integration.md b/doc/user/admin_area/settings/continuous_integration.md index 81e51aaef37..7c869c9b8fe 100644 --- a/doc/user/admin_area/settings/continuous_integration.md +++ b/doc/user/admin_area/settings/continuous_integration.md @@ -52,7 +52,7 @@ you can assign that runner to other projects. To enable a specific runner for more than one project: 1. On the top bar, select **Main menu > Admin**. -1. From the left sidebar, select **Overview > Runners**. +1. From the left sidebar, select **CI/CD > Runners**. 1. Select the runner you want to edit. 1. In the top right, select **Edit** (**{pencil}**). 1. Under **Restrict projects for this runner**, search for a project. @@ -188,7 +188,7 @@ For the value set for GitLab.com, see [Scheduled job archiving](../../gitlab_com ## Protect CI/CD variables by default To set all new [CI/CD variables](../../../ci/variables/index.md) as -[protected](../../../ci/variables/index.md#protected-cicd-variables) by default: +[protected](../../../ci/variables/index.md#protect-a-cicd-variable) by default: 1. On the top bar, select **Main menu > Admin**. 1. On the left sidebar, select **Settings > CI/CD**. diff --git a/doc/user/admin_area/settings/help_page.md b/doc/user/admin_area/settings/help_page.md index 8d0fef398af..07d3ae83d74 100644 --- a/doc/user/admin_area/settings/help_page.md +++ b/doc/user/admin_area/settings/help_page.md @@ -27,7 +27,7 @@ You can now see the message on `/help`. NOTE: By default, `/help` is visible to unauthenticated users. However, if the [**Public** visibility level](visibility_and_access_controls.md#restrict-visibility-levels) -is restricted, `/help` is visible only to signed-in users. +is restricted, `/help` is visible only to authenticated users. ## Add a help message to the sign-in page diff --git a/doc/user/admin_area/settings/instance_template_repository.md b/doc/user/admin_area/settings/instance_template_repository.md index bf07c5b2808..026782ae83b 100644 --- a/doc/user/admin_area/settings/instance_template_repository.md +++ b/doc/user/admin_area/settings/instance_template_repository.md @@ -13,7 +13,7 @@ type: reference In hosted systems, enterprises often have a need to share their own templates across teams. This feature allows an administrator to pick a project to be the instance-wide collection of file templates. These templates are then exposed to -all users [via the web editor](../../project/repository/web_editor.md#template-dropdowns) +all users through the [Web Editor](../../project/repository/web_editor.md) while the project remains secure. ## Configuration @@ -28,7 +28,7 @@ To select a project to serve as the custom template repository: 1. Add custom templates to the selected repository. After you add templates, you can use them for the entire instance. -They are available in the [Web Editor's dropdown list](../../project/repository/web_editor.md#template-dropdowns) +They are available in the [Web Editor](../../project/repository/web_editor.md) and through the [API settings](../../../api/settings.md). ## Supported file types and locations diff --git a/doc/user/admin_area/settings/sign_in_restrictions.md b/doc/user/admin_area/settings/sign_in_restrictions.md index 6ec3d082114..d663238a88c 100644 --- a/doc/user/admin_area/settings/sign_in_restrictions.md +++ b/doc/user/admin_area/settings/sign_in_restrictions.md @@ -68,7 +68,7 @@ For more information, see the [list of settings that can be accessed through API Open the [Rails console](../../../administration/operations/rails_console.md) and run the following: ```ruby -::Gitlab::CurrentSettings.update!(admin_mode true) +::Gitlab::CurrentSettings.update!(admin_mode: true) ``` #### Use the UI to enable Admin Mode @@ -115,6 +115,9 @@ authentication steps. We may address these limitations in the future. For more information see the following epic: [Admin Mode for GitLab Administrators](https://gitlab.com/groups/gitlab-org/-/epics/2158). +Also, when GitLab Geo is enabled, you can't view the replication status of projects and designs while +on a secondary node. A fix is proposed when projects ([issue 367926](https://gitlab.com/gitlab-org/gitlab/-/issues/367926)) and designs ([issue 355660](https://gitlab.com/gitlab-org/gitlab/-/issues/355660)) move to the new Geo framework. + ### Troubleshooting Admin Mode If necessary, you can disable **Admin Mode** as an administrator by using one of these two methods: diff --git a/doc/user/admin_area/settings/terms.md b/doc/user/admin_area/settings/terms.md index 9a02e50b23f..85927bad8ad 100644 --- a/doc/user/admin_area/settings/terms.md +++ b/doc/user/admin_area/settings/terms.md @@ -29,7 +29,7 @@ For each update to the terms, a new version is stored. When a user accepts or de GitLab records which version they accepted or declined. Existing users must accept the terms on their next GitLab interaction. -If a signed-in user declines the terms, they are signed out. +If an authenticated user declines the terms, they are signed out. When enabled, it adds a mandatory checkbox to the sign up page for new users: diff --git a/doc/user/admin_area/settings/third_party_offers.md b/doc/user/admin_area/settings/third_party_offers.md index 8d2ae72ba69..4f6e727f673 100644 --- a/doc/user/admin_area/settings/third_party_offers.md +++ b/doc/user/admin_area/settings/third_party_offers.md @@ -1,6 +1,6 @@ --- stage: Manage -group: Workspace +group: Organization info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments type: reference --- diff --git a/doc/user/admin_area/settings/usage_statistics.md b/doc/user/admin_area/settings/usage_statistics.md index df60268a8bf..8b9f09d9df5 100644 --- a/doc/user/admin_area/settings/usage_statistics.md +++ b/doc/user/admin_area/settings/usage_statistics.md @@ -48,7 +48,7 @@ tier. Users can continue to access the features in a paid tier without sharing u ### Features available in 14.4 and later - [Repository size limit](../settings/account_and_limit_settings.md#repository-size-limit). -- [Group access restriction by IP address](../../group/access_and_permissions.md#restrict-access-to-groups-by-ip-address). +- [Group access restriction by IP address](../../group/access_and_permissions.md#restrict-group-access-by-ip-address). NOTE: Registration is not yet required for participation, but may be added in a future milestone. @@ -67,7 +67,7 @@ Registration is not yet required for participation, but may be added in a future If enabled, version check informs you if a new version is available and the importance of it through a status. The status displays on the help pages (`/help`) -for all signed-in users, and on the Admin Area pages. The statuses are: +for all authenticated users, and on the Admin Area pages. The statuses are: - Green: You are running the latest version of GitLab. - Orange: An updated version of GitLab is available. diff --git a/doc/user/admin_area/settings/visibility_and_access_controls.md b/doc/user/admin_area/settings/visibility_and_access_controls.md index 4da0f5da3f4..5ca942a42bb 100644 --- a/doc/user/admin_area/settings/visibility_and_access_controls.md +++ b/doc/user/admin_area/settings/visibility_and_access_controls.md @@ -118,7 +118,7 @@ To set the default [visibility levels for new projects](../../public_access.md): 1. Select the desired default project visibility: - **Private** - Project access must be granted explicitly to each user. If this project is part of a group, access is granted to members of the group. - - **Internal** - The project can be accessed by any logged in user except external users. + - **Internal** - The project can be accessed by any authenticated user except external users. - **Public** - The project can be accessed without any authentication. 1. Select **Save changes**. @@ -146,7 +146,7 @@ To set the default visibility levels for new groups: 1. Expand the **Visibility and access controls** section. 1. Select the desired default group visibility: - **Private** - The group and its projects can only be viewed by members. - - **Internal** - The group and any internal projects can be viewed by any logged in user except external users. + - **Internal** - The group and any internal projects can be viewed by any authenticated user except external users. - **Public** - The group and any public projects can be viewed without any authentication. 1. Select **Save changes**. @@ -163,7 +163,7 @@ To restrict visibility levels for projects, snippets, and selected pages: 1. Expand the **Visibility and access controls** section. 1. In the **Restricted visibility levels** section, select the desired visibility levels to restrict. If you restrict the **Public** level: - - User profiles are only visible to logged in users via the Web interface. + - User profiles are only visible to authenticated users via the Web interface. - User attributes via the GraphQL API are: - Not visible in [GitLab 15.1 and later](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/88020). - Only visible to authenticated users between [GitLab 13.1](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/33195) and GitLab 15.0. @@ -192,7 +192,25 @@ To enable the export of 1. On the top bar, select **Main menu > Admin**. 1. On the left sidebar, select **Settings > General**. 1. Expand the **Visibility and access controls** section. -1. Select **Project export enabled**. +1. Scroll to **Project export**. +1. Select the **Enabled** checkbox. +1. Select **Save changes**. + +## Enable migration of groups and projects by direct transfer + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/383268) in GitLab 15.8. + +You can enable migration of groups by direct transfer. To also migrate projects with the groups, you must enable the +[`bulk_import_projects` feature flag](../../group/import/index.md#migrate-groups-by-direct-transfer-recommended). + +To enable migration of groups by direct transfer: + +1. Sign in to GitLab as a user with Administrator access level. +1. On the top bar, select **Main menu > Admin**. +1. On the left sidebar, select **Settings > General**. +1. Expand the **Visibility and access controls** section. +1. Scroll to **Allow migrating GitLab groups and projects by direct transfer**. +1. Select the **Enabled** checkbox. 1. Select **Save changes**. ## Configure enabled Git access protocols @@ -280,7 +298,7 @@ work in every repository. They can only be re-enabled by an administrator user o > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/87579) in GitLab 15.1 [with a flag](../../../administration/feature_flags.md) named `group_ip_restrictions_allow_global`. Disabled by default. > - [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/366445) in GitLab 15.4. [Feature flag `group_ip_restrictions_allow_global`](https://gitlab.com/gitlab-org/gitlab/-/issues/366445) removed. -Administrators can set IP address ranges to be combined with [group-level IP restrictions](../../group/access_and_permissions.md#restrict-access-to-groups-by-ip-address). +Administrators can set IP address ranges to be combined with [group-level IP restrictions](../../group/access_and_permissions.md#restrict-group-access-by-ip-address). Use globally-allowed IP addresses to allow aspects of the GitLab installation to work even when group-level IP address restrictions are set. |