url stringlengths 24 122 | repo_url stringlengths 60 156 | date_extracted stringdate 2025-08-13 00:00:00 2025-08-13 00:00:00 | root stringlengths 3 85 | breadcrumbs listlengths 1 6 | filename stringlengths 6 60 | stage stringclasses 33
values | group stringclasses 81
values | info stringclasses 22
values | title stringlengths 3 110 ⌀ | description stringlengths 11 359 ⌀ | clean_text stringlengths 47 3.32M | rich_text stringlengths 321 3.32M |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
https://docs.gitlab.com/reply_by_email | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/reply_by_email.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | reply_by_email.md | Monitor | Platform Insights | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Reply by email | Configure comments on issues and merge requests with replies by email. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
GitLab can be set up to allow users to comment on issues and merge requests by
replying to notification emails.
## Prerequisite
Make sure [incoming email](incoming_email.md) is set up.
## How replying by email works... | ---
stage: Monitor
group: Platform Insights
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Reply by email
description: Configure comments on issues and merge requests with replies ... |
https://docs.gitlab.com/housekeeping | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/housekeeping.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | housekeeping.md | Data Access | Gitaly | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Housekeeping | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
GitLab supports and automates housekeeping tasks in Git repositories to ensure
that they can be served as efficiently as possible. Housekeeping tasks include:
- Compressing Git objects an... | ---
stage: Data Access
group: Gitaly
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Housekeeping
breadcrumbs:
- doc
- administration
---
{{< details >}}
- Tier: Free, Premium, U... |
https://docs.gitlab.com/consul | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/consul.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | consul.md | GitLab Delivery | Self Managed | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | How to set up Consul | Configure a Consul cluster. |
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
A Consul cluster consists of both
[server and client agents](https://developer.hashicorp.com/consul/docs/agent).
The servers run on their own nodes and the clients run on other nodes that in
turn communicate with the servers... | ---
stage: GitLab Delivery
group: Self Managed
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: How to set up Consul
description: Configure a Consul cluster.
breadcrumbs:
- doc
- adm... |
https://docs.gitlab.com/repository_storage_paths | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/repository_storage_paths.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | repository_storage_paths.md | Data Access | Gitaly | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Repository storage | How GitLab stores repository data. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
GitLab stores [repositories](../user/project/repository/_index.md) on repository storage. Repository
storage is either:
- Physical storage configured with a `gitaly_address` that points to a [Gitaly node](gitaly/_inde... | ---
stage: Data Access
group: Gitaly
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
gitlab_dedicated: false
title: Repository storage
description: How GitLab stores repository data.
bread... |
https://docs.gitlab.com/whats-new | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/whats-new.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | whats-new.md | none | unassigned | For assistance with this What's new page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. | What's new | Configure the What's new feature. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
The **What's new** feature shows users some of the highlights of new features from the last 10 GitLab versions.
All users can see the feature list, but the entries might differ depending on the subsc... | ---
stage: none
group: unassigned
info: For assistance with this What's new page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects.
title: What's new
description: Configure the What's new feature.
breadcrumbs:
- doc
- administration
---
{{< details >}}
... |
https://docs.gitlab.com/external_users | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/external_users.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | external_users.md | Software Supply Chain Security | Authentication | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | External users | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
External users have limited access to internal or private groups and projects in the instance. Unlike regular users, external users must be explicitly added to a group or project. However, like regula... | ---
stage: Software Supply Chain Security
group: Authentication
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: External users
breadcrumbs:
- doc
- administration
---
{{< details ... |
https://docs.gitlab.com/administration/silent_mode | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/_index.md | 2025-08-13 | doc/administration/silent_mode | [
"doc",
"administration",
"silent_mode"
] | _index.md | Tenant Scale | Geo | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | GitLab Silent Mode | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/9826) in GitLab 15.11. This feature was an [experiment](../../policy/development_stages_support.md#experiment).
- Enabling and disabling Sile... | ---
stage: Tenant Scale
group: Geo
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: GitLab Silent Mode
breadcrumbs:
- doc
- administration
- silent_mode
---
{{< details >}}
- Tier... |
https://docs.gitlab.com/administration/dependency_proxy | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/dependency_proxy.md | 2025-08-13 | doc/administration/packages | [
"doc",
"administration",
"packages"
] | dependency_proxy.md | Package | Container Registry | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | GitLab Dependency Proxy administration | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/7934) in [GitLab Premium](https://about.gitlab.com/pricing/) 11.11.
- [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/273655) from Git... | ---
stage: Package
group: Container Registry
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: GitLab Dependency Proxy administration
breadcrumbs:
- doc
- administration
- packages
--... |
https://docs.gitlab.com/administration/container_registry_troubleshooting | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/container_registry_troubleshooting.md | 2025-08-13 | doc/administration/packages | [
"doc",
"administration",
"packages"
] | container_registry_troubleshooting.md | Package | Container Registry | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Troubleshooting the container registry | null |
Before investigating specific issues, try these troubleshooting steps:
1. Verify that the system clock on your Docker client and GitLab server are synchronized (for example, through NTP).
1. For S3-backed registries, verify your IAM permissions and S3 credentials (including region) are correct.
For more informat... | ---
stage: Package
group: Container Registry
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Troubleshooting the container registry
breadcrumbs:
- doc
- administration
- packages
--... |
https://docs.gitlab.com/administration/packages | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/_index.md | 2025-08-13 | doc/administration/packages | [
"doc",
"administration",
"packages"
] | _index.md | Package | Package Registry | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | GitLab package registry administration | Administer the package registry. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
To use GitLab as a private repository for a variety of common package managers, use the package registry.
You can build and publish
packages, which can be consumed as dependencies in downstream projects.
## Supported ... | ---
stage: Package
group: Package Registry
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: GitLab package registry administration
description: Administer the package registry.
bread... |
https://docs.gitlab.com/administration/container_registry_metadata_database | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/container_registry_metadata_database.md | 2025-08-13 | doc/administration/packages | [
"doc",
"administration",
"packages"
] | container_registry_metadata_database.md | Package | Container Registry | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Container registry metadata database | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/423459) in GitLab 16.4 as a [beta feature](../../policy/development_stages_support.md) for GitLab Self-Managed.
- [Generally available](http... | ---
stage: Package
group: Container Registry
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Container registry metadata database
breadcrumbs:
- doc
- administration
- packages
---
... |
https://docs.gitlab.com/administration/container_registry | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/container_registry.md | 2025-08-13 | doc/administration/packages | [
"doc",
"administration",
"packages"
] | container_registry.md | Package | Container Registry | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | GitLab container registry administration | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
{{< alert type="note" >}}
The [next-generation container registry](container_registry_metadata_database.md)
is now available for upgrade on GitLab Self-Managed instances.
This upgraded registry supports online garbage... | ---
stage: Package
group: Container Registry
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: GitLab container registry administration
breadcrumbs:
- doc
- administration
- packages
... |
https://docs.gitlab.com/administration/raketasks | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/_index.md | 2025-08-13 | doc/administration/raketasks | [
"doc",
"administration",
"raketasks"
] | _index.md | GitLab Delivery | Self Managed | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Rake tasks | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
GitLab provides [Rake](https://ruby.github.io/rake/) tasks to assist you with common administration and operational
processes.
All Rake tasks must be run on a Rails node unless the documentation for a task specificall... | ---
stage: GitLab Delivery
group: Self Managed
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Rake tasks
breadcrumbs:
- doc
- administration
- raketasks
---
{{< details >}}
- Ti... |
https://docs.gitlab.com/administration/maintenance | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/maintenance.md | 2025-08-13 | doc/administration/raketasks | [
"doc",
"administration",
"raketasks"
] | maintenance.md | GitLab Delivery | Self Managed | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Maintenance Rake tasks | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
GitLab provides Rake tasks for general maintenance.
## Gather GitLab and system information
This command gathers information about your GitLab installation and the system it runs on.
These may be useful when asking f... | ---
stage: GitLab Delivery
group: Self Managed
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Maintenance Rake tasks
breadcrumbs:
- doc
- administration
- raketasks
---
{{< detai... |
https://docs.gitlab.com/administration/praefect | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/praefect.md | 2025-08-13 | doc/administration/raketasks | [
"doc",
"administration",
"raketasks"
] | praefect.md | Data Access | Gitaly | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Praefect Rake tasks | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
Rake tasks are available for projects that have been created on Praefect storage. See the
[Praefect documentation](../gitaly/praefect/_index.md) for information on configuring Praefect.
## Replica checksums
`gitlab:p... | ---
stage: Data Access
group: Gitaly
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Praefect Rake tasks
breadcrumbs:
- doc
- administration
- raketasks
---
{{< details >}}
- Tie... |
https://docs.gitlab.com/administration/import_export_rake_tasks_troubleshooting | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/import_export_rake_tasks_troubleshooting.md | 2025-08-13 | doc/administration/raketasks | [
"doc",
"administration",
"raketasks"
] | import_export_rake_tasks_troubleshooting.md | GitLab Delivery | Self Managed | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Troubleshooting project import and export | null |
If you are having trouble with import or export, use a Rake task to enable debug mode:
```shell
# Import
IMPORT_DEBUG=true gitlab-rake "gitlab:import_export:import[root, group/subgroup, testingprojectimport, /path/to/file_to_import.tar.gz]"
# Export
EXPORT_DEBUG=true gitlab-rake "gitlab:import_export:export[root, g... | ---
stage: GitLab Delivery
group: Self Managed
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Troubleshooting project import and export
breadcrumbs:
- doc
- administration
- raketa... |
https://docs.gitlab.com/administration/service_desk_email | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/service_desk_email.md | 2025-08-13 | doc/administration/raketasks | [
"doc",
"administration",
"raketasks"
] | service_desk_email.md | GitLab Delivery | Self Managed | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Service Desk email Rake tasks | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/108279) in GitLab 15.9.
{{< /history >}}
The following are Service Desk email-related Rake tasks.
## Secrets
GitLab can use [Ser... | ---
stage: GitLab Delivery
group: Self Managed
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Service Desk email Rake tasks
breadcrumbs:
- doc
- administration
- raketasks
---
{{... |
https://docs.gitlab.com/administration/check | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/check.md | 2025-08-13 | doc/administration/raketasks | [
"doc",
"administration",
"raketasks"
] | check.md | GitLab Delivery | Self Managed | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Integrity check Rake task | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
GitLab provides Rake tasks to check the integrity of various components.
See also the [check GitLab configuration Rake task](maintenance.md#check-gitlab-configuration).
## Repository integrity
Even though Git is very... | ---
stage: GitLab Delivery
group: Self Managed
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Integrity check Rake task
breadcrumbs:
- doc
- administration
- raketasks
---
{{< de... |
https://docs.gitlab.com/administration/project_import_export | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/project_import_export.md | 2025-08-13 | doc/administration/raketasks | [
"doc",
"administration",
"raketasks"
] | project_import_export.md | GitLab Delivery | Self Managed | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Project import and export Rake tasks | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
GitLab provides Rake tasks for [project import and export](../../user/project/settings/import_export.md).
You can only import from a [compatible](../../user/project/settings/import_export.md#compatibility) GitLab inst... | ---
stage: GitLab Delivery
group: Self Managed
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Project import and export Rake tasks
breadcrumbs:
- doc
- administration
- raketasks
-... |
https://docs.gitlab.com/administration/incoming_email | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/incoming_email.md | 2025-08-13 | doc/administration/raketasks | [
"doc",
"administration",
"raketasks"
] | incoming_email.md | GitLab Delivery | Self Managed | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Incoming email Rake tasks | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/108279) in GitLab 15.9.
{{< /history >}}
The following are Incoming email-related Rake tasks.
## Secrets
GitLab can use [Incomin... | ---
stage: GitLab Delivery
group: Self Managed
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Incoming email Rake tasks
breadcrumbs:
- doc
- administration
- raketasks
---
{{< de... |
https://docs.gitlab.com/administration/x509_signatures | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/x509_signatures.md | 2025-08-13 | doc/administration/raketasks | [
"doc",
"administration",
"raketasks"
] | x509_signatures.md | Create | Source Code | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | X.509 signatures Rake task | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
When [signing commits with X.509](../../user/project/repository/signed_commits/x509.md),
the trust anchor might change and the signatures stored in the database must be updated.
## Update all X.509 signatures
This ta... | ---
stage: Create
group: Source Code
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: X.509 signatures Rake task
breadcrumbs:
- doc
- administration
- raketasks
---
{{< details >}}... |
https://docs.gitlab.com/administration/cleanup | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/cleanup.md | 2025-08-13 | doc/administration/raketasks | [
"doc",
"administration",
"raketasks"
] | cleanup.md | GitLab Delivery | Self Managed | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Clean up Rake tasks | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
GitLab provides Rake tasks for cleaning up GitLab instances.
## Remove unreferenced LFS files
{{< alert type="warning" >}}
Do not run this within 12 hours of a GitLab upgrade. This is to ensure that all background m... | ---
stage: GitLab Delivery
group: Self Managed
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Clean up Rake tasks
breadcrumbs:
- doc
- administration
- raketasks
---
{{< details ... |
https://docs.gitlab.com/administration/smtp | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/smtp.md | 2025-08-13 | doc/administration/raketasks | [
"doc",
"administration",
"raketasks"
] | smtp.md | GitLab Delivery | Self Managed | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | SMTP Rake tasks | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
The following are SMTP-related Rake tasks.
## Secrets
GitLab can use SMTP configuration secrets to read from an encrypted file. The following Rake tasks are provided for updating the contents of the encrypted file.
... | ---
stage: GitLab Delivery
group: Self Managed
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: SMTP Rake tasks
breadcrumbs:
- doc
- administration
- raketasks
---
{{< details >}}
... |
https://docs.gitlab.com/administration/password | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/password.md | 2025-08-13 | doc/administration/raketasks | [
"doc",
"administration",
"raketasks"
] | password.md | GitLab Delivery | Self Managed | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Password maintenance Rake tasks | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
GitLab provides Rake tasks for managing passwords.
## Reset passwords
To reset a password using a Rake task, see [reset user passwords](../../security/reset_user_password.md#use-a-rake-task).
## Check password salt ... | ---
stage: GitLab Delivery
group: Self Managed
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Password maintenance Rake tasks
breadcrumbs:
- doc
- administration
- raketasks
---
... |
https://docs.gitlab.com/administration/spdx | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/spdx.md | 2025-08-13 | doc/administration/raketasks | [
"doc",
"administration",
"raketasks"
] | spdx.md | Application Security Testing | Composition Analysis | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | SPDX license list import Rake task | null |
{{< details >}}
- Tier: Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
GitLab provides a Rake task for uploading a fresh copy of the [SPDX license list](https://spdx.org/licenses/)
to a GitLab instance. This list is needed for matching the names of [License approval policies](../../user/compliance/licen... | ---
stage: Application Security Testing
group: Composition Analysis
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: SPDX license list import Rake task
breadcrumbs:
- doc
- administr... |
https://docs.gitlab.com/administration/ldap | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/ldap.md | 2025-08-13 | doc/administration/raketasks | [
"doc",
"administration",
"raketasks"
] | ldap.md | Software Supply Chain Security | Authentication | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | LDAP Rake tasks | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
The following are LDAP-related Rake tasks.
## Check
The LDAP check Rake task tests the `bind_dn` and `password` credentials
(if configured) and lists a sample of LDAP users. This task is also
executed as part of the ... | ---
stage: Software Supply Chain Security
group: Authentication
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
gitlab_dedicated: false
title: LDAP Rake tasks
breadcrumbs:
- doc
- administ... |
https://docs.gitlab.com/administration/user_management | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/user_management.md | 2025-08-13 | doc/administration/raketasks | [
"doc",
"administration",
"raketasks"
] | user_management.md | GitLab Delivery | Self Managed | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | User management Rake tasks | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
GitLab provides Rake tasks for managing users. Administrators can also use the **Admin** area to
[manage users](../admin_area.md#administering-users).
## Add user as a developer to all projects
To add a user as a dev... | ---
stage: GitLab Delivery
group: Self Managed
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: User management Rake tasks
breadcrumbs:
- doc
- administration
- raketasks
---
{{< d... |
https://docs.gitlab.com/administration/web_hooks | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/web_hooks.md | 2025-08-13 | doc/administration/raketasks | [
"doc",
"administration",
"raketasks"
] | web_hooks.md | GitLab Delivery | Self Managed | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Webhook administration Rake tasks | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
GitLab provides Rake tasks for webhooks management.
Requests to the [local network by webhooks](../../security/webhooks.md) can be allowed or blocked by an
administrator.
## Add a webhook to all projects
To add a we... | ---
stage: GitLab Delivery
group: Self Managed
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Webhook administration Rake tasks
breadcrumbs:
- doc
- administration
- raketasks
---
... |
https://docs.gitlab.com/administration/raketasks/sanitize | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/raketasks/sanitize.md | 2025-08-13 | doc/administration/raketasks/uploads | [
"doc",
"administration",
"raketasks",
"uploads"
] | sanitize.md | GitLab Delivery | Self Managed | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Uploads sanitize Rake tasks | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
EXIF data is automatically stripped from JPG or TIFF image uploads.
EXIF data may contain sensitive information (for example, GPS location), so you
can remove EXIF data from existing images that were uploaded to an ea... | ---
stage: GitLab Delivery
group: Self Managed
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Uploads sanitize Rake tasks
breadcrumbs:
- doc
- administration
- raketasks
- uploads
... |
https://docs.gitlab.com/administration/raketasks/migrate | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/raketasks/migrate.md | 2025-08-13 | doc/administration/raketasks/uploads | [
"doc",
"administration",
"raketasks",
"uploads"
] | migrate.md | GitLab Delivery | Self Managed | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Uploads migrate Rake tasks | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
There is a Rake task for migrating uploads between different storage types.
- Migrate all uploads with [`gitlab:uploads:migrate:all`](#all-in-one-rake-task) or
- To only migrate specific upload types, use [`gitlab:upl... | ---
stage: GitLab Delivery
group: Self Managed
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Uploads migrate Rake tasks
breadcrumbs:
- doc
- administration
- raketasks
- uploads
-... |
https://docs.gitlab.com/administration/raketasks/tokens | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/raketasks/_index.md | 2025-08-13 | doc/administration/raketasks/tokens | [
"doc",
"administration",
"raketasks",
"tokens"
] | _index.md | Software Supply Chain Security | Authentication | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Access token Rake tasks | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/467416) in GitLab 17.2.
{{< /history >}}
## Analyze token expiration dates
In GitLab 16.0, a [background migration](https://gitlab.com/gi... | ---
stage: Software Supply Chain Security
group: Authentication
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Access token Rake tasks
breadcrumbs:
- doc
- administration
- raketas... |
https://docs.gitlab.com/administration/terminal | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/terminal.md | 2025-08-13 | doc/administration/integration | [
"doc",
"administration",
"integration"
] | terminal.md | Deploy | Environments | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Web terminals (deprecated) | Information about Web terminals. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
{{< history >}}
- [Disabled on GitLab Self-Managed](https://gitlab.com/gitlab-org/gitlab/-/issues/353410) in GitLab 15.0.
{{< /history >}}
{{< alert type="warning" >}}
This feature was [deprecated](https://gitlab.c... | ---
stage: Deploy
group: Environments
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Web terminals (deprecated)
description: Information about Web terminals.
breadcrumbs:
- doc
- a... |
https://docs.gitlab.com/administration/diagrams_net | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/diagrams_net.md | 2025-08-13 | doc/administration/integration | [
"doc",
"administration",
"integration"
] | diagrams_net.md | Create | Source Code | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Diagrams.net | Configure a Diagrams.net integration for GitLab. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- Offline environment support [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/116281) in GitLab 16.1.
{{< /history >}}
Use the [diagrams.net](https://www.drawio.c... | ---
stage: Create
group: Source Code
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Configure a Diagrams.net integration for GitLab.
gitlab_dedicated: true
title: Diagrams.ne... |
https://docs.gitlab.com/administration/plantuml | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/plantuml.md | 2025-08-13 | doc/administration/integration | [
"doc",
"administration",
"integration"
] | plantuml.md | Create | Source Code | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | PlantUML | Configure PlantUML integration with GitLab Self-Managed. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Use the [PlantUML](https://plantuml.com) integration, to create diagrams in snippets, wikis, and repositories.
GitLab.com integrates with PlantUML for all users, and requires no additional configurati... | ---
stage: Create
group: Source Code
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
gitlab_dedicated: false
description: Configure PlantUML integration with GitLab Self-Managed.
title: Pl... |
https://docs.gitlab.com/administration/mailgun | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/mailgun.md | 2025-08-13 | doc/administration/integration | [
"doc",
"administration",
"integration"
] | mailgun.md | Plan | Project Management | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Mailgun | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
When you use Mailgun to send emails for your GitLab instance and [Mailgun](https://www.mailgun.com/)
integration is enabled and configured in GitLab, you can receive their webhook for
tracking delivery failures. To set... | ---
stage: Plan
group: Project Management
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
gitlab_dedicated: false
title: Mailgun
breadcrumbs:
- doc
- administration
- integration
---
{{<... |
https://docs.gitlab.com/administration/kroki | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/kroki.md | 2025-08-13 | doc/administration/integration | [
"doc",
"administration",
"integration"
] | kroki.md | Plan | Project Management | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Kroki | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
With the [Kroki](https://kroki.io) integration,
you can create diagrams-as-code within AsciiDoc, Markdown, reStructuredText, and Textile.
## Enable Kroki in GitLab
You need to enable Kroki integrati... | ---
stage: Plan
group: Project Management
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
gitlab_dedicated: true
title: Kroki
breadcrumbs:
- doc
- administration
- integration
---
{{< de... |
https://docs.gitlab.com/administration/troubleshooting_backup_gitlab | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/troubleshooting_backup_gitlab.md | 2025-08-13 | doc/administration/backup_restore | [
"doc",
"administration",
"backup_restore"
] | troubleshooting_backup_gitlab.md | Data Access | Durability | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Troubleshooting GitLab backups | null |
When you back up GitLab, you might encounter the following issues.
## When the secrets file is lost
If you didn't [back up the secrets file](backup_gitlab.md#storing-configuration-files), you
must complete several steps to get GitLab working properly again.
The secrets file is responsible for storing the encryptio... | ---
stage: Data Access
group: Durability
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Troubleshooting GitLab backups
breadcrumbs:
- doc
- administration
- backup_restore
---
Wh... |
https://docs.gitlab.com/administration/backup_archive_process | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/backup_archive_process.md | 2025-08-13 | doc/administration/backup_restore | [
"doc",
"administration",
"backup_restore"
] | backup_archive_process.md | Data Access | Durability | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Backup archive process | null |
When you run the [backup command](backup_gitlab.md#backup-command), a backup script creates a backup archive file to store your GitLab data.
To create the archive file, the backup script:
1. Extracts the previous backup archive file, when you're doing an incremental backup.
1. Updates or generates the backup archiv... | ---
stage: Data Access
group: Durability
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Backup archive process
breadcrumbs:
- doc
- administration
- backup_restore
---
When you r... |
https://docs.gitlab.com/administration/backup_gitlab | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/backup_gitlab.md | 2025-08-13 | doc/administration/backup_restore | [
"doc",
"administration",
"backup_restore"
] | backup_gitlab.md | Data Access | Durability | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Back up GitLab | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
GitLab backups protect your data and help with disaster recovery.
The optimal backup strategy depends on your GitLab deployment configuration,
data volume, and storage locations. These factors determine which backup
m... | ---
stage: Data Access
group: Durability
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Back up GitLab
breadcrumbs:
- doc
- administration
- backup_restore
---
{{< details >}}
-... |
https://docs.gitlab.com/administration/restore_gitlab | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/restore_gitlab.md | 2025-08-13 | doc/administration/backup_restore | [
"doc",
"administration",
"backup_restore"
] | restore_gitlab.md | Data Access | Durability | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Restore GitLab | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
GitLab restore operations recover data from backups to maintain system
continuity and recover from data loss. Restore operations:
- Recover database records and configuration
- Restore Git repositories, container regi... | ---
stage: Data Access
group: Durability
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Restore GitLab
breadcrumbs:
- doc
- administration
- backup_restore
---
{{< details >}}
-... |
https://docs.gitlab.com/administration/backup_cli | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/backup_cli.md | 2025-08-13 | doc/administration/backup_restore | [
"doc",
"administration",
"backup_restore"
] | backup_cli.md | Data Access | Durability | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Back up and Restore GitLab with `gitlab-backup-cli` | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
- Status: Experiment
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/11908) in GitLab 17.0. This feature is an [experiment](../../policy/development_stages_support.md) and subject to the [G... | ---
stage: Data Access
group: Durability
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
ignore_in_report: true
title: Back up and Restore GitLab with `gitlab-backup-cli`
breadcrumbs:
- do... |
https://docs.gitlab.com/administration/migrate_to_new_server | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/migrate_to_new_server.md | 2025-08-13 | doc/administration/backup_restore | [
"doc",
"administration",
"backup_restore"
] | migrate_to_new_server.md | Data Access | Durability | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Migrate to a new server | null |
<!-- some details borrowed from GitLab.com move from Azure to GCP detailed at https://gitlab.com/gitlab-com/migration/-/blob/master/.gitlab/issue_templates/failover.md -->
You can use GitLab backup and restore to migrate your instance to a new server. This section outlines a typical procedure for a GitLab deployment... | ---
stage: Data Access
group: Durability
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Migrate to a new server
breadcrumbs:
- doc
- administration
- backup_restore
---
<!-- some... |
https://docs.gitlab.com/administration/backup_large_reference_architectures | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/backup_large_reference_architectures.md | 2025-08-13 | doc/administration/backup_restore | [
"doc",
"administration",
"backup_restore"
] | backup_large_reference_architectures.md | Data Access | Durability | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Back up and restore large reference architectures | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
GitLab backups preserve data consistency and enable disaster recovery for
large-scale GitLab deployments. This process:
- Coordinates data backups across distributed storage components
- Preserves PostgreSQL databases... | ---
stage: Data Access
group: Durability
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Back up and restore large reference architectures
breadcrumbs:
- doc
- administration
- back... |
https://docs.gitlab.com/administration/backup_restore | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/_index.md | 2025-08-13 | doc/administration/backup_restore | [
"doc",
"administration",
"backup_restore"
] | _index.md | Data Access | Durability | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Back up and restore overview | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
Your GitLab instance contains critical data for your software development or organization.
It is important to have a disaster recovery plan that includes regular backups for:
- Data protection: Safeguard against data ... | ---
stage: Data Access
group: Durability
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Back up and restore overview
breadcrumbs:
- doc
- administration
- backup_restore
---
{{< ... |
https://docs.gitlab.com/administration/wikis | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/_index.md | 2025-08-13 | doc/administration/wikis | [
"doc",
"administration",
"wikis"
] | _index.md | Plan | Knowledge | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Wiki settings | Configure Wiki settings. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
Adjust the wiki settings of your GitLab instance.
## Wiki page content size limit
You can set a maximum content size limit for wiki pages. This limit can prevent
abuse of the feature. The default value is **52428800 ... | ---
stage: Plan
group: Knowledge
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Wiki settings
description: Configure Wiki settings.
breadcrumbs:
- doc
- administration
- wikis
---
... |
https://docs.gitlab.com/administration/standalone | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/standalone.md | 2025-08-13 | doc/administration/postgresql | [
"doc",
"administration",
"postgresql"
] | standalone.md | Data Access | Database Operations | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Standalone PostgreSQL for Linux package installations | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
If you wish to have your database service hosted separately from your GitLab
application servers, you can do this using the PostgreSQL binaries packaged
together with the Linux package. This is recommended as part of o... | ---
stage: Data Access
group: Database Operations
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Standalone PostgreSQL for Linux package installations
breadcrumbs:
- doc
- administ... |
https://docs.gitlab.com/administration/database_load_balancing | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/database_load_balancing.md | 2025-08-13 | doc/administration/postgresql | [
"doc",
"administration",
"postgresql"
] | database_load_balancing.md | Data Access | Database Frameworks | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Database Load Balancing | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
With Database Load Balancing, read-only queries can be distributed across
multiple PostgreSQL nodes to increase performance.
This functionality is provided natively in GitLab Rails and Sidekiq where
they can be config... | ---
stage: Data Access
group: Database Frameworks
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Database Load Balancing
breadcrumbs:
- doc
- administration
- postgresql
---
{{< ... |
https://docs.gitlab.com/administration/moving | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/moving.md | 2025-08-13 | doc/administration/postgresql | [
"doc",
"administration",
"postgresql"
] | moving.md | Data Access | Database Operations | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Moving GitLab databases to a different PostgreSQL instance | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
Sometimes it is necessary to move your databases from one PostgreSQL instance to
another. For example, if you are using AWS Aurora and are preparing to
enable Database Load Balancing, you need to move your databases to... | ---
stage: Data Access
group: Database Operations
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Moving GitLab databases to a different PostgreSQL instance
breadcrumbs:
- doc
- adm... |
https://docs.gitlab.com/administration/external | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/external.md | 2025-08-13 | doc/administration/postgresql | [
"doc",
"administration",
"postgresql"
] | external.md | Data Access | Database Operations | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Configure GitLab using an external PostgreSQL service | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
If you're hosting GitLab on a cloud provider, you can optionally use a
managed service for PostgreSQL. For example, AWS offers a managed Relational
Database Service (RDS) that runs PostgreSQL.
Alternatively, you may o... | ---
stage: Data Access
group: Database Operations
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Configure GitLab using an external PostgreSQL service
breadcrumbs:
- doc
- administ... |
https://docs.gitlab.com/administration/upgrading_os | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/upgrading_os.md | 2025-08-13 | doc/administration/postgresql | [
"doc",
"administration",
"postgresql"
] | upgrading_os.md | Data Access | Database Operations | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Upgrading operating systems for PostgreSQL | null |
{{< alert type="warning" >}}
[Geo](../geo/_index.md) cannot be used to migrate a PostgreSQL database from one operating system to another. If you attempt to do so, the secondary site may appear to be 100% replicated when in fact some data is not replicated, leading to data loss. This is because Geo depends on Postgr... | ---
stage: Data Access
group: Database Operations
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Upgrading operating systems for PostgreSQL
breadcrumbs:
- doc
- administration
- po... |
https://docs.gitlab.com/administration/external_upgrade | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/external_upgrade.md | 2025-08-13 | doc/administration/postgresql | [
"doc",
"administration",
"postgresql"
] | external_upgrade.md | Data Access | Database Operations | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Upgrading external PostgreSQL databases | null |
When upgrading your PostgreSQL database engine, it is important to follow all steps
recommended by the PostgreSQL community and your cloud provider. Two
kinds of upgrades exist for PostgreSQL databases:
- Minor version upgrades: These include only bug and security fixes. They are
always backward-compatible with yo... | ---
stage: Data Access
group: Database Operations
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Upgrading external PostgreSQL databases
breadcrumbs:
- doc
- administration
- postg... |
https://docs.gitlab.com/administration/postgresql | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/_index.md | 2025-08-13 | doc/administration/postgresql | [
"doc",
"administration",
"postgresql"
] | _index.md | Data Access | Database Operations | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Configuring PostgreSQL for scaling | Configure PostgreSQL for scaling. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
In this section, you are guided through configuring a PostgreSQL database to
be used with GitLab in one of our [reference architectures](../reference_architectures/_index.md).
## Configuration options
Choose one of t... | ---
stage: Data Access
group: Database Operations
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Configuring PostgreSQL for scaling
description: Configure PostgreSQL for scaling.
b... |
https://docs.gitlab.com/administration/replication_and_failover_troubleshooting | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/replication_and_failover_troubleshooting.md | 2025-08-13 | doc/administration/postgresql | [
"doc",
"administration",
"postgresql"
] | replication_and_failover_troubleshooting.md | Data Access | Database Operations | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Troubleshooting PostgreSQL replication and failover for Linux package installations | null |
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
When working with PostgreSQL replication and failover, you might encounter the following issues.
## Consul and PostgreSQL changes not taking effect
Due to the potential impacts, `gitlab-ctl reconfigure` only reloads Consul... | ---
stage: Data Access
group: Database Operations
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Troubleshooting PostgreSQL replication and failover for Linux package installations... |
https://docs.gitlab.com/administration/replication_and_failover | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/replication_and_failover.md | 2025-08-13 | doc/administration/postgresql | [
"doc",
"administration",
"postgresql"
] | replication_and_failover.md | Data Access | Database Operations | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | PostgreSQL replication and failover for Linux package installations | null |
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
If you're a Free user of GitLab Self-Managed, consider using a cloud-hosted solution.
This document doesn't cover self-compiled installations.
If a setup with replication and failover isn't what you were looking for, see
th... | ---
stage: Data Access
group: Database Operations
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: PostgreSQL replication and failover for Linux package installations
breadcrumbs:
- ... |
https://docs.gitlab.com/administration/pgbouncer | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/pgbouncer.md | 2025-08-13 | doc/administration/postgresql | [
"doc",
"administration",
"postgresql"
] | pgbouncer.md | Data Access | Database Operations | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Working with the bundled PgBouncer service | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
{{< alert type="note" >}}
PgBouncer is bundled in the `gitlab-ee` package, but is free to use.
For support, you need a [Premium subscription](https://about.gitlab.com/pricing/).
{{< /alert >}}
[PgBouncer](https://ww... | ---
stage: Data Access
group: Database Operations
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Working with the bundled PgBouncer service
breadcrumbs:
- doc
- administration
- po... |
https://docs.gitlab.com/administration/external_metrics | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/external_metrics.md | 2025-08-13 | doc/administration/postgresql | [
"doc",
"administration",
"postgresql"
] | external_metrics.md | Data Access | Database Operations | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Monitoring and logging setup for external databases | null |
External PostgreSQL database systems have different logging options for monitoring performance and troubleshooting, however they are not enabled by default. In this section we provide the recommendations for self-managed PostgreSQL, and recommendations for some major providers of PostgreSQL managed services.
## Reco... | ---
stage: Data Access
group: Database Operations
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Monitoring and logging setup for external databases
breadcrumbs:
- doc
- administra... |
https://docs.gitlab.com/administration/tracing_correlation_id | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/tracing_correlation_id.md | 2025-08-13 | doc/administration/logs | [
"doc",
"administration",
"logs"
] | tracing_correlation_id.md | GitLab Delivery | Self Managed | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Find relevant log entries with a correlation ID | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
GitLab instances log a unique request tracking ID (known as the
"correlation ID") for most requests. Each individual request to GitLab gets
its own correlation ID, which then gets logged in each GitLab component's logs... | ---
stage: GitLab Delivery
group: Self Managed
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Find relevant log entries with a correlation ID
breadcrumbs:
- doc
- administration
- ... |
https://docs.gitlab.com/administration/log_parsing | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/log_parsing.md | 2025-08-13 | doc/administration/logs | [
"doc",
"administration",
"logs"
] | log_parsing.md | GitLab Delivery | Self Managed | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Parsing GitLab logs with `jq` | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
We recommend using log aggregation and search tools like Kibana and Splunk whenever possible,
but if they are not available you can still quickly parse
[GitLab logs](_index.md) in JSON format
using [`jq`](https://stedo... | ---
stage: GitLab Delivery
group: Self Managed
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Parsing GitLab logs with `jq`
breadcrumbs:
- doc
- administration
- logs
---
{{< det... |
https://docs.gitlab.com/administration/logs | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/_index.md | 2025-08-13 | doc/administration/logs | [
"doc",
"administration",
"logs"
] | _index.md | Monitor | Platform Insights | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Log system | Access comprehensive logging and monitoring capabilities. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
The log system in GitLab provides comprehensive logging and monitoring capabilities for analyzing your GitLab instance.
You can use logs to identify system issues, investigate security events, and analyze application p... | ---
stage: Monitor
group: Platform Insights
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Log system
description: Access comprehensive logging and monitoring capabilities.
breadcr... |
https://docs.gitlab.com/administration/gateway | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/gateway.md | 2025-08-13 | doc/administration/gitlab_duo | [
"doc",
"administration",
"gitlab_duo"
] | gateway.md | AI-powered | AI Framework | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | AI gateway | null |
The AI gateway is a standalone service that gives access to AI-native GitLab Duo features.
GitLab operates an instance of the AI gateway, based in the cloud. This instance is used by:
- GitLab.com.
- GitLab Self-Managed. For more information,
see how to [configure GitLab Duo on a GitLab Self-Managed instance](set... | ---
stage: AI-powered
group: AI Framework
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: AI gateway
breadcrumbs:
- doc
- administration
- gitlab_duo
---
The AI gateway is a stand... |
https://docs.gitlab.com/administration/setup | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/setup.md | 2025-08-13 | doc/administration/gitlab_duo | [
"doc",
"administration",
"gitlab_duo"
] | setup.md | AI-powered | AI Framework | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Configure GitLab Duo on a GitLab Self-Managed instance | Ensure GitLab Duo is configured and operating correctly. |
{{< details >}}
- Offering: GitLab Self-Managed
{{< /details >}}
GitLab Duo is powered by large language models (LLMs), with data sent through an AI gateway.
To use GitLab Duo on a GitLab Self-Managed instance, you can do either of the following:
- Use the GitLab AI vendor models and the cloud-based AI gateway th... | ---
stage: AI-powered
group: AI Framework
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Ensure GitLab Duo is configured and operating correctly.
title: Configure GitLab Duo ... |
https://docs.gitlab.com/administration/sidekiq_memory_killer | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/sidekiq_memory_killer.md | 2025-08-13 | doc/administration/sidekiq | [
"doc",
"administration",
"sidekiq"
] | sidekiq_memory_killer.md | Data access | Durability | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Reducing memory use | null |
The Sidekiq memory killer automatically manages background job processes that
consume too much memory. This feature monitors worker processes and restarts them before
the Linux memory killer steps in, which allows background jobs to run to completion
before gracefully shutting down. By logging these events, we make i... | ---
stage: Data access
group: Durability
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Reducing memory use
breadcrumbs:
- doc
- administration
- sidekiq
---
The Sidekiq memory k... |
https://docs.gitlab.com/administration/extra_sidekiq_processes | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/extra_sidekiq_processes.md | 2025-08-13 | doc/administration/sidekiq | [
"doc",
"administration",
"sidekiq"
] | extra_sidekiq_processes.md | Data access | Durability | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Run multiple Sidekiq processes | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
GitLab allows you to start multiple Sidekiq processes to process background jobs
at a higher rate on a single instance. By default, Sidekiq starts one worker
process and only uses a single core.
{{< alert type="note" ... | ---
stage: Data access
group: Durability
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Run multiple Sidekiq processes
breadcrumbs:
- doc
- administration
- sidekiq
---
{{< detai... |
https://docs.gitlab.com/administration/sidekiq_troubleshooting | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/sidekiq_troubleshooting.md | 2025-08-13 | doc/administration/sidekiq | [
"doc",
"administration",
"sidekiq"
] | sidekiq_troubleshooting.md | Data access | Durability | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Troubleshooting Sidekiq | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
Sidekiq is the background job processor GitLab uses to asynchronously run
tasks. When things go wrong it can be difficult to troubleshoot. These
situations also tend to be high-pressure because a production system job ... | ---
stage: Data access
group: Durability
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Troubleshooting Sidekiq
breadcrumbs:
- doc
- administration
- sidekiq
---
{{< details >}}
... |
https://docs.gitlab.com/administration/sidekiq | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/_index.md | 2025-08-13 | doc/administration/sidekiq | [
"doc",
"administration",
"sidekiq"
] | _index.md | Data access | Durability | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Configure an external Sidekiq instance | Configure an external Sidekiq instance. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
You can configure an external Sidekiq instance by using the Sidekiq that's bundled in the GitLab package. Sidekiq requires connection to the Redis,
PostgreSQL, and Gitaly instances.
## Configure TCP access for Postgre... | ---
stage: Data access
group: Durability
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Configure an external Sidekiq instance
description: Configure an external Sidekiq instance.
... |
https://docs.gitlab.com/administration/sidekiq_job_migration | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/sidekiq_job_migration.md | 2025-08-13 | doc/administration/sidekiq | [
"doc",
"administration",
"sidekiq"
] | sidekiq_job_migration.md | none | unassigned | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Sidekiq job migration Rake tasks | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
{{< alert type="warning" >}}
This operation should be very uncommon. We do not recommend it for the vast majority of GitLab instances.
{{< /alert >}}
Sidekiq routing rules allow administrators to re-route certain ba... | ---
stage: none
group: unassigned
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Sidekiq job migration Rake tasks
breadcrumbs:
- doc
- administration
- sidekiq
---
{{< details >}... |
https://docs.gitlab.com/administration/processing_specific_job_classes | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/processing_specific_job_classes.md | 2025-08-13 | doc/administration/sidekiq | [
"doc",
"administration",
"sidekiq"
] | processing_specific_job_classes.md | Data access | Durability | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Processing specific job classes | null |
{{< alert type="warning" >}}
These are advanced settings. While they are used on GitLab.com, most GitLab
instances should only add more processes that listen to all queues. This is the
same approach described in the [Reference Architectures](../reference_architectures/_index.md).
{{< /alert >}}
Most GitLab instanc... | ---
stage: Data access
group: Durability
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Processing specific job classes
breadcrumbs:
- doc
- administration
- sidekiq
---
{{< aler... |
https://docs.gitlab.com/administration/sidekiq_health_check | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/sidekiq_health_check.md | 2025-08-13 | doc/administration/sidekiq | [
"doc",
"administration",
"sidekiq"
] | sidekiq_health_check.md | Data access | Durability | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Sidekiq health check | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
GitLab provides liveness and readiness probes to indicate service health and
reachability to the Sidekiq cluster. These endpoints
[can be provided to schedulers like Kubernetes](https://kubernetes.io/docs/tasks/configu... | ---
stage: Data access
group: Durability
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Sidekiq health check
breadcrumbs:
- doc
- administration
- sidekiq
---
{{< details >}}
- ... |
https://docs.gitlab.com/administration/architecture | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/architecture.md | 2025-08-13 | doc/administration/dedicated | [
"doc",
"administration",
"dedicated"
] | architecture.md | GitLab Dedicated | Environment Automation | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | GitLab Dedicated architecture | Get to know the GitLab Dedicated architecture through a series of diagrams. |
{{< details >}}
- Tier: Ultimate
- Offering: GitLab Dedicated
{{< /details >}}
This page provides a set of architectural documents and diagrams for GitLab Dedicated.
## High-level overview
The following diagram shows a high-level overview of the architecture for GitLab Dedicated,
where various AWS accounts manag... | ---
stage: GitLab Dedicated
group: Environment Automation
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Get to know the GitLab Dedicated architecture through a series of dia... |
https://docs.gitlab.com/administration/monitor | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/monitor.md | 2025-08-13 | doc/administration/dedicated | [
"doc",
"administration",
"dedicated"
] | monitor.md | GitLab Dedicated | Switchboard | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Monitor your GitLab Dedicated instance | Access application logs and S3 bucket data to monitor your GitLab Dedicated instance. |
{{< details >}}
- Tier: Ultimate
- Offering: GitLab Dedicated
{{< /details >}}
GitLab delivers [application logs](../logs/_index.md) to an Amazon S3 bucket in the GitLab
tenant account, which can be shared with you.
To access these logs, you must provide AWS Identity and Access Management (IAM) Amazon Resource
Nam... | ---
stage: GitLab Dedicated
group: Switchboard
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Access application logs and S3 bucket data to monitor your GitLab Dedicated
in... |
https://docs.gitlab.com/administration/tenant_overview | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/tenant_overview.md | 2025-08-13 | doc/administration/dedicated | [
"doc",
"administration",
"dedicated"
] | tenant_overview.md | GitLab Dedicated | Switchboard | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | View GitLab Dedicated instance details | View information about your GitLab Dedicated instance with Switchboard. |
{{< details >}}
- Tier: Ultimate
- Offering: GitLab Dedicated
{{< /details >}}
Monitor your GitLab Dedicated instance details, maintenance windows, and configuration status in Switchboard.
## View your instance details
To access your instance details:
1. Sign in to [Switchboard](https://console.gitlab-dedicated... | ---
stage: GitLab Dedicated
group: Switchboard
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: View information about your GitLab Dedicated instance with Switchboard.
title: V... |
https://docs.gitlab.com/administration/hosted_runners | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/hosted_runners.md | 2025-08-13 | doc/administration/dedicated | [
"doc",
"administration",
"dedicated"
] | hosted_runners.md | Production Engineering | Runners Platform | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Hosted runners for GitLab Dedicated | Use hosted runners to run your CI/CD jobs on GitLab Dedicated. |
{{< details >}}
- Tier: Ultimate
- Offering: GitLab Dedicated
- Status: Limited availability
{{< /details >}}
{{< alert type="note" >}}
To use this feature, you must purchase a subscription for Hosted Runners for GitLab Dedicated. To participate in the limited availability of Hosted Runners for Dedicated, reach o... | ---
stage: Production Engineering
group: Runners Platform
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Use hosted runners to run your CI/CD jobs on GitLab Dedicated.
title:... |
https://docs.gitlab.com/administration/dedicated | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/_index.md | 2025-08-13 | doc/administration/dedicated | [
"doc",
"administration",
"dedicated"
] | _index.md | GitLab Dedicated | Switchboard | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Administer GitLab Dedicated | Get started with GitLab Dedicated. |
{{< details >}}
- Tier: Ultimate
- Offering: GitLab Dedicated
{{< /details >}}
Use GitLab Dedicated to run GitLab on a fully-managed, single-tenant instance hosted on AWS. You maintain control over your instance configuration through Switchboard, the GitLab Dedicated management portal, while GitLab manages the und... | ---
stage: GitLab Dedicated
group: Switchboard
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Get started with GitLab Dedicated.
title: Administer GitLab Dedicated
breadcrumb... |
https://docs.gitlab.com/administration/maintenance | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/maintenance.md | 2025-08-13 | doc/administration/dedicated | [
"doc",
"administration",
"dedicated"
] | maintenance.md | GitLab Dedicated | Environment Automation | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | GitLab Dedicated maintenance and release schedule | Maintenance windows, release schedules, and emergency maintenance processes for GitLab Dedicated instances. |
{{< details >}}
- Tier: Ultimate
- Offering: GitLab Dedicated
{{< /details >}}
Regular maintenance is performed on GitLab Dedicated instances according to scheduled maintenance windows and release upgrade timelines.
During scheduled maintenance windows, the following tasks might be performed:
- Application and o... | ---
stage: GitLab Dedicated
group: Environment Automation
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Maintenance windows, release schedules, and emergency maintenance pro... |
https://docs.gitlab.com/administration/disaster_recovery | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/disaster_recovery.md | 2025-08-13 | doc/administration/dedicated | [
"doc",
"administration",
"dedicated"
] | disaster_recovery.md | GitLab Dedicated | Environment Automation | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Disaster recovery for GitLab Dedicated | null |
{{< details >}}
- Tier: Ultimate
- Offering: GitLab Dedicated
{{< /details >}}
The disaster recovery process ensures your GitLab Dedicated instance
can be restored if a disaster affects your primary region.
GitLab can deploy your instance in these AWS regions:
- A primary region where your instance runs.
- If se... | ---
stage: GitLab Dedicated
group: Environment Automation
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Disaster recovery for GitLab Dedicated
breadcrumbs:
- doc
- administration
... |
https://docs.gitlab.com/administration/encryption | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/encryption.md | 2025-08-13 | doc/administration/dedicated | [
"doc",
"administration",
"dedicated"
] | encryption.md | GitLab Dedicated | Switchboard | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | GitLab Dedicated encryption | GitLab Dedicated encryption protects data at rest and in transit using AWS technologies, with support to bring your own encryption keys (BYOK). |
{{< details >}}
- Tier: Ultimate
- Offering: GitLab Dedicated
{{< /details >}}
GitLab Dedicated provides secure encryption capabilities to protect your data through robust security
infrastructure provided by AWS. Data is encrypted both at rest and in transit.
## Encrypted data at rest
GitLab Dedicated encrypts a... | ---
stage: GitLab Dedicated
group: Switchboard
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: GitLab Dedicated encryption protects data at rest and in transit using
AWS tec... |
https://docs.gitlab.com/administration/dedicated/storage_types | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/dedicated/storage_types.md | 2025-08-13 | doc/administration/dedicated/create_instance | [
"doc",
"administration",
"dedicated",
"create_instance"
] | storage_types.md | GitLab Dedicated | Switchboard | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | GitLab Dedicated storage types | Learn how storage is allocated and managed in GitLab Dedicated, including repository storage and object storage. |
{{< details >}}
- Tier: Ultimate
- Offering: GitLab Dedicated
{{< /details >}}
GitLab Dedicated provides a single-tenant, fully managed GitLab instance deployed in your preferred AWS
cloud region. Your account team works with you to determine your storage needs during the procurement
process.
Understanding how st... | ---
stage: GitLab Dedicated
group: Switchboard
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Learn how storage is allocated and managed in GitLab Dedicated, including
repo... |
https://docs.gitlab.com/administration/dedicated/create_instance | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/dedicated/_index.md | 2025-08-13 | doc/administration/dedicated/create_instance | [
"doc",
"administration",
"dedicated",
"create_instance"
] | _index.md | GitLab Dedicated | Switchboard | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Create your GitLab Dedicated instance | Create your GitLab Dedicated instance with Switchboard. |
{{< details >}}
- Tier: Ultimate
- Offering: GitLab Dedicated
{{< /details >}}
The instructions on this page guide you through the onboarding and initial setup of your GitLab Dedicated instance using [Switchboard](https://about.gitlab.com/direction/platforms/switchboard/), the GitLab Dedicated portal.
## Step 1: ... | ---
stage: GitLab Dedicated
group: Switchboard
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Create your GitLab Dedicated instance with Switchboard.
title: Create your GitLa... |
https://docs.gitlab.com/administration/dedicated/saml | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/dedicated/saml.md | 2025-08-13 | doc/administration/dedicated/configure_instance | [
"doc",
"administration",
"dedicated",
"configure_instance"
] | saml.md | null | null | null | null | null |
<!-- markdownlint-disable -->
This document was moved to [another location](authentication/saml.md).
<!-- This redirect file can be deleted after 2025-11-01. -->
<!-- Redirects that point to other docs in the same project expire in three months. -->
<!-- Redirects that point to docs in the same project or site (for... | ---
redirect_to: authentication/saml.md
remove_date: '2025-11-01'
breadcrumbs:
- doc
- administration
- dedicated
- configure_instance
---
<!-- markdownlint-disable -->
This document was moved to [another location](authentication/saml.md).
<!-- This redirect file can be deleted after 2025-11-01. -->
<!-- Redirects ... |
https://docs.gitlab.com/administration/dedicated/configure_instance | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/dedicated/_index.md | 2025-08-13 | doc/administration/dedicated/configure_instance | [
"doc",
"administration",
"dedicated",
"configure_instance"
] | _index.md | GitLab Dedicated | Switchboard | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Configure GitLab Dedicated | Configure your GitLab Dedicated instance with Switchboard. |
{{< details >}}
- Tier: Ultimate
- Offering: GitLab Dedicated
{{< /details >}}
The instructions on this page guide you through configuring your GitLab Dedicated instance, including enabling and updating the settings for [available functionality](../../../subscriptions/gitlab_dedicated/_index.md#available-features)... | ---
stage: GitLab Dedicated
group: Switchboard
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Configure your GitLab Dedicated instance with Switchboard.
title: Configure GitL... |
https://docs.gitlab.com/administration/dedicated/users_notifications | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/dedicated/users_notifications.md | 2025-08-13 | doc/administration/dedicated/configure_instance | [
"doc",
"administration",
"dedicated",
"configure_instance"
] | users_notifications.md | GitLab Dedicated | Switchboard | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | GitLab Dedicated users and notifications | Manage Switchboard users and configure notification preferences, including SMTP email service settings. |
{{< details >}}
- Tier: Ultimate
- Offering: GitLab Dedicated
{{< /details >}}
Manage users who can access Switchboard and configure email notifications for your GitLab Dedicated instance.
## Switchboard user management
Switchboard is the administrative interface for managing your GitLab Dedicated instance.
Swit... | ---
stage: GitLab Dedicated
group: Switchboard
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Manage Switchboard users and configure notification preferences, including
SMT... |
https://docs.gitlab.com/administration/dedicated/network_security | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/dedicated/network_security.md | 2025-08-13 | doc/administration/dedicated/configure_instance | [
"doc",
"administration",
"dedicated",
"configure_instance"
] | network_security.md | GitLab Dedicated | Switchboard | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | GitLab Dedicated network access and security | Configure network access and security settings for GitLab Dedicated. |
{{< details >}}
- Tier: Ultimate
- Offering: GitLab Dedicated
{{< /details >}}
## Bring your own domain (BYOD)
You can use a [custom hostname](../../../subscriptions/gitlab_dedicated/_index.md#bring-your-own-domain) to access your GitLab Dedicated instance. You can also provide a custom hostname for the bundled c... | ---
stage: GitLab Dedicated
group: Switchboard
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Configure network access and security settings for GitLab Dedicated.
title: GitL... |
https://docs.gitlab.com/administration/dedicated/openid_connect | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/dedicated/openid_connect.md | 2025-08-13 | doc/administration/dedicated/configure_instance | [
"doc",
"administration",
"dedicated",
"configure_instance"
] | openid_connect.md | null | null | null | null | null |
<!-- markdownlint-disable -->
This document was moved to [another location](authentication/openid_connect.md).
<!-- This redirect file can be deleted after 2025-11-01. -->
<!-- Redirects that point to other docs in the same project expire in three months. -->
<!-- Redirects that point to docs in the same project or... | ---
redirect_to: authentication/openid_connect.md
remove_date: '2025-11-01'
breadcrumbs:
- doc
- administration
- dedicated
- configure_instance
---
<!-- markdownlint-disable -->
This document was moved to [another location](authentication/openid_connect.md).
<!-- This redirect file can be deleted after 2025-11-01.... |
https://docs.gitlab.com/administration/dedicated/configure_instance/saml | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/dedicated/configure_instance/saml.md | 2025-08-13 | doc/administration/dedicated/configure_instance/authentication | [
"doc",
"administration",
"dedicated",
"configure_instance",
"authentication"
] | saml.md | GitLab Dedicated | Switchboard | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | SAML SSO for GitLab Dedicated | Configure SAML single sign-on (SSO) authentication for GitLab Dedicated. |
{{< details >}}
- Tier: Ultimate
- Offering: GitLab Dedicated
{{< /details >}}
You can configure SAML single sign-on (SSO) for your GitLab Dedicated instance for up to ten identity providers (IdPs).
The following SAML SSO options are available:
- [Request signing](#request-signing)
- [SAML SSO for groups](#saml-... | ---
stage: GitLab Dedicated
group: Switchboard
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Configure SAML single sign-on (SSO) authentication for GitLab Dedicated.
title: ... |
https://docs.gitlab.com/administration/dedicated/configure_instance/authentication | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/dedicated/configure_instance/_index.md | 2025-08-13 | doc/administration/dedicated/configure_instance/authentication | [
"doc",
"administration",
"dedicated",
"configure_instance",
"authentication"
] | _index.md | GitLab Dedicated | Switchboard | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Authentication for GitLab Dedicated | Configure authentication methods for GitLab Dedicated. |
{{< details >}}
- Tier: Ultimate
- Offering: GitLab Dedicated
{{< /details >}}
GitLab Dedicated has two separate authentication contexts:
- Switchboard authentication: How administrators sign in to manage GitLab Dedicated instances.
- Instance authentication: How end users sign in to your GitLab Dedicated instanc... | ---
stage: GitLab Dedicated
group: Switchboard
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Configure authentication methods for GitLab Dedicated.
title: Authentication for... |
https://docs.gitlab.com/administration/dedicated/configure_instance/openid_connect | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/dedicated/configure_instance/openid_connect.md | 2025-08-13 | doc/administration/dedicated/configure_instance/authentication | [
"doc",
"administration",
"dedicated",
"configure_instance",
"authentication"
] | openid_connect.md | GitLab Dedicated | Environment Automation | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | OpenID Connect SSO for GitLab Dedicated | Configure OpenID Connect single sign-on (SSO) authentication for GitLab Dedicated. |
{{< details >}}
- Tier: Ultimate
- Offering: GitLab Dedicated
{{< /details >}}
Configure OpenID Connect (OIDC) single sign-on (SSO) for your GitLab Dedicated instance
to authenticate users with your identity provider.
Use OIDC SSO when you want to:
- Centralize user authentication through your existing identity ... | ---
stage: GitLab Dedicated
group: Environment Automation
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Configure OpenID Connect single sign-on (SSO) authentication for GitL... |
https://docs.gitlab.com/administration/compute_minutes | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/compute_minutes.md | 2025-08-13 | doc/administration/cicd | [
"doc",
"administration",
"cicd"
] | compute_minutes.md | Verify | Pipeline Execution | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Compute minutes administration | Calculations, quotas, purchase information. |
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Renamed](https://gitlab.com/groups/gitlab-com/-/epics/2150) from "CI/CD minutes" to "compute quota" or "compute minutes" in GitLab 16.1.
{{< /history >}}
Administrators can limit the a... | ---
stage: Verify
group: Pipeline Execution
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Calculations, quotas, purchase information.
title: Compute minutes administration
b... |
https://docs.gitlab.com/administration/job_logs | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/job_logs.md | 2025-08-13 | doc/administration/cicd | [
"doc",
"administration",
"cicd"
] | job_logs.md | Verify | Runner | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Job logs | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
Job logs are sent by a runner while it's processing a job. You can see
logs in places like job pages, pipelines, and email notifications.
## Data flow
In general, there are two states for job logs: `log` and `archive... | ---
stage: Verify
group: Runner
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Job logs
breadcrumbs:
- doc
- administration
- cicd
---
{{< details >}}
- Tier: Free, Premium, Ult... |
https://docs.gitlab.com/administration/cicd | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/_index.md | 2025-08-13 | doc/administration/cicd | [
"doc",
"administration",
"cicd"
] | _index.md | Verify | Pipeline Execution | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | GitLab CI/CD instance configuration | Manage GitLab CI/CD configuration. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
GitLab administrators can manage the GitLab CI/CD configuration for their instance.
## Disable GitLab CI/CD in new projects
GitLab CI/CD is enabled by default in all new projects on an instance. You can set
CI/CD to ... | ---
stage: Verify
group: Pipeline Execution
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: GitLab CI/CD instance configuration
description: Manage GitLab CI/CD configuration.
bread... |
https://docs.gitlab.com/administration/maintenance | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/maintenance.md | 2025-08-13 | doc/administration/cicd | [
"doc",
"administration",
"cicd"
] | maintenance.md | Verify | Pipeline Execution | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | CI/CD maintenance console commands | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
The following commands are run in the [Rails console](../operations/rails_console.md#starting-a-rails-console-session).
{{< alert type="warning" >}}
Any command that changes data directly could be damaging if not run... | ---
stage: Verify
group: Pipeline Execution
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: CI/CD maintenance console commands
breadcrumbs:
- doc
- administration
- cicd
---
{{< d... |
https://docs.gitlab.com/administration/secure_files | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/secure_files.md | 2025-08-13 | doc/administration/cicd | [
"doc",
"administration",
"cicd"
] | secure_files.md | Verify | Mobile DevOps | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Secure Files administration | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
{{< history >}}
- [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/350748) and feature flag `ci_secure_files` removed in GitLab 15.7.
{{< /history >}}
You can securely store up to 100 files for us... | ---
stage: Verify
group: Mobile DevOps
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Secure Files administration
breadcrumbs:
- doc
- administration
- cicd
---
{{< details >}}
... |
https://docs.gitlab.com/administration/job_artifacts_troubleshooting | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/job_artifacts_troubleshooting.md | 2025-08-13 | doc/administration/cicd | [
"doc",
"administration",
"cicd"
] | job_artifacts_troubleshooting.md | Verify | Pipeline Execution | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Job artifact troubleshooting for administrators | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
When administering job artifacts, you might encounter the following issues.
## Job artifacts using too much disk space
Job artifacts can fill up your disk space quicker than expected. Some possible
reasons are:
- Us... | ---
stage: Verify
group: Pipeline Execution
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Job artifact troubleshooting for administrators
breadcrumbs:
- doc
- administration
- cic... |
https://docs.gitlab.com/administration/job_artifacts | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/job_artifacts.md | 2025-08-13 | doc/administration/cicd | [
"doc",
"administration",
"cicd"
] | job_artifacts.md | Verify | Pipeline Execution | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Jobs artifacts administration | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
This is the administration documentation. To learn how to use job artifacts in your GitLab CI/CD pipeline,
see the [job artifacts configuration documentation](../../ci/jobs/job_artifacts.md).
An artifact is a list of ... | ---
stage: Verify
group: Pipeline Execution
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Jobs artifacts administration
breadcrumbs:
- doc
- administration
- cicd
---
{{< detail... |
https://docs.gitlab.com/administration/external_pipeline_validation | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/external_pipeline_validation.md | 2025-08-13 | doc/administration/cicd | [
"doc",
"administration",
"cicd"
] | external_pipeline_validation.md | Verify | Pipeline Execution | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | External pipeline validation | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
You can use an external service to validate a pipeline before it's created.
GitLab sends a POST request to the external service URL with the pipeline
data as payload. The response code from the external service determ... | ---
stage: Verify
group: Pipeline Execution
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: External pipeline validation
breadcrumbs:
- doc
- administration
- cicd
---
{{< details... |
https://docs.gitlab.com/administration/dot_com_compute_minutes | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/dot_com_compute_minutes.md | 2025-08-13 | doc/administration/cicd | [
"doc",
"administration",
"cicd"
] | dot_com_compute_minutes.md | Verify | Pipeline Execution | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Compute minutes administration for GitLab.com | Configure cost factor settings for compute minutes on GitLab.com. |
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com
{{< /details >}}
GitLab.com administrators have additional controls over compute minutes beyond what is
available for [GitLab Self-Managed](compute_minutes.md).
## Set cost factors
Prerequisites:
- You must be an administrator for GitLab.com.
To ... | ---
stage: Verify
group: Pipeline Execution
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Configure cost factor settings for compute minutes on GitLab.com.
title: Compute mi... |
https://docs.gitlab.com/administration/kas | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/kas.md | 2025-08-13 | doc/administration/clusters | [
"doc",
"administration",
"clusters"
] | kas.md | Deploy | Environments | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Install the GitLab agent server for Kubernetes (KAS) | Manage the GitLab agent for Kubernetes. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
The agent server is a component installed together with GitLab. It is required to
manage the [GitLab agent for Kubernetes](https://gitlab.com/gitlab-org/cluster-integration/gitlab-agent).
The KAS acronym refers to the... | ---
stage: Deploy
group: Environments
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Install the GitLab agent server for Kubernetes (KAS)
description: Manage the GitLab agent for K... |
https://docs.gitlab.com/administration/spamcheck | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/spamcheck.md | 2025-08-13 | doc/administration/reporting | [
"doc",
"administration",
"reporting"
] | spamcheck.md | GitLab Delivery | Self Managed | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Spamcheck anti-spam service | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
{{< alert type="warning" >}}
Spamcheck is available to all tiers, but only on instances using GitLab Enterprise Edition (EE). For [licensing reasons](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/6259#note_726... | ---
stage: GitLab Delivery
group: Self Managed
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Spamcheck anti-spam service
breadcrumbs:
- doc
- administration
- reporting
---
{{< ... |
https://docs.gitlab.com/administration/git_abuse_rate_limit | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/git_abuse_rate_limit.md | 2025-08-13 | doc/administration/reporting | [
"doc",
"administration",
"reporting"
] | git_abuse_rate_limit.md | Software Supply Chain Security | Authorization | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Git abuse rate limit (administration) | null |
{{< details >}}
- Tier: Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/8066) in GitLab 15.2 [with a flag](../feature_flags/_index.md) named `git_abuse_rate_limit_feature_flag`. Disabled by default.
- [Generall... | ---
stage: Software Supply Chain Security
group: Authorization
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
gitlab_dedicated: true
title: Git abuse rate limit (administration)
breadcrum... |
https://docs.gitlab.com/administration/ip_addr_restrictions | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/ip_addr_restrictions.md | 2025-08-13 | doc/administration/reporting | [
"doc",
"administration",
"reporting"
] | ip_addr_restrictions.md | Software Supply Chain Security | Authorization | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | IP address restrictions | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
IP address restrictions help prevent malicious users hiding their activities behind multiple IP addresses.
GitLab maintains a list of the unique IP addresses used by a user to make requests over a sp... | ---
stage: Software Supply Chain Security
group: Authorization
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: IP address restrictions
breadcrumbs:
- doc
- administration
- reportin... |
https://docs.gitlab.com/administration/list | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administration/list.md | 2025-08-13 | doc/administration/feature_flags | [
"doc",
"administration",
"feature_flags"
] | list.md | none | unassigned | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | All feature flags in GitLab | Complete list of all feature flags in GitLab. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
GitLab provides feature flags to turn specific features on or off.
This page contains a list of all feature flags provided by GitLab. In GitLab Self-Managed,
GitLab administrators can [change the state of these feature... | ---
stage: none
group: unassigned
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Complete list of all feature flags in GitLab.
title: All feature flags in GitLab
layout: feat... |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.