gitlab-org--gitlab-foss/doc/user/admin_area/index.md
2019-05-29 19:40:10 +00:00

7.8 KiB

type
reference

GitLab Admin Area [CORE ONLY]

The Admin Area provides a web UI for administering some features of GitLab self-managed instances.

To access the Admin Area, either:

  • Click the Admin Area icon (the spanner or wrench icon).
  • Visit /admin on your self-managed instance.

NOTE: Note: Only admin users can access the Admin Area.

Admin Area sections

The Admin Area is made up of the following sections:

Section Description
Overview View your GitLab Dashboard, and administer projects, users, groups, jobs, runners, and Gitaly servers.
Monitoring View GitLab system information, and information on background jobs, logs, health checks, request profiles, and audit logs.
Messages Send and manage broadcast messages for your users.
System Hooks Configure system hooks for many events.
Applications Create system OAuth applications for integrations with other services.
Abuse Reports Manage abuse reports submitted by your users.
License [STARTER ONLY] Upload, display, and remove licenses.
Push Rules [STARTER] Configure pre-defined git push rules for projects.
Geo [PREMIUM ONLY] Configure and maintain Geo nodes.
Deploy Keys Create instance-wide SSH deploy keys.
Service Templates Create service templates for projects.
Labels Create and maintain labels for your GitLab instance.
Appearance Customize GitLab's appearance.
Settings Modify the settings for your GitLab instance.

Admin Dashboard

The Dashboard provides statistics and system information about the GitLab instance.

To access the Dashboard, either:

  • Click the Admin Area icon (the wrench icon).
  • 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, and the option of creating a new user.
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.

Administer Projects

You can administer all projects in the GitLab instance from the Admin Area's Projects page.

To access the Projects page, go to Admin Area > Overview > Projects.

Click the All, Private, Internal, or Public tab to list only projects of that criteria.

By default, all projects are listed, in reverse order of when they were last updated. For each project, the following information is listed:

  • Name.
  • Namespace.
  • Description.
  • Size, updated every 15 minutes at most.

Projects can be edited or deleted.

The list of projects can be sorted by:

  • Name.
  • Last created.
  • Oldest created.
  • Last updated.
  • Oldest updated.
  • Owner.

A user can choose to hide or show archived projects in the list.

In the Filter by name field, type the project name you want to find, and GitLab will filter them as you type.

Select from the Namespace dropdown to filter only projects in that namespace.

You can combine the filter options. For example, to list only public projects with score in their name:

  1. Click the Public tab.
  2. Enter score in the Filter by name... input box.

Administer Users

You can administer all users in the GitLab instance from the Admin Area's Users page.

To access the Users page, go to Admin Area > Overview > Users.

Click the Active, Admins, 2FA Enabled, or 2FA Disabled, External, or Without projects tab to list only users of that criteria.

For each user, their username, email address, are listed, also the date their account was created and the date of last activity. To edit a user, click the Edit button in that user's row. To delete the user, or delete the user and their contributions, click the cog dropdown in that user's row, and select the desired option.

To change the sort order, click the sort dropdown and select the desired order. By default the sort dropdown shows Name.

To search for users, enter your criteria in the search field. The user search is case insensitive, and applies partial matching to name and username. To search for an email address, you must provide the complete email address.

Administer Jobs

You can administer all jobs in the GitLab instance from the Admin Area's Jobs page.

To access the Jobs page, go to Admin Area > Overview > Jobs.

All jobs are listed, in reverse order of their job ID.

Click the All tab to list all jobs. Click the Pending, Running, or Finished tab to list only jobs of that status.

For each job, 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.