diff options
Diffstat (limited to 'doc/user/admin_area/index.md')
| -rw-r--r-- | doc/user/admin_area/index.md | 141 |
1 files changed, 52 insertions, 89 deletions
diff --git a/doc/user/admin_area/index.md b/doc/user/admin_area/index.md index 71c2468c97f..a59501f14ce 100644 --- a/doc/user/admin_area/index.md +++ b/doc/user/admin_area/index.md @@ -7,72 +7,24 @@ type: reference # GitLab Admin Area **(FREE SELF)** -The Admin Area provides a web UI to manage and configure some features of GitLab -self-managed instances. If you are an administrator, you can access the Admin Area -by visiting `/admin` on your self-managed instance. You can also access it through -the UI: +The Admin Area provides a web UI to manage and configure features of GitLab +self-managed instances. If you are an administrator,to access the Admin Area: -- GitLab versions 14.0 and later: on the top bar, select **Main menu > Admin**. -- GitLab versions 13.12 and earlier: on the top bar, select the Admin Area icon (**{admin}**). +- In GitLab 16.1 and later: on the left sidebar, expand the top-most chevron (**{chevron-down}**), then select **Admin Area**. +- In GitLab 16.0 and earlier: on the top bar, select **Main menu > Admin**. NOTE: Only administrators can access the Admin Area. -## Admin Area sections - -The Admin Area is made up of the following sections: - -| Section | Description | -|:-----------------------------------------------|:------------| -| **{overview}** [Overview](#overview-section) | View your GitLab [Dashboard](#admin-area-dashboard), and administer [projects](#administering-projects), [users](#administering-users), [groups](#administering-groups), [topics](#administering-topics), [jobs](#administering-jobs), [runners](#administering-runners), and [Gitaly servers](#administering-gitaly-servers). | -| **{monitor}** Monitoring | View GitLab [system information](#system-information), and information on [background jobs](#background-jobs), [logs](#logs), [health checks](monitoring/health_check.md), and [audit events](#audit-events). | -| **{messages}** Messages | Send and manage [broadcast messages](broadcast_messages.md) for your users. | -| **{hook}** System Hooks | Configure [system hooks](../../administration/system_hooks.md) for many events. | -| **{applications}** Applications | Create system [OAuth applications](../../integration/oauth_provider.md) for integrations with other services. | -| **{slight-frown}** Abuse Reports | Manage [abuse reports](review_abuse_reports.md) submitted by your users. | -| **{license}** License | Add, display, and remove [licenses](license.md). | -| **{cloud-gear}** Kubernetes | Create and manage instance-level [Kubernetes clusters](../instance/clusters/index.md). | -| **{push-rules}** Push rules | Configure pre-defined Git [push rules](../project/repository/push_rules.md) for projects. Also, configure [merge requests approvers rules](merge_requests_approvals.md). | -| **{location-dot}** Geo | Configure and maintain [Geo sites](geo_sites.md). | -| **{key}** Deploy keys | Create instance-wide [SSH deploy keys](../project/deploy_keys/index.md). | -| **{lock}** Credentials | View [credentials](credentials_inventory.md) that can be used to access your instance. | -| **{template}** Integrations | Manage [instance-level default settings](settings/project_integration_management.md) for a project integration. | -| **{labels}** Labels | Create and maintain [labels](labels.md) for your GitLab instance. | -| **{appearance}** Appearance | Customize [GitLab appearance](appearance.md). | -| **{settings}** Settings | Modify the [settings](settings/index.md) for your GitLab instance. | - -## Admin Area dashboard - -The Dashboard provides statistics and system information about the GitLab instance. - -To access the Dashboard, either: - -- On the top bar, select **Main menu > Admin**. -- Visit `/admin` on your self-managed instance. - -The Dashboard is the default view of the Admin Area, and is made up of the following sections: - -| Section | Description | -|:-----------|:------------| -| Projects | The total number of projects, up to 10 of the latest projects, and the option of creating a new project. | -| Users | The total number of users, up to 10 of the latest users, the option of creating a new user, and a link to [**Users statistics**](#users-statistics). | -| Groups | The total number of groups, up to 10 of the latest groups, and the option of creating a new group. | -| Statistics | Totals of all elements of the GitLab instance. | -| Features | All features available on the GitLab instance. Enabled features are marked with a green circle icon, and disabled features are marked with a power icon. | -| Components | The major components of GitLab and the version number of each. A link to the Gitaly Servers is also included. | - -## Overview section - -The following topics document the **Overview** section of the Admin Area. - -### Administering Projects +## Administering projects You can administer all projects in the GitLab instance from the Admin Area's Projects page. To access the Projects page: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Overview > Projects**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Overview > Projects**. 1. Select the **All**, **Private**, **Internal**, or **Public** tab to list only projects of that criteria. @@ -118,12 +70,13 @@ You can combine the filter options. For example, to list only public projects wi 1. Select the **Public** tab. 1. Enter `score` in the **Filter by name...** input box. -### Administering Users +## Administering users You can administer all users in the GitLab instance from the Admin Area's Users page: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Overview > Users**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Overview > Users**. To list users matching a specific criteria, select one of the following tabs on the **Users** page: @@ -159,14 +112,15 @@ To search for users, enter your criteria in the search field. The user search is insensitive, and applies partial matching to name and username. To search for an email address, you must provide the complete email address. -#### User impersonation +### User impersonation An administrator can "impersonate" any other user, including other administrators. This allows the administrator to "see what the user sees," and take actions on behalf of the user. You can impersonate a user in the following ways: - Through the UI: - 1. On the top bar, select **Main menu > Admin**. + 1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). + 1. Select **Admin Area**. 1. On the left sidebar, select **Overview > Users**. 1. From the list of users, select a user. 1. Select **Impersonate**. @@ -178,21 +132,22 @@ By default, impersonation is enabled. GitLab can be configured to [disable imper  -#### User identities +### User identities > The ability to see a user's SCIM identity was [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/294608) in GitLab 15.3. When using authentication providers, administrators can see the identities for a user: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Overview > Users**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Overview > Users**. 1. From the list of users, select a user. 1. Select **Identities**. This list shows the user's identities, including SCIM identities. Administrators can use this information to troubleshoot SCIM-related issues and confirm the identities being used for an account. -#### User Permission Export **(PREMIUM SELF)** +### User Permission Export **(PREMIUM SELF)** > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/1772) in GitLab 13.8. > - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/issues/292436) in GitLab 13.9. @@ -213,7 +168,7 @@ Only the first 100,000 user accounts are exported.  -#### Users statistics +### Users statistics The **Users statistics** page provides an overview of user accounts by role. These statistics are calculated daily, so user changes made since the last update are not reflected. @@ -226,28 +181,30 @@ The following totals are also included: GitLab billing is based on the number of [**Billable users**](../../subscriptions/self_managed/index.md#billable-users). -#### Add email to user +### Add email to user You must be an administrator to manually add emails to users: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Overview > Users** (`/admin/users`). +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Overview > Users**. 1. Locate the user and select them. 1. Select **Edit**. 1. In **Email**, enter the new email address. This adds the new email address to the user and sets the previous email address to be a secondary. 1. Select **Save changes**. -### User cohorts +## User cohorts The [Cohorts](user_cohorts.md) tab displays the monthly cohorts of new users and their activities over time. -### Prevent a user from creating groups +## Prevent a user from creating groups By default, users can create groups. To prevent a user from creating a top level group: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Overview > Users** (`/admin/users`). +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Overview > Users**. 1. Locate the user and select them. 1. Select **Edit**. 1. Clear the **Can create group** checkbox. @@ -255,14 +212,15 @@ By default, users can create groups. To prevent a user from creating a top level It is also possible to [limit which roles can create a subgroup within a group](../group/subgroups/index.md#change-who-can-create-subgroups). -### Administering Groups +## Administering groups You can administer all groups in the GitLab instance from the Admin Area's Groups page. To access the Groups page: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Overview > Groups**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. 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, in the group's row, select **Edit**. To delete the group, in the group's row, select **Delete**. @@ -273,9 +231,9 @@ sort order is by **Last created**. To search for groups by name, enter your criteria in the search field. The group search is case insensitive, and applies partial matching. -To [Create a new group](../group/manage.md#create-a-group) select **New group**. +To [Create a new group](../group/index.md#create-a-group) select **New group**. -### Administering Topics +## Administering topics - > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/340920) in GitLab 14.4. - > Merging topics [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/366884) in GitLab 15.5. @@ -286,8 +244,9 @@ You can administer all topics in the GitLab instance from the Admin Area's Topic To access the Topics page: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Overview > Topics**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Overview > Topics**. For each topic, the page displays its name and the number of projects labeled with the topic. @@ -307,15 +266,16 @@ 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 Gitaly servers +## Administering Gitaly servers 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 **Gitaly Servers** page: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Overview > Gitaly Servers**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Overview > Gitaly Servers**. For each Gitaly server, the following details are listed: @@ -338,8 +298,9 @@ You can administer all runners in the GitLab instance from the Admin Area's **Ru To access the **Runners** page: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Overview > Runners**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Overview > Runners**. #### Search and filter runners @@ -364,8 +325,9 @@ You can also filter runners by status, type, and tag. To filter: You can delete multiple runners at the same time. -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Overview > Runners**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Overview > Runners**. 1. To the left of the runners you want to delete, select the checkbox. To select all of the runners on the page, select the checkbox above the list. @@ -394,8 +356,9 @@ You can administer all jobs in the GitLab instance from the Admin Area's Jobs pa To access the Jobs page: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **CI/CD > Jobs**. All jobs are listed, in descending order of job ID. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. 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. |