Skip to content

G
gitlab-ce
Commit 19d45d03 authored by Fiona Neill's avatar Fiona Neill
Browse files
Options

Merge branch 'aqualls-20201027-admin-settings' into 'master' 

Edits to Admin Area settings page

See merge request gitlab-org/gitlab!73211
parents 38bc21e3 d546671b
Hide whitespace changes
Inline Side-by-side
Showing with 175 additions and 113 deletions
doc/user/admin_area/settings/index.md
View file @ 19d45d03
...@@ -7,124 +7,186 @@ type: index ...@@ -7,124 +7,186 @@ type: index
# Admin Area settings **(FREE SELF)** # Admin Area settings **(FREE SELF)**
As an administrator of a GitLab self-managed instance, you can manage the behavior of your deployment. To do so, select **Admin Area > Settings**. As an administrator of a GitLab self-managed instance, you can manage the behavior of your
deployment.
The Admin Area is not accessible on GitLab.com, and settings can only be changed by the The **Admin Area** is not accessible on GitLab.com, and settings can only be changed by the
GitLab.com administrators. See the [GitLab.com settings](../../gitlab_com/index.md) GitLab.com administrators. For the settings and limits on the GitLab.com instance,
documentation for all current settings and limits on the GitLab.com instance. read [GitLab.com settings](../../gitlab_com/index.md).
## General ## Access the Admin Area
To access the default page for Admin Area settings: To access the **Admin Area**:
1. Sign in to your GitLab instance as an administrator.
1. On the top bar, select **Menu > Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Settings > General**. 1. On the left sidebar, select **Settings**, and the group of settings to view:
- [General](#general)
| Option | Description | - [Geo](#geo)
| ------ | ----------- | - [CI/CD](#cicd)
| [Visibility and access controls](visibility_and_access_controls.md) | Set default and restrict visibility levels. Configure import sources and Git access protocol. | - [Integrations](#integrations)
| [Account and limit](account_and_limit_settings.md) | Set projects and maximum size limits, session duration, user options, and check feature availability for namespace plan. | - [Metrics and profiling](#metrics-and-profiling)
| [Diff limits](../diff_limits.md) | Diff content limits. | - [Network](#network)
| [Sign-up restrictions](sign_up_restrictions.md) | Configure the way a user creates a new account. | - [Preferences](#preferences)
| [Sign in restrictions](sign_in_restrictions.md) | Set requirements for a user to sign in. Enable mandatory two-factor authentication. | - [Reporting](#reporting)
| [Terms of Service and Privacy Policy](terms.md) | Include a Terms of Service agreement and Privacy Policy that all users must accept. | - [Repository](#repository)
| [External Authentication](external_authorization.md#configuration) | External Classification Policy Authorization | - [Templates](#templates)
| [Web terminal](../../../administration/integration/terminal.md#limiting-websocket-connection-time) | Set max session time for web terminal. |
| [Web IDE](../../project/web_ide/index.md#enable-live-preview) | Manage Web IDE features. | ### General
| [FLoC](floc.md) | Enable or disable [Federated Learning of Cohorts (FLoC)](https://en.wikipedia.org/wiki/Federated_Learning_of_Cohorts) tracking. |
The **General** settings contain:
## Integrations
- [Visibility and access controls](visibility_and_access_controls.md) - Set default and
| Option | Description | restrict visibility levels. Configure import sources and Git access protocol.
| ------ | ----------- | - [Account and limit](account_and_limit_settings.md) - Set projects and maximum size limits,
| [Elasticsearch](../../../integration/elasticsearch.md#enable-advanced-search) | Elasticsearch integration. Elasticsearch AWS IAM. | session duration, user options, and check feature availability for namespace plan.
| [Kroki](../../../administration/integration/kroki.md#enable-kroki-in-gitlab) | Allow rendering of diagrams in AsciiDoc and Markdown documents using [kroki.io](https://kroki.io). | - [Diff limits](../diff_limits.md) - Diff content limits.
| [Mailgun](../../../administration/integration/mailgun.md) | Enable your GitLab instance to receive invite email bounce events from Mailgun, if it is your email provider. | - [Sign-up restrictions](sign_up_restrictions.md) - Configure the way a user creates a new account.
| [PlantUML](../../../administration/integration/plantuml.md) | Allow rendering of PlantUML diagrams in documents. | - [Sign in restrictions](sign_in_restrictions.md) - Set requirements for a user to sign in.
| [Slack application](../../../user/project/integrations/gitlab_slack_application.md#configuration) | Slack integration allows you to interact with GitLab via slash commands in a chat window. This option is only available on GitLab.com, though it may be [available for self-managed instances in the future](https://gitlab.com/gitlab-org/gitlab/-/issues/28164). | Enable mandatory two-factor authentication.
| [Third party offers](third_party_offers.md) | Control the display of third party offers. | - [Terms of Service and Privacy Policy](terms.md) - Include a Terms of Service agreement
| [Snowplow](../../../development/snowplow/index.md) | Configure the Snowplow integration. | and Privacy Policy that all users must accept.
| [Google GKE](../../project/clusters/add_gke_clusters.md) | Google GKE integration allows you to provision GKE clusters from GitLab. | - [External Authentication](external_authorization.md#configuration) - External Classification Policy Authorization.
| [Amazon EKS](../../project/clusters/add_eks_clusters.md) | Amazon EKS integration allows you to provision EKS clusters from GitLab. | - [Web terminal](../../../administration/integration/terminal.md#limiting-websocket-connection-time) -
Set max session time for web terminal.
## Repository - [Web IDE](../../project/web_ide/index.md#enable-live-preview) - Manage Web IDE features.
- [FLoC](floc.md) - Enable or disable
| Option | Description | [Federated Learning of Cohorts (FLoC)](https://en.wikipedia.org/wiki/Federated_Learning_of_Cohorts) tracking.
| ------ | ----------- |
| [Repository's custom initial branch name](../../project/repository/branches/default.md#instance-level-custom-initial-branch-name) | Set a custom branch name for new repositories created in your instance. | ### CI/CD
| [Repository mirror](visibility_and_access_controls.md#enable-project-mirroring) | Configure repository mirroring. |
| [Repository storage](../../../administration/repository_storage_types.md) | Configure storage path settings. | The **CI/CD** settings contain:
| Repository maintenance | ([Repository checks](../../../administration/repository_checks.md) and [Housekeeping](../../../administration/housekeeping.md)). Configure automatic Git checks and housekeeping on repositories. |
| [Repository static objects](../../../administration/static_objects_external_storage.md) | Serve repository static objects (for example, archives and blobs) from an external storage (for example, a CDN). | - [Continuous Integration and Deployment](continuous_integration.md) -
Auto DevOps, runners and job artifacts.
## Templates **(PREMIUM SELF)** - [Required pipeline configuration](continuous_integration.md#required-pipeline-configuration) -
Set an instance-wide auto included [pipeline configuration](../../../ci/yaml/index.md).
| Option | Description | This pipeline configuration is run after the project's own configuration.
| ------ | ----------- | - [Package Registry](continuous_integration.md#package-registry-configuration) -
| [Templates](instance_template_repository.md#configuration) | Set instance-wide template repository. | Settings related to the use and experience of using the GitLab Package Registry. Some
| [Custom project templates](../custom_project_templates.md) | Select the custom project template source group. | [risks are involved](../../packages/container_registry/index.md#use-with-external-container-registries)
in enabling some of these settings.
## CI/CD
### Geo **(PREMIUM SELF)**
| Option | Description |
| ------ | ----------- | The **Geo** setting contains:
| [Continuous Integration and Deployment](continuous_integration.md) | Auto DevOps, runners and job artifacts. |
| [Required pipeline configuration](continuous_integration.md#required-pipeline-configuration) | Set an instance-wide auto included [pipeline configuration](../../../ci/yaml/index.md). This pipeline configuration is run after the project's own configuration. | - [Geo](../../../administration/geo/index.md) - Replicate your GitLab instance to other
| [Package Registry](continuous_integration.md#package-registry-configuration) | Settings related to the use and experience of using the GitLab Package Registry. Note there are [risks involved](../../packages/container_registry/index.md#use-with-external-container-registries) in enabling some of these settings. | geographical locations. Redirects to **Admin Area > Geo > Settings** are no
longer available at **Admin Area > Settings > Geo** in [GitLab 13.0](https://gitlab.com/gitlab-org/gitlab/-/issues/36896).
## Reporting
### Integrations
| Option | Description |
| ------ | ----------- | The **Integrations** settings contain:
| [Spam and Anti-bot Protection](../../../integration/recaptcha.md) | Enable reCAPTCHA or Akismet and set IP limits. For reCAPTCHA, we currently only support [v2](https://developers.google.com/recaptcha/docs/versions). |
| [Abuse reports](../review_abuse_reports.md) | Set notification email for abuse reports. | - [Elasticsearch](../../../integration/elasticsearch.md#enable-advanced-search) -
Elasticsearch integration. Elasticsearch AWS IAM.
## Metrics and profiling - [Kroki](../../../administration/integration/kroki.md#enable-kroki-in-gitlab) -
Allow rendering of diagrams in AsciiDoc and Markdown documents using [kroki.io](https://kroki.io).
| Option | Description | - [Mailgun](../../../administration/integration/mailgun.md) - Enable your GitLab instance
| ------ | ----------- | to receive invite email bounce events from Mailgun, if it is your email provider.
| [Metrics - Prometheus](../../../administration/monitoring/prometheus/gitlab_metrics.md) | Enable and configure Prometheus metrics. | - [PlantUML](../../../administration/integration/plantuml.md) - Allow rendering of PlantUML
| [Metrics - Grafana](../../../administration/monitoring/performance/grafana_configuration.md#integration-with-gitlab-ui) | Enable and configure Grafana. | diagrams in documents.
| [Profiling - Performance bar](../../../administration/monitoring/performance/performance_bar.md#enable-the-performance-bar-for-non-administrators) | Enable access to the Performance Bar for non-administrator users in a given group. | - [Slack application](../../../user/project/integrations/gitlab_slack_application.md#configuration) -
| [Self monitoring](../../../administration/monitoring/gitlab_self_monitoring_project/index.md#create-the-self-monitoring-project) | Enable or disable instance self monitoring. | Slack integration allows you to interact with GitLab via slash commands in a chat window.
| [Usage statistics](usage_statistics.md) | Enable or disable version check and Service Ping. | This option is only available on GitLab.com, though it may be
| [Pseudonymizer data collection](../../../administration/pseudonymizer.md) | Enable or disable the Pseudonymizer data collection. | [available for self-managed instances in the future](https://gitlab.com/gitlab-org/gitlab/-/issues/28164).
- [Third party offers](third_party_offers.md) - Control the display of third-party offers.
## Network - [Snowplow](../../../development/snowplow/index.md) - Configure the Snowplow integration.
- [Google GKE](../../project/clusters/add_gke_clusters.md) - Google GKE integration enables
| Option | Description | you to provision GKE clusters from GitLab.
| ------ | ----------- | - [Amazon EKS](../../project/clusters/add_eks_clusters.md) - Amazon EKS integration enables
| Performance optimization | [Write to "authorized_keys" file](../../../administration/operations/fast_ssh_key_lookup.md#setting-up-fast-lookup-via-gitlab-shell) and [Push event activities limit and bulk push events](push_event_activities_limit.md). Various settings that affect GitLab performance. | you to provision EKS clusters from GitLab.
| [User and IP rate limits](user_and_ip_rate_limits.md) | Configure limits for web and API requests. |
| [Package Registry Rate Limits](package_registry_rate_limits.md) | Configure specific limits for Packages API requests that supersede the user and IP rate limits. | ### Metrics and profiling
| [Git LFS Rate Limits](git_lfs_rate_limits.md) | Configure specific limits for Git LFS requests that supersede the user and IP rate limits. |
| [Files API Rate Limits](files_api_rate_limits.md) | Configure specific limits for Files API requests that supersede the user and IP rate limits. | The **Metrics and profiling** settings contain:
| [Deprecated API Rate Limits](deprecated_api_rate_limits.md) | Configure specific limits for deprecated API requests that supersede the user and IP rate limits. |
| [Outbound requests](../../../security/webhooks.md) | Allow requests to the local network from hooks and services. | - [Metrics - Prometheus](../../../administration/monitoring/prometheus/gitlab_metrics.md) -
| [Protected Paths](protected_paths.md) | Configure paths to be protected by Rack Attack. | Enable and configure Prometheus metrics.
| [Incident Management](../../../operations/incident_management/index.md) Limits | Limit the number of inbound alerts that can be sent to a project. | - [Metrics - Grafana](../../../administration/monitoring/performance/grafana_configuration.md#integration-with-gitlab-ui) -
| [Notes creation limit](rate_limit_on_notes_creation.md)| Set a rate limit on the note creation requests. | Enable and configure Grafana.
- [Profiling - Performance bar](../../../administration/monitoring/performance/performance_bar.md#enable-the-performance-bar-for-non-administrators) -
## Geo **(PREMIUM SELF)** Enable access to the Performance Bar for non-administrator users in a given group.
- [Self monitoring](../../../administration/monitoring/gitlab_self_monitoring_project/index.md#create-the-self-monitoring-project) -
| Option | Description | Enable or disable instance self monitoring.
| ------ | ----------- | - [Usage statistics](usage_statistics.md) - Enable or disable version check and Service Ping.
| [Geo](../../../administration/geo/index.md) | Geo allows you to replicate your GitLab instance to other geographical locations. Redirects to **Admin Area > Geo > Settings** are no longer available at **Admin Area > Settings > Geo** in [GitLab 13.0](https://gitlab.com/gitlab-org/gitlab/-/issues/36896). | - [Pseudonymizer data collection](../../../administration/pseudonymizer.md) -
Enable or disable the Pseudonymizer data collection.
## Preferences
### Network
| Option | Description |
| ------ | ----------- | The **Network** settings contain:
| [Email](email.md) | Various email settings. |
| [What's new](../../../administration/whats-new.md) | Configure What's new drawer and content. | - Performance optimization - Various settings that affect GitLab performance, including:
| [Help page](help_page.md) | Help page text and support page URL. | - [Write to `authorized_keys` file](../../../administration/operations/fast_ssh_key_lookup.md#setting-up-fast-lookup-via-gitlab-shell).
| [Pages](../../../administration/pages/index.md#custom-domain-verification) | Size and domain settings for static websites | - [Push event activities limit and bulk push events](push_event_activities_limit.md).
| [Polling interval multiplier](../../../administration/polling.md) | Configure how frequently the GitLab UI polls for updates. | - [User and IP rate limits](user_and_ip_rate_limits.md) - Configure limits for web and API requests.
| [Gitaly timeouts](gitaly_timeouts.md) | Configure Gitaly timeouts. | These rate limits can be overridden:
| Localization | [Default first day of the week](../../profile/preferences.md) and [Time tracking](../../project/time_tracking.md#limit-displayed-units-to-hours). | - [Package Registry Rate Limits](package_registry_rate_limits.md) - Configure specific
| [Sidekiq Job Limits](sidekiq_job_limits.md) | Limit the size of Sidekiq jobs stored in Redis. | limits for Packages API requests that supersede the user and IP rate limits.
- [Git LFS Rate Limits](git_lfs_rate_limits.md) - Configure specific limits for
### Default first day of the week Git LFS requests that supersede the user and IP rate limits.
- [Files API Rate Limits](files_api_rate_limits.md) - Configure specific limits for
Files API requests that supersede the user and IP rate limits.
- [Deprecated API Rate Limits](deprecated_api_rate_limits.md) - Configure specific limits
for deprecated API requests that supersede the user and IP rate limits.
- [Outbound requests](../../../security/webhooks.md) - Allow requests to the local network from hooks and services.
- [Protected Paths](protected_paths.md) - Configure paths to be protected by Rack Attack.
- [Incident Management Limits](../../../operations/incident_management/index.md) - Limit the
number of inbound alerts that can be sent to a project.
- [Notes creation limit](rate_limit_on_notes_creation.md) - Set a rate limit on the note creation requests.
### Preferences
The **Preferences** settings contain:
- [Email](email.md) - Various email settings.
- [What's new](../../../administration/whats-new.md) - Configure **What's new** drawer and content.
- [Help page](help_page.md) - Help page text and support page URL.
- [Pages](../../../administration/pages/index.md#custom-domain-verification) -
Size and domain settings for static websites.
- [Polling interval multiplier](../../../administration/polling.md) -
Configure how frequently the GitLab UI polls for updates.
- [Gitaly timeouts](gitaly_timeouts.md) - Configure Gitaly timeouts.
- Localization:
- [Default first day of the week](../../profile/preferences.md).
- [Time tracking](../../project/time_tracking.md#limit-displayed-units-to-hours).
- [Sidekiq Job Limits](sidekiq_job_limits.md) - Limit the size of Sidekiq jobs stored in Redis.
### Reporting
The **Reporting** settings contain:
- [Spam and Anti-bot Protection](../../../integration/recaptcha.md) -
Enable anti-spam services, like reCAPTCHA or Akismet, and set IP limits.
- [Abuse reports](../review_abuse_reports.md) - Set notification email for abuse reports.
### Repository
The **Repository** settings contain:
- [Repository's custom initial branch name](../../project/repository/branches/default.md#instance-level-custom-initial-branch-name) -
Set a custom branch name for new repositories created in your instance.
- [Repository mirror](visibility_and_access_controls.md#enable-project-mirroring) -
Configure repository mirroring.
- [Repository storage](../../../administration/repository_storage_types.md) - Configure storage path settings.
- Repository maintenance:
- [Repository checks](../../../administration/repository_checks.md) - Configure
automatic Git checks on repositories.
- [Housekeeping](../../../administration/housekeeping.md)). Configure automatic
Git housekeeping on repositories.
- [Repository static objects](../../../administration/static_objects_external_storage.md) -
Serve repository static objects (for example, archives and blobs) from an external storage (for example, a CDN).
### Templates **(PREMIUM SELF)**
The **Templates** settings contain:
- [Templates](instance_template_repository.md#configuration) - Set instance-wide template repository.
- [Custom project templates](../custom_project_templates.md) - Select the custom project template source group.
## Default first day of the week
You can change the [Default first day of the week](../../profile/preferences.md) You can change the [Default first day of the week](../../profile/preferences.md)
for the entire GitLab instance: for the entire GitLab instance:
......
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
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7