Commit b5261c3c authored by Evan Read's avatar Evan Read

Merge branch '333279-aqualls-admin-area' into 'master'

Update unowned docs for Admin Area instrx, 1 of 2

See merge request gitlab-org/gitlab!63932
parents fe43d098 25a764ae
...@@ -103,7 +103,6 @@ Learn how to install, configure, update, and maintain your GitLab instance. ...@@ -103,7 +103,6 @@ Learn how to install, configure, update, and maintain your GitLab instance.
- [GitLab in maintenance mode](maintenance_mode/index.md): Put GitLab in maintenance mode. - [GitLab in maintenance mode](maintenance_mode/index.md): Put GitLab in maintenance mode.
- [Update GitLab](../update/index.md): Update guides to upgrade your installation to a new version. - [Update GitLab](../update/index.md): Update guides to upgrade your installation to a new version.
- [Upgrading without downtime](../update/index.md#upgrading-without-downtime): Upgrade to a newer major, minor, or patch version of GitLab without taking your GitLab instance offline. - [Upgrading without downtime](../update/index.md#upgrading-without-downtime): Upgrade to a newer major, minor, or patch version of GitLab without taking your GitLab instance offline.
- [Migrate your GitLab CI/CD data to another version of GitLab](../migrate_ci_to_ce/README.md): If you have an old GitLab installation (older than 8.0), follow this guide to migrate your existing GitLab CI/CD data to another version of GitLab.
### Upgrading or downgrading GitLab ### Upgrading or downgrading GitLab
......
This diff is collapsed.
...@@ -44,11 +44,13 @@ private network are forbidden by default. That means that all requests made ...@@ -44,11 +44,13 @@ private network are forbidden by default. That means that all requests made
to `127.0.0.1`, `::1` and `0.0.0.0`, as well as IPv4 `10.0.0.0/8`, `172.16.0.0/12`, to `127.0.0.1`, `::1` and `0.0.0.0`, as well as IPv4 `10.0.0.0/8`, `172.16.0.0/12`,
`192.168.0.0/16` and IPv6 site-local (`ffc0::/10`) addresses aren't allowed. `192.168.0.0/16` and IPv6 site-local (`ffc0::/10`) addresses aren't allowed.
This behavior can be overridden by enabling the option *"Allow requests to the This behavior can be overridden:
local network from web hooks and services"* in the *"Outbound requests"* section
inside the **Admin Area > Settings** (`/admin/application_settings/network`):
![Outbound requests admin settings](img/outbound_requests_section_v12_2.png) 1. On the top bar, select **Menu >** **{admin}** **Admin**.
1. In the left sidebar, select **Settings > Network**.
1. Expand the **Outbound requests** section:
![Outbound requests admin settings](img/outbound_requests_section_v12_2.png)
1. Select **Allow requests to the local network from web hooks and services**.
NOTE: NOTE:
*System hooks* are enabled to make requests to local network by default since they are *System hooks* are enabled to make requests to local network by default since they are
...@@ -61,10 +63,13 @@ set up by administrators. However, you can turn this off by disabling the ...@@ -61,10 +63,13 @@ set up by administrators. However, you can turn this off by disabling the
You can allow certain domains and IP addresses to be accessible to both *system hooks* You can allow certain domains and IP addresses to be accessible to both *system hooks*
and *webhooks* even when local requests are not allowed by adding them to the and *webhooks* even when local requests are not allowed by adding them to the
allowlist. Navigate to **Admin Area > Settings > Network** (`/admin/application_settings/network`) allowlist:
and expand **Outbound requests**:
![Outbound local requests allowlist](img/allowlist_v13_0.png) 1. On the top bar, select **Menu >** **{admin}** **Admin**.
1. In the left sidebar, select **Settings > Network** (`/admin/application_settings/network`)
and expand **Outbound requests**:
![Outbound local requests allowlist](img/allowlist_v13_0.png)
The allowed entries can be separated by semicolons, commas or whitespaces The allowed entries can be separated by semicolons, commas or whitespaces
(including newlines) and be in different formats like hostnames, IP addresses and/or (including newlines) and be in different formats like hostnames, IP addresses and/or
......
...@@ -52,7 +52,7 @@ for Push and Tag events, but we never display commits. ...@@ -52,7 +52,7 @@ for Push and Tag events, but we never display commits.
To create a system hook: To create a system hook:
1. In the top navigation bar, go to **{admin}** **Admin Area**. 1. On the top bar, select **Menu >** **{admin}** **Admin**.
1. In the left sidebar, select **System Hooks**. 1. In the left sidebar, select **System Hooks**.
1. Provide the **URL** and **Secret Token**. 1. Provide the **URL** and **Secret Token**.
1. Select the check box next to each **Trigger** you want to enable. 1. Select the check box next to each **Trigger** you want to enable.
......
...@@ -22,8 +22,9 @@ For information about email notifications originating from GitLab, read ...@@ -22,8 +22,9 @@ For information about email notifications originating from GitLab, read
## Sending emails to users from within GitLab ## Sending emails to users from within GitLab
1. Navigate to the **Admin Area > Overview > Users** and press the 1. On the top bar, select **Menu >** **{admin}** **Admin**.
**Send email to users** button. 1. In the left sidebar, select **Overview > Users**.
1. Select **Send email to users**.
![admin users](email1.png) ![admin users](email1.png)
......
...@@ -12,7 +12,10 @@ The DevOps Report gives you an overview of your entire instance's adoption of ...@@ -12,7 +12,10 @@ The DevOps Report gives you an overview of your entire instance's adoption of
[Concurrent DevOps](https://about.gitlab.com/topics/concurrent-devops/) [Concurrent DevOps](https://about.gitlab.com/topics/concurrent-devops/)
from planning to monitoring. from planning to monitoring.
To see DevOps Report, go to **Admin Area > Analytics > DevOps Report**. To see DevOps Report:
1. On the top bar, select **Menu >** **{admin}** **Admin**.
1. In the left sidebar, select **Analytics > DevOps Report**.
## DevOps Score ## DevOps Score
......
...@@ -8,7 +8,10 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -8,7 +8,10 @@ info: To determine the technical writer assigned to the Stage/Group associated w
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/41416) in GitLab 11.2. > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/41416) in GitLab 11.2.
Administrators have access to instance-wide analytics, as shown in **Admin Area > Analytics**. Administrators have access to instance-wide analytics:
1. On the top bar, select **Menu >** **{admin}** **Admin**.
1. In the left sidebar, select **Analytics**.
There are several kinds of statistics: There are several kinds of statistics:
......
...@@ -9,8 +9,10 @@ disqus_identifier: 'https://docs.gitlab.com/ee/customization/branded_login_page. ...@@ -9,8 +9,10 @@ disqus_identifier: 'https://docs.gitlab.com/ee/customization/branded_login_page.
# GitLab Appearance **(FREE SELF)** # GitLab Appearance **(FREE SELF)**
There are several options for customizing the appearance of a self-managed instance There are several options for customizing the appearance of a self-managed instance
of GitLab. These settings are accessed from the **Admin Area** in the **Settings > Appearance** of GitLab. To access these settings:
section.
1. On the top bar, select **Menu >** **{admin}** **Admin**.
1. In the left sidebar, select **Settings > Appearance**.
## Navigation bar ## Navigation bar
......
...@@ -47,7 +47,7 @@ The Dashboard provides statistics and system information about the GitLab instan ...@@ -47,7 +47,7 @@ The Dashboard provides statistics and system information about the GitLab instan
To access the Dashboard, either: To access the Dashboard, either:
- Click the Admin Area icon (**{admin}**). - On the top bar, select **Menu >** **{admin}** **Admin**.
- Visit `/admin` on your self-managed instance. - 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: The Dashboard is the default view of the Admin Area, and is made up of the following sections:
...@@ -69,10 +69,12 @@ The following topics document the **Overview** section of the Admin Area. ...@@ -69,10 +69,12 @@ The following topics document the **Overview** section of the Admin Area.
You can administer all projects in the GitLab instance from the Admin Area's Projects page. 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**. To access the Projects page:
Click the **All**, **Private**, **Internal**, or **Public** tab to list only projects of that 1. On the top bar, select **Menu >** **{admin}** **Admin**.
criteria. 1. In the left sidebar, select **Overview > Projects**.
1. Select 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 By default, all projects are listed, in reverse order of when they were last updated. For each
project, the following information is listed: project, the following information is listed:
...@@ -107,9 +109,10 @@ You can combine the filter options. For example, to list only public projects wi ...@@ -107,9 +109,10 @@ You can combine the filter options. For example, to list only public projects wi
### Administering Users ### Administering Users
You can administer all users in the GitLab instance from the Admin Area's Users page. 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**. 1. On the top bar, select **Menu >** **{admin}** **Admin**.
1. In the left sidebar, select **Overview > Users**.
To list users matching a specific criteria, click on one of the following tabs on the **Users** page: To list users matching a specific criteria, click on one of the following tabs on the **Users** page:
...@@ -152,7 +155,11 @@ An administrator can "impersonate" any other user, including other administrator ...@@ -152,7 +155,11 @@ An administrator can "impersonate" any other user, including other administrator
This allows the administrator to "see what the user sees," and take actions on behalf of the user. 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: You can impersonate a user in the following ways:
- Through the UI, by selecting **Admin Area > Overview > Users > Select a user > Impersonate**. - Through the UI:
1. On the top bar, select **Menu >** **{admin}** **Admin**.
1. In the left sidebar, select **Overview > Users**.
1. From the list of users, select a user.
1. Select **Impersonate**.
- With the API, using [impersonation tokens](../../api/README.md#impersonation-tokens). - With the API, using [impersonation tokens](../../api/README.md#impersonation-tokens).
All impersonation activities are [captured with audit events](../../administration/audit_events.md#impersonation-data). All impersonation activities are [captured with audit events](../../administration/audit_events.md#impersonation-data).
...@@ -198,7 +205,10 @@ The [Cohorts](user_cohorts.md) tab displays the monthly cohorts of new users and ...@@ -198,7 +205,10 @@ The [Cohorts](user_cohorts.md) tab displays the monthly cohorts of new users and
You can administer all groups in the GitLab instance from the Admin Area's Groups page. You can administer all groups in the GitLab instance from the Admin Area's Groups page.
To access the Groups page, go to **Admin Area > Overview > Groups**. To access the Groups page:
1. On the top bar, select **Menu >** **{admin}** **Admin**.
1. In the left sidebar, select **Overview > Groups**.
For each group, the page displays their name, description, size, number of projects in the group, 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, click number of members, and whether the group is private, internal, or public. To edit a group, click
...@@ -217,11 +227,12 @@ To [Create a new group](../group/index.md#create-a-group) click **New group**. ...@@ -217,11 +227,12 @@ To [Create a new group](../group/index.md#create-a-group) click **New group**.
You can administer all jobs in the GitLab instance from the Admin Area's Jobs page. 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**. To access the Jobs page:
All jobs are listed, in descending order of job ID.
Click the **All** tab to list all jobs. Click the **Pending**, **Running**, or **Finished** tab to list only jobs of that status. 1. On the top bar, select **Menu >** **{admin}** **Admin**.
1. In the left sidebar, select **Overview > Jobs**. All jobs are listed, in descending order of job ID.
1. 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: For each job, the following details are listed:
...@@ -242,7 +253,10 @@ For each job, the following details are listed: ...@@ -242,7 +253,10 @@ For each job, the following details are listed:
You can administer all runners in the GitLab instance from the Admin Area's **Runners** page. See 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. [GitLab Runner](https://docs.gitlab.com/runner/) for more information.
To access the **Runners** page, go to **Admin Area > Overview > Runners**. To access the **Runners** page:
1. On the top bar, select **Menu >** **{admin}** **Admin**.
1. In the left sidebar, select **Overview > Runners**.
The **Runners** page features: The **Runners** page features:
...@@ -288,7 +302,10 @@ You can also edit, pause, or remove each runner. ...@@ -288,7 +302,10 @@ You can also edit, pause, or remove each runner.
You can list all Gitaly servers in the GitLab instance from the Admin Area's **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). page. For more details, see [Gitaly](../../administration/gitaly/index.md).
To access the **Gitaly Servers** page, go to **Admin Area > Overview > Gitaly Servers**. To access the **Gitaly Servers** page:
1. On the top bar, select **Menu >** **{admin}** **Admin**.
1. In the left sidebar, select **Overview > Gitaly Servers**.
For each Gitaly server, the following details are listed: For each Gitaly server, the following details are listed:
......
...@@ -143,9 +143,11 @@ This check is being exempt from Rack Attack. ...@@ -143,9 +143,11 @@ This check is being exempt from Rack Attack.
NOTE: NOTE:
Access token has been deprecated in GitLab 9.4 in favor of [IP whitelist](#ip-whitelist). Access token has been deprecated in GitLab 9.4 in favor of [IP whitelist](#ip-whitelist).
An access token needs to be provided while accessing the probe endpoints. The current An access token needs to be provided while accessing the probe endpoints. You can
accepted token can be found under the **Admin Area > Monitoring > Health check** find the current accepted token in the user interface:
(`admin/health_check`) page of your GitLab instance.
1. On the top bar, select **Menu >** **{admin}** **Admin**.
1. In the left sidebar, select **Monitoring > Health Check**. (`admin/health_check`)
![access token](img/health_check_token.png) ![access token](img/health_check_token.png)
......
...@@ -39,10 +39,11 @@ the [Omnibus GitLab documentation](https://docs.gitlab.com/omnibus/settings/logs ...@@ -39,10 +39,11 @@ the [Omnibus GitLab documentation](https://docs.gitlab.com/omnibus/settings/logs
## Configuration ## Configuration
The external authorization service can be enabled by an administrator on the GitLab The external authorization service can be enabled by an administrator:
**Admin Area > Settings > General** page:
![Enable external authorization service](img/external_authorization_service_settings.png) 1. On the top bar, select **Menu >** **{admin}** **Admin**.
1. In the left sidebar, select **Settings > General**:
![Enable external authorization service](img/external_authorization_service_settings.png)
The available required properties are: The available required properties are:
......
...@@ -8,7 +8,11 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -8,7 +8,11 @@ info: To determine the technical writer assigned to the Stage/Group associated w
You can analyze your users' GitLab activities over time. You can analyze your users' GitLab activities over time.
To see user cohorts, go to **Admin Area > Overview > Users**. To view user cohorts:
1. On the top bar, select **Menu >** **{admin}** **Admin**.
1. In the left sidebar, select **Overview > Users**.
1. Select the **Cohorts** tab.
## Overview ## Overview
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment