1---
2stage: none
3group: unassigned
4info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
5type: reference
6---
7
8# GitLab Admin Area **(FREE SELF)**
9
10The Admin Area provides a web UI to manage and configure some features of GitLab
11self-managed instances. If you are an administrator, you can access the Admin Area
12by visiting `/admin` on your self-managed instance. You can also access it through
13the UI:
14
15- GitLab versions 14.0 and later: on the top bar, select **Menu > Admin**.
16- GitLab versions 13.12 and earlier: on the top bar, select the Admin Area icon (**{admin}**).
17
18NOTE:
19Only administrators can access the Admin Area.
20
21## Admin Area sections
22
23The Admin Area is made up of the following sections:
24
25| Section                                        | Description |
26|:-----------------------------------------------|:------------|
27| **{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). |
28| **{monitor}** Monitoring                       | View GitLab [system information](#system-information), and information on [background jobs](#background-jobs), [logs](#logs), [health checks](monitoring/health_check.md), [requests profiles](#requests-profiles), and [audit events](#audit-events). |
29| **{messages}** Messages                        | Send and manage [broadcast messages](broadcast_messages.md) for your users. |
30| **{hook}** System Hooks                        | Configure [system hooks](../../system_hooks/system_hooks.md) for many events. |
31| **{applications}** Applications                | Create system [OAuth applications](../../integration/oauth_provider.md) for integrations with other services. |
32| **{slight-frown}** Abuse Reports               | Manage [abuse reports](review_abuse_reports.md) submitted by your users. |
33| **{license}** License                          | Upload, display, and remove [licenses](license.md). |
34| **{cloud-gear}** Kubernetes                    | Create and manage instance-level [Kubernetes clusters](../instance/clusters/index.md). |
35| **{push-rules}** Push rules | Configure pre-defined Git [push rules](../../push_rules/push_rules.md) for projects. Also, configure [merge requests approvers rules](merge_requests_approvals.md). |
36| **{location-dot}** Geo                         | Configure and maintain [Geo nodes](geo_nodes.md). |
37| **{key}** Deploy keys                          | Create instance-wide [SSH deploy keys](../project/deploy_keys/index.md). |
38| **{lock}** Credentials                         | View [credentials](credentials_inventory.md) that can be used to access your instance. |
39| **{template}** Integrations                    | Manage [instance-level default settings](settings/project_integration_management.md) for a project integration. |
40| **{labels}** Labels                            | Create and maintain [labels](labels.md) for your GitLab instance. |
41| **{appearance}** Appearance                    | Customize [GitLab appearance](appearance.md). |
42| **{settings}** Settings                        | Modify the [settings](settings/index.md) for your GitLab instance. |
43
44## Admin Area dashboard
45
46The Dashboard provides statistics and system information about the GitLab instance.
47
48To access the Dashboard, either:
49
50- On the top bar, select **Menu > Admin**.
51- Visit `/admin` on your self-managed instance.
52
53The Dashboard is the default view of the Admin Area, and is made up of the following sections:
54
55| Section    | Description |
56|:-----------|:------------|
57| Projects   | The total number of projects, up to 10 of the latest projects, and the option of creating a new project. |
58| 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). |
59| Groups     | The total number of groups, up to 10 of the latest groups, and the option of creating a new group. |
60| Statistics | Totals of all elements of the GitLab instance. |
61| 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. |
62| Components | The major components of GitLab and the version number of each. A link to the Gitaly Servers is also included. |
63
64## Overview section
65
66The following topics document the **Overview** section of the Admin Area.
67
68### Administering Projects
69
70You can administer all projects in the GitLab instance from the Admin Area's Projects page.
71
72To access the Projects page:
73
741. On the top bar, select **Menu > Admin**.
751. On the left sidebar, select **Overview > Projects**.
761. Select the **All**, **Private**, **Internal**, or **Public** tab to list only
77   projects of that criteria.
78
79By default, all projects are listed, in reverse order of when they were last updated. For each
80project, the following information is listed:
81
82- Name.
83- Namespace.
84- Description.
85- Size, updated every 15 minutes at most.
86
87Projects can be edited or deleted.
88
89The list of projects can be sorted by:
90
91- Name.
92- Last created.
93- Oldest created.
94- Last updated.
95- Oldest updated.
96- Owner.
97
98A user can choose to hide or show archived projects in the list.
99
100In the **Filter by name** field, type the project name you want to find, and GitLab filters
101them as you type.
102
103Select from the **Namespace** dropdown to filter only projects in that namespace.
104
105You can combine the filter options. For example, to list only public projects with `score` in their name:
106
1071. Click the **Public** tab.
1081. Enter `score` in the **Filter by name...** input box.
109
110#### Projects pending deletion **(PREMIUM SELF)**
111
112> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/37014) in GitLab 13.3.
113> - [Tab renamed](https://gitlab.com/gitlab-org/gitlab/-/issues/347468) from **Deleted projects** in GitLab 14.7.
114
115When delayed project deletion is [enabled for a group](../group/index.md#enable-delayed-project-deletion),
116projects within that group are not deleted immediately, but only after a delay. To access a list of all projects that are pending deletion:
117
1181. On the top bar, select **Menu > Projects > Explore projects**.
1191. Select the **Pending deletion** tab (in GitLab 14.7 and later) or the **Deleted projects** tab (GitLab 14.6 and earlier).
120
121Listed for each project is:
122
123- The time the project was marked for deletion.
124- The time the project is scheduled for final deletion.
125- A **Restore** link to stop the project being eventually deleted.
126
127### Administering Users
128
129You can administer all users in the GitLab instance from the Admin Area's Users page:
130
1311. On the top bar, select **Menu > Admin**.
1321. On the left sidebar, select **Overview > Users**.
133
134To list users matching a specific criteria, click on one of the following tabs on the **Users** page:
135
136- **Active**
137- **Admins**
138- **2FA Enabled**
139- **2FA Disabled**
140- **External**
141- **[Blocked](moderate_users.md#block-a-user)**
142- **[Deactivated](moderate_users.md#deactivate-a-user)**
143- **Without projects**
144
145For each user, the following are listed:
146
1471. Username
1481. Email address
1491. Project membership count
1501. Group membership count ([introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/276215) in GitLab 13.12)
1511. Date of account creation
1521. Date of last activity
153
154To edit a user, click the **Edit** button in that user's
155row. To delete the user, or delete the user and their contributions, click the cog dropdown in
156that user's row, and select the desired option.
157
158To change the sort order:
159
1601. Click the sort dropdown.
1611. Select the desired order.
162
163By default the sort dropdown shows **Name**.
164
165To search for users, enter your criteria in the search field. The user search is case
166insensitive, and applies partial matching to name and username. To search for an email address,
167you must provide the complete email address.
168
169#### User impersonation
170
171An administrator can "impersonate" any other user, including other administrators.
172This allows the administrator to "see what the user sees," and take actions on behalf of the user.
173You can impersonate a user in the following ways:
174
175- Through the UI:
176  1. On the top bar, select **Menu > Admin**.
177  1. On the left sidebar, select **Overview > Users**.
178  1. From the list of users, select a user.
179  1. Select **Impersonate**.
180- With the API, using [impersonation tokens](../../api/index.md#impersonation-tokens).
181
182All impersonation activities are [captured with audit events](../../administration/audit_events.md#impersonation-data).
183
184By default, impersonation is enabled. GitLab can be configured to [disable impersonation](../../api/index.md#disable-impersonation).
185
186![user impersonation button](img/impersonate_user_button_v13_8.png)
187
188#### User Permission Export **(PREMIUM SELF)**
189
190> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/1772) in GitLab 13.8.
191> - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/issues/292436) in GitLab 13.9.
192
193An administrator can export user permissions for all users in the GitLab instance from the Admin Area's Users page.
194The export lists direct membership the users have in groups and projects.
195
196The following data is included in the export:
197
198- Username
199- Email
200- Type
201- Path
202- Access level ([Project](../permissions.md#project-members-permissions) and [Group](../permissions.md#group-members-permissions))
203- Date of last activity ([introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/345388) in GitLab 14.6). For a list of activities that populate this column, see the [Users API documentation](../../api/users.md#get-user-activities-admin-only).
204
205![user permission export button](img/export_permissions_v13_11.png)
206
207#### Users statistics
208
209The **Users statistics** page provides an overview of user accounts by role. These statistics are
210calculated daily, so user changes made since the last update are not reflected.
211
212The following totals are also included:
213
214- Billable users
215- Blocked users
216- Total users
217
218GitLab billing is based on the number of [**Billable users**](../../subscriptions/self_managed/index.md#billable-users).
219
220#### Add email to user
221
222You must be an administrator to manually add emails to users:
223
2241. On the top bar, select **Menu > Admin**.
2251. On the left sidebar, select **Overview > Users** (`/admin/users`).
2261. Locate the user and select them.
2271. Select **Edit**.
2281. In **Email**, enter the new email address. This adds the new email address to the
229   user and sets the previous email address to be a secondary.
2301. Select **Save changes**.
231
232### User cohorts
233
234The [Cohorts](user_cohorts.md) tab displays the monthly cohorts of new users and their activities over time.
235
236### Administering Groups
237
238You can administer all groups in the GitLab instance from the Admin Area's Groups page.
239
240To access the Groups page:
241
2421. On the top bar, select **Menu > Admin**.
2431. On the left sidebar, select **Overview > Groups**.
244
245For each group, the page displays their name, description, size, number of projects in the group,
246number of members, and whether the group is private, internal, or public. To edit a group, click
247the **Edit** button in that group's row. To delete the group, click the **Delete** button in
248that group's row.
249
250To change the sort order, click the sort dropdown and select the desired order. The default
251sort order is by **Last created**.
252
253To search for groups by name, enter your criteria in the search field. The group search is case
254insensitive, and applies partial matching.
255
256To [Create a new group](../group/index.md#create-a-group) click **New group**.
257
258### Administering Topics
259
260> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/340920) in GitLab 14.4.
261
262You can administer all [topics](../project/working_with_projects.md#explore-topics) in the
263GitLab instance from the Admin Area's Topics page.
264
265To access the Topics page:
266
2671. On the top bar, select **Menu > Admin**.
2681. On the left sidebar, select **Overview > Topics**.
269
270For each topic, the page displays its name and the number of projects labeled with the topic.
271
272To create a new topic, select **New topic**.
273
274To edit a topic, select **Edit** in that topic's row.
275
276To search for topics by name, enter your criteria in the search box. The topic search is case
277insensitive and applies partial matching.
278
279NOTE:
280The assigned topics are visible only to everyone with access to the project,
281but everyone can see which topics exist at all on the GitLab instance.
282Do not include sensitive information in the name of a topic.
283
284### Administering Jobs
285
286You can administer all jobs in the GitLab instance from the Admin Area's Jobs page.
287
288To access the Jobs page:
289
2901. On the top bar, select **Menu > Admin**.
2911. On the left sidebar, select **Overview > Jobs**. All jobs are listed, in descending order of job ID.
2921. Click the **All** tab to list all jobs. Click the **Pending**, **Running**, or **Finished**
293   tab to list only jobs of that status.
294
295For each job, the following details are listed:
296
297| Field    | Description |
298|----------|-------------|
299| Status   | Job status, either **passed**, **skipped**, or **failed**.              |
300| Job      | Includes links to the job, branch, and the commit that started the job. |
301| Pipeline | Includes a link to the specific pipeline.                               |
302| Project  | Name of the project, and organization, to which the job belongs.        |
303| Runner   | Name of the CI runner assigned to execute the job.                      |
304| Stage    | Stage that the job is declared in a `.gitlab-ci.yml` file.              |
305| Name     | Name of the job specified in a `.gitlab-ci.yml` file.                   |
306| Timing   | Duration of the job, and how long ago the job completed.                |
307| Coverage | Percentage of tests coverage.                                           |
308
309### Administering runners
310
311You can administer all runners in the GitLab instance from the Admin Area's **Runners** page. See
312[GitLab Runner](https://docs.gitlab.com/runner/) for more information.
313
314To access the **Runners** page:
315
3161. On the top bar, select **Menu > Admin**.
3171. On the left sidebar, select **Overview > Runners**.
318
319The **Runners** page features:
320
321- A description of runners and their possible states.
322- Instructions on installing a runner.
323- A list of all registered runners.
324
325Runners are listed in descending order by the date they were created, by default. You can change
326the sort order to *Last Contacted* from the dropdown beside the search field.
327
328To search runners' descriptions:
329
3301. In the **Search or filter results...** field, type the description of the runner you want to
331   find.
3321. Press Enter.
333
334You can also filter runners by status, type, and tag. To filter:
335
3361. Select a tab or the **Search or filter results...** field.
3371. Select any **Type**, or filter by **Status** or **Tags**.
3381. Select or enter your search criteria.
339
340![Attributes of a runner, with the **Search or filter results...** field active](img/index_runners_search_or_filter_v14_5.png)
341
342For each runner, the following attributes are listed:
343
344| Attribute    | Description |
345|--------------|-------------|
346| Type/State   | One or more of the following states: shared, group, specific, locked, or paused |
347| Runner token | Partial token used to identify the runner, and which the runner uses to communicate with the GitLab instance |
348| Runner ID    | Numerical ID of the runner |
349| Description  | Description given to the runner |
350| Version      | GitLab Runner version |
351| IP address   | IP address of the host on which the runner is registered |
352| Projects     | Number of projects to which the runner is assigned |
353| Jobs         | Total of jobs run by the runner |
354| Tags         | Tags associated with the runner |
355| Last contact | Timestamp indicating when the runner last contacted the GitLab instance |
356
357You can also edit, pause, or remove each runner.
358
359### Administering Gitaly servers
360
361You can list all Gitaly servers in the GitLab instance from the Admin Area's **Gitaly Servers**
362page. For more details, see [Gitaly](../../administration/gitaly/index.md).
363
364To access the **Gitaly Servers** page:
365
3661. On the top bar, select **Menu > Admin**.
3671. On the left sidebar, select **Overview > Gitaly Servers**.
368
369For each Gitaly server, the following details are listed:
370
371| Field          | Description |
372|----------------|-------------|
373| Storage        | Repository storage |
374| Address        | Network address on which the Gitaly server is listening |
375| Server version | Gitaly version |
376| Git version    | Version of Git installed on the Gitaly server |
377| Up to date     | Indicates if the Gitaly server version is the latest version available. A green dot indicates the server is up to date. |
378
379## Monitoring section
380
381The following topics document the **Monitoring** section of the Admin Area.
382
383### System Information
384
385The **System Info** page provides the following statistics:
386
387| Field        | Description |
388|:-------------|:------------|
389| CPU          | Number of CPU cores available |
390| Memory Usage | Memory in use, and total memory available |
391| Disk Usage   | Disk space in use, and total disk space available |
392| Uptime       | Approximate uptime of the GitLab instance |
393
394These statistics are updated only when you navigate to the **System Info** page, or you refresh the page in your browser.
395
396### Background Jobs
397
398The **Background Jobs** page displays the Sidekiq dashboard. Sidekiq is used by GitLab to
399perform processing in the background.
400
401The Sidekiq dashboard consists of the following elements:
402
403- A tab per jobs' status.
404- A breakdown of background job statistics.
405- A live graph of **Processed** and **Failed** jobs, with a selectable polling interval.
406- An historical graph of **Processed** and **Failed** jobs, with a selectable time span.
407- Redis statistics, including:
408  - Version number
409  - Uptime, measured in days
410  - Number of connections
411  - Current memory usage, measured in MB
412  - Peak memory usage, measured in MB
413
414### Logs
415
416Since GitLab 13.0, **Log** view has been removed from the Admin Area dashboard since the logging does not work in multi-node setups and could cause confusion for administrators by displaying partial information.
417
418For multi-node systems we recommend ingesting the logs into services like Elasticsearch and Splunk.
419
420| Log file                | Contents |
421|:------------------------|:---------|
422| `application.log`       | GitLab user activity |
423| `git_json.log`          | Failed GitLab interaction with Git repositories |
424| `production.log`        | Requests received from Puma, and the actions taken to serve those requests |
425| `sidekiq.log`           | Background jobs |
426| `repocheck.log`         | Repository activity |
427| `integrations_json.log` | Activity between GitLab and integrated systems |
428| `kubernetes.log`        | Kubernetes activity |
429
430The contents of these log files can be useful when troubleshooting a problem.
431
432For details of these log files and their contents, see [Log system](../../administration/logs.md).
433
434The content of each log file is listed in chronological order. To minimize performance issues, a maximum 2000 lines of each log file are shown.
435
436### Requests Profiles
437
438The **Requests Profiles** page contains the token required for profiling. For more details, see [Request Profiling](../../administration/monitoring/performance/request_profiling.md).
439
440### Audit Events **(PREMIUM SELF)**
441
442The **Audit Events** page lists changes made within the GitLab server. With this information you can control, analyze, and track every change.
443