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/api/links | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api/links.md | 2025-08-13 | doc/api/releases | [
"doc",
"api",
"releases"
] | links.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 | Release links API | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Added](https://gitlab.com/gitlab-org/gitlab/-/issues/250819) authentication with a [GitLab CI/CD job token](../../ci/jobs/ci_job_token.md) in GitLab 15.1.
{{< /history... | ---
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: Release links API
breadcrumbs:
- doc
- api
- releases
---
{{< details >}}
- Tier: Free, Prem... |
https://docs.gitlab.com/api/terraform-modules | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api/terraform-modules.md | 2025-08-13 | doc/api/packages | [
"doc",
"api",
"packages"
] | terraform-modules.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 | Terraform Module Registry API | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
This is the API documentation for the [Terraform Module Registry](../../user/packages/terraform_module_registry/_index.md).
{{< alert type="warning" >}}
This API is used by the [Terrafor... | ---
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: Terraform Module Registry API
breadcrumbs:
- doc
- api
- packages
---
{{< details >}}
-... |
https://docs.gitlab.com/api/helm | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api/helm.md | 2025-08-13 | doc/api/packages | [
"doc",
"api",
"packages"
] | helm.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 | Helm API | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
This is the API documentation for [Helm](../../user/packages/helm_repository/_index.md).
{{< alert type="warning" >}}
This API is used by the Helm-related package clients such as [Helm](... | ---
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: Helm API
breadcrumbs:
- doc
- api
- packages
---
{{< details >}}
- Tier: Free, Premium,... |
https://docs.gitlab.com/api/pypi | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api/pypi.md | 2025-08-13 | doc/api/packages | [
"doc",
"api",
"packages"
] | pypi.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 | PyPI API | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
This is the API documentation for [PyPI Packages](../../user/packages/pypi_repository/_index.md).
{{< alert type="warning" >}}
This API is used by the [PyPI package manager client](https... | ---
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: PyPI API
breadcrumbs:
- doc
- api
- packages
---
{{< details >}}
- Tier: Free, Premium,... |
https://docs.gitlab.com/api/conan_v1 | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api/conan_v1.md | 2025-08-13 | doc/api/packages | [
"doc",
"api",
"packages"
] | conan_v1.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 | Conan v1 API | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< alert type="note" >}}
For Conan v2 operations, see [Conan v2 API](conan_v2.md).
{{< /alert >}}
Use this API to interact with the Conan v1 package manager. These endpoints work for b... | ---
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: Conan v1 API
breadcrumbs:
- doc
- api
- packages
---
{{< details >}}
- Tier: Free, Prem... |
https://docs.gitlab.com/api/npm | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api/npm.md | 2025-08-13 | doc/api/packages | [
"doc",
"api",
"packages"
] | npm.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 | npm API | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
This is the API documentation for [npm Packages](../../user/packages/npm_registry/_index.md).
{{< alert type="warning" >}}
This API is used by the [npm package manager client](https://do... | ---
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: npm API
breadcrumbs:
- doc
- api
- packages
---
{{< details >}}
- Tier: Free, Premium, ... |
https://docs.gitlab.com/api/maven | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api/maven.md | 2025-08-13 | doc/api/packages | [
"doc",
"api",
"packages"
] | maven.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 | Maven API | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
This is the API documentation for [Maven Packages](../../user/packages/maven_repository/_index.md).
{{< alert type="warning" >}}
This API is used by the [Maven package manager client](ht... | ---
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: Maven API
breadcrumbs:
- doc
- api
- packages
---
{{< details >}}
- Tier: Free, Premium... |
https://docs.gitlab.com/api/debian_project_distributions | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api/debian_project_distributions.md | 2025-08-13 | doc/api/packages | [
"doc",
"api",
"packages"
] | debian_project_distributions.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 | Debian project distributions API | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
{{< history >}}
- [Deployed behind a feature flag](../../administration/feature_flags/_index.md), disabled by default.
{{< /history >}}
This is the reference documentation for the Debian project distributions API. T... | ---
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: Debian project distributions API
breadcrumbs:
- doc
- api
- packages
---
{{< details >}}... |
https://docs.gitlab.com/api/debian | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api/debian.md | 2025-08-13 | doc/api/packages | [
"doc",
"api",
"packages"
] | debian.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 | Debian API | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
{{< history >}}
- [Deployed behind a feature flag](../../administration/feature_flags/_index.md), disabled by default.
{{< /history >}}
This is the API documentation for [Debian](../../user/packages/debian_repositor... | ---
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: Debian API
breadcrumbs:
- doc
- api
- packages
---
{{< details >}}
- Tier: Free, Premiu... |
https://docs.gitlab.com/api/debian_group_distributions | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api/debian_group_distributions.md | 2025-08-13 | doc/api/packages | [
"doc",
"api",
"packages"
] | debian_group_distributions.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 | Debian group distributions API | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
{{< history >}}
- [Deployed behind a feature flag](../../administration/feature_flags/_index.md), disabled by default.
{{< /history >}}
This is the reference documentation for the Debian group distributions API. Thi... | ---
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: Debian group distributions API
breadcrumbs:
- doc
- api
- packages
---
{{< details >}}
... |
https://docs.gitlab.com/api/nuget | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api/nuget.md | 2025-08-13 | doc/api/packages | [
"doc",
"api",
"packages"
] | nuget.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 | NuGet API | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
This is the API documentation for [NuGet Packages](../../user/packages/nuget_repository/_index.md).
{{< alert type="warning" >}}
This API is used by the [NuGet package manager client](ht... | ---
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: NuGet API
breadcrumbs:
- doc
- api
- packages
---
{{< details >}}
- Tier: Free, Premium... |
https://docs.gitlab.com/api/composer | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api/composer.md | 2025-08-13 | doc/api/packages | [
"doc",
"api",
"packages"
] | composer.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 | Composer API | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
This is the API documentation for [Composer Packages](../../user/packages/composer_repository/_index.md).
{{< alert type="warning" >}}
This API is used by the [Composer package manager c... | ---
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: Composer API
breadcrumbs:
- doc
- api
- packages
---
{{< details >}}
- Tier: Free, Prem... |
https://docs.gitlab.com/api/rubygems | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api/rubygems.md | 2025-08-13 | doc/api/packages | [
"doc",
"api",
"packages"
] | rubygems.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 | Ruby gems API | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
This is the API documentation for [Ruby gems](../../user/packages/rubygems_registry/_index.md).
{{< alert type="warning" >}}
This API is used by the [Ruby gems and Bundler package manager clients](h... | ---
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: Ruby gems API
breadcrumbs:
- doc
- api
- packages
---
{{< details >}}
- Tier: Free, Pre... |
https://docs.gitlab.com/api/conan_v2 | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api/conan_v2.md | 2025-08-13 | doc/api/packages | [
"doc",
"api",
"packages"
] | conan_v2.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 | Conan v2 API | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/519741) in GitLab 17.11 [with a flag](../../administration/feature_flags/_index.md) named `conan_package_revis... | ---
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: Conan v2 API
breadcrumbs:
- doc
- api
- packages
---
{{< details >}}
- Tier: Free, Prem... |
https://docs.gitlab.com/api/go_proxy | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api/go_proxy.md | 2025-08-13 | doc/api/packages | [
"doc",
"api",
"packages"
] | go_proxy.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 | Go Proxy API | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
This is the API documentation for [Go Packages](../../user/packages/go_proxy/_index.md).
This API is behind a feature flag that is disabled by default. GitLab administrators with access to
the GitLab ... | ---
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: Go Proxy API
breadcrumbs:
- doc
- api
- packages
---
{{< details >}}
- Tier: Free, Prem... |
https://docs.gitlab.com/api/get_started_extending | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api/get_started_extending.md | 2025-08-13 | doc/api/get_started | [
"doc",
"api",
"get_started"
] | get_started_extending.md | none | none | 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 | Get started extending GitLab | Interact programmatically with GitLab. |
Interact programmatically with GitLab.
Automate tasks, integrate with other tools, and create custom workflows.
GitLab also supports plugins and custom hooks.
Follow these steps to learn more about extending GitLab.
## Step 1: Set up integrations
GitLab has several major integrations that can help streamline your ... | ---
stage: none
group: none
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: Interact programmatically with GitLab.
title: Get started extending GitLab
breadcrumbs:
- doc
- api... |
https://docs.gitlab.com/api/authentication | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api/authentication.md | 2025-08-13 | doc/api/rest | [
"doc",
"api",
"rest"
] | authentication.md | Developer Experience | API | 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 | REST API authentication | Authenticate with the GitLab REST API by using OAuth 2.0, access, and job tokens. |
Most API requests require authentication, or return only public data when authentication isn't
provided. When authentication is not required, the documentation for each endpoint specifies this.
For example, the [`/projects/:id` endpoint](../projects.md#get-a-single-project) does not require
authentication.
You can a... | ---
stage: Developer Experience
group: API
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: Authenticate with the GitLab REST API by using OAuth 2.0, access, and
job tokens.
... |
https://docs.gitlab.com/api/deprecations | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api/deprecations.md | 2025-08-13 | doc/api/rest | [
"doc",
"api",
"rest"
] | deprecations.md | Developer Experience | API | 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 | REST API deprecations | List of deprecated fields and planned breaking changes in the GitLab REST API. |
You should regularly review the following deprecations and make the recommended changes. These deprecations often signal improved API features and recommend using new fields
or endpoints for features.
Though some deprecations mention a v5 REST API, no v5 REST API development is active.
GitLab will not make these cha... | ---
stage: Developer Experience
group: API
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: REST API deprecations
description: List of deprecated fields and planned breaking changes ... |
https://docs.gitlab.com/api/troubleshooting | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api/troubleshooting.md | 2025-08-13 | doc/api/rest | [
"doc",
"api",
"rest"
] | troubleshooting.md | Developer Experience | API | 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 REST API | Troubleshooting the GitLab REST API. Includes status codes, error responses, spam detection, and reverse proxy issues. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
When working with the REST API, you might encounter an issue.
To troubleshoot, refer to the REST API status codes. It might also help to include the HTTP response headers and exit code.
... | ---
stage: Developer Experience
group: API
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: Troubleshooting the GitLab REST API. Includes status codes, error responses,
spam ... |
https://docs.gitlab.com/api/rest | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api/_index.md | 2025-08-13 | doc/api/rest | [
"doc",
"api",
"rest"
] | _index.md | Developer Experience | API | 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 | REST API | Use the GitLab REST API for programmatic interaction with GitLab. Includes requests, rate limits, pagination, encoding, versioning, and response handling. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Automate your workflows and build integrations with the GitLab REST API:
- Create custom tools to manage your GitLab resources at scale without manual intervention.
- Improve collaboratio... | ---
stage: Developer Experience
group: API
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 the GitLab REST API for programmatic interaction with GitLab. Includes
request... |
https://docs.gitlab.com/api/third_party_clients | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api/third_party_clients.md | 2025-08-13 | doc/api/rest | [
"doc",
"api",
"rest"
] | third_party_clients.md | Developer Experience | API | 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 | REST API third-party clients | List of community-maintained client libraries for the GitLab REST API. |
{{< details >}}
- Tier: Free
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
You can integrate third-party API client libraries with GitLab. The following libraries are
maintained by community members and not officially supported by GitLab. Report bugs and feature
proposals to the re... | ---
stage: Developer Experience
group: API
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: List of community-maintained client libraries for the GitLab REST API.
title: REST A... |
https://docs.gitlab.com/api/ai_impact_analytics | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api/ai_impact_analytics.md | 2025-08-13 | doc/api/graphql | [
"doc",
"api",
"graphql"
] | ai_impact_analytics.md | Plan | Optimize | 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 | Retrieve AI impact analytics data | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Add-on: GitLab Duo Pro, GitLab Duo Enterprise
- Offering: GitLab Self-Managed
{{< /details >}}
Use the GraphQL API to retrieve and export AI impact analytics data.
## Retrieve AI usage data
{{< details >}}
- Add-on: GitLab Duo Enterprise
{{< /details >}}
{{< h... | ---
stage: Plan
group: Optimize
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: Retrieve AI impact analytics data
breadcrumbs:
- doc
- api
- graphql
---
{{< details >}}
- Tier: F... |
https://docs.gitlab.com/api/audit_event_streaming_groups | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api/audit_event_streaming_groups.md | 2025-08-13 | doc/api/graphql | [
"doc",
"api",
"graphql"
] | audit_event_streaming_groups.md | Software Supply Chain Security | Compliance | 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 | Audit event streaming GraphQL API for top-level groups | null |
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- Custom HTTP headers API [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/361216) in GitLab 15.1 [with a flag](../feature_flags.md) named `streaming_audit_event_headers`. Disa... | ---
stage: Software Supply Chain Security
group: Compliance
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: Audit event streaming GraphQL API for top-level groups
breadcrumbs:
- doc... |
https://docs.gitlab.com/api/graphql | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api/_index.md | 2025-08-13 | doc/api/graphql | [
"doc",
"api",
"graphql"
] | _index.md | Developer Experience | API | 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 | GraphQL API | Programmatic interaction with GitLab. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
[GraphQL](https://graphql.org/) is a query language for APIs. You can use it to
request the exact data you need, and therefore limit the number of requests you need.
GraphQL data is arran... | ---
stage: Developer Experience
group: API
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: Programmatic interaction with GitLab.
title: GraphQL API
breadcrumbs:
- doc
- api
- ... |
https://docs.gitlab.com/api/sample_issue_boards | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api/sample_issue_boards.md | 2025-08-13 | doc/api/graphql | [
"doc",
"api",
"graphql"
] | sample_issue_boards.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 | Identify issue boards by using GraphQL | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
You can identify [issue boards](../../user/project/issue_board.md) for a project by using:
- GraphiQL.
- [`cURL`](getting_started.md#command-line).
## Use GraphiQL
You can use GraphiQL ... | ---
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
title: Identify issue boards by using GraphQL
breadcrumbs:
- doc
- api
- graphql
---
{{< details... |
https://docs.gitlab.com/api/assign_gitlab_duo_seats | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api/assign_gitlab_duo_seats.md | 2025-08-13 | doc/api/graphql | [
"doc",
"api",
"graphql"
] | assign_gitlab_duo_seats.md | Fulfillment | Provision | 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 | Assign GitLab Duo seats by using GraphQL | null |
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/146620) in GitLab 16.11.
{{< /history >}}
Use the GraphQL API to assign GitLab Duo seats to users.
## Pre... | ---
stage: Fulfillment
group: Provision
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: Assign GitLab Duo seats by using GraphQL
breadcrumbs:
- doc
- api
- graphql
---
{{< details... |
https://docs.gitlab.com/api/custom_emoji | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api/custom_emoji.md | 2025-08-13 | doc/api/graphql | [
"doc",
"api",
"graphql"
] | custom_emoji.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 | Use custom emoji with GraphQL | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/37911) in GitLab 13.6 [with a flag](../../administration/feature_flags/_index.md) named `custom_emoji`... | ---
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
title: Use custom emoji with GraphQL
breadcrumbs:
- doc
- api
- graphql
---
{{< details >}}
- T... |
https://docs.gitlab.com/api/examples | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api/examples.md | 2025-08-13 | doc/api/graphql | [
"doc",
"api",
"graphql"
] | examples.md | Developer Experience | API | 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 | GraphQL examples | List of examples for the GitLab GraphQL API. |
GraphQL examples are available for you to test and modify.
- [Audit event streaming for instances](audit_event_streaming_instances.md)
- [Audit event streaming for groups](audit_event_streaming_groups.md)
- [Set up an audit report](audit_report.md)
- [Identify issue boards](sample_issue_boards.md)
- [List branch rul... | ---
stage: Developer Experience
group: API
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: GraphQL examples
description: List of examples for the GitLab GraphQL API.
breadcrumbs:
- ... |
https://docs.gitlab.com/api/users_example | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api/users_example.md | 2025-08-13 | doc/api/graphql | [
"doc",
"api",
"graphql"
] | users_example.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 | Query users by using GraphQL | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
You can query a subset of users in a GitLab instance by using:
- GraphiQL.
- [`cURL`](getting_started.md#command-line).
## Use GraphiQL
1. Open GraphiQL:
- For GitLab.com, use: `http... | ---
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: Query users by using GraphQL
breadcrumbs:
- doc
- api
- graphql
---
... |
https://docs.gitlab.com/api/branch_rules | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api/branch_rules.md | 2025-08-13 | doc/api/graphql | [
"doc",
"api",
"graphql"
] | branch_rules.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 | List branch rules for a project by using GraphQL | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
You can query for branch rules in a given project by using:
- GraphiQL.
- [`cURL`](getting_started.md#command-line).
- [The GitLab Development Kit (GDK)](#use-the-gdk).
## Use GraphiQL
... | ---
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: List branch rules for a project by using GraphQL
breadcrumbs:
- doc
- api
- graphql
---
{{< de... |
https://docs.gitlab.com/api/getting_started | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api/getting_started.md | 2025-08-13 | doc/api/graphql | [
"doc",
"api",
"graphql"
] | getting_started.md | Developer Experience | API | 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 GraphQL API queries and mutations | Guide to running GraphQL queries and mutations with examples. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
This guide demonstrates basic usage of the GitLab GraphQL API.
## Running examples
The examples documented here can be run using:
- [GraphiQL](#graphiql).
- [Command line](#command-line... | ---
stage: Developer Experience
group: API
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 GraphQL API queries and mutations
description: Guide to running GraphQL queries and mu... |
https://docs.gitlab.com/api/audit_report | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api/audit_report.md | 2025-08-13 | doc/api/graphql | [
"doc",
"api",
"graphql"
] | audit_report.md | Software Supply Chain Security | Compliance | 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 an audit report by using GraphQL | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
You can create an audit report for a specific subset of users by using:
- GraphiQL.
- [`cURL`](getting_started.md#command-line).
## Use GraphiQL
You can use GraphiQL to query informatio... | ---
stage: Software Supply Chain Security
group: Compliance
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: Create an audit report by using GraphQL
breadcrumbs:
- doc
- api
- graphq... |
https://docs.gitlab.com/api/epic_work_items_api_migration_guide | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api/epic_work_items_api_migration_guide.md | 2025-08-13 | doc/api/graphql | [
"doc",
"api",
"graphql"
] | epic_work_items_api_migration_guide.md | Plan | Product Planning | 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 epic APIs to work items | null |
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
- Status: Beta
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/9290) in GitLab 17.2 [with a flag](../../administration/feature_flags/_index.md) named `work_item_epic... | ---
stage: Plan
group: Product Planning
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 epic APIs to work items
breadcrumbs:
- doc
- api
- graphql
---
{{< details >}}
- T... |
https://docs.gitlab.com/api/audit_event_streaming_instances | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api/audit_event_streaming_instances.md | 2025-08-13 | doc/api/graphql | [
"doc",
"api",
"graphql"
] | audit_event_streaming_instances.md | Software Supply Chain Security | Compliance | 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 | Audit event streaming GraphQL API for instances | null |
{{< details >}}
- Tier: Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/335175) in GitLab 16.0 [with a flag](../feature_flags.md) named `ff_external_audit_events`. Disabled by default.
- APIs for custom HTTP h... | ---
stage: Software Supply Chain Security
group: Compliance
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: Audit event streaming GraphQL API for instances
breadcrumbs:
- doc
- api
... |
https://docs.gitlab.com/api/removed_items | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api/removed_items.md | 2025-08-13 | doc/api/graphql | [
"doc",
"api",
"graphql"
] | removed_items.md | Developer Experience | API | 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 | GraphQL API removed items | List of deprecated and removed items in the GitLab GraphQL API. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
GraphQL is a versionless API, unlike the REST API.
Occasionally, items have to be updated or removed from the GraphQL API.
According to our [process for removing items](_index.md#deprecati... | ---
stage: Developer Experience
group: API
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: GraphQL API removed items
description: List of deprecated and removed items in the GitLab ... |
https://docs.gitlab.com/api/graphql/reference | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api/graphql/_index.md | 2025-08-13 | doc/api/graphql/reference | [
"doc",
"api",
"graphql",
"reference"
] | _index.md | Developer Experience | API | 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 | GraphQL API resources | null |
<!--
This documentation is auto generated by a script.
Please do not edit this file directly.
To edit the introductory text, modify `tooling/graphql/docs/templates/default.md.haml`.
Run `bundle exec rake gitlab:graphql:compile_docs`
or check the `compile_docs` task in `lib/tasks/gitlab/graphql.rake`.
-->
... | ---
stage: Developer Experience
group: API
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: GraphQL API resources
breadcrumbs:
- doc
- api
- graphql
- reference
---
<!--
This doc... |
https://docs.gitlab.com/api/openapi_interactive | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api/openapi_interactive.md | 2025-08-13 | doc/api/openapi | [
"doc",
"api",
"openapi"
] | openapi_interactive.md | Developer Experience | API | 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 | Interactive API documentation | Use OpenAPI to test the GitLab REST API. |
The [OpenAPI specification](https://swagger.io/specification/) (formerly called Swagger) defines a
standard, language-agnostic interface to RESTful APIs. OpenAPI definition files are written in the
YAML format, which is automatically rendered by the GitLab browser into a more human-readable interface.
For general in... | ---
stage: Developer Experience
group: API
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: Interactive API documentation
description: Use OpenAPI to test the GitLab REST API.
breadc... |
https://docs.gitlab.com/api/metrics | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api/metrics.md | 2025-08-13 | doc/api/dora | [
"doc",
"api",
"dora"
] | metrics.md | Plan | Optimize | 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 | DevOps Research and Assessment (DORA) metrics API | Retrieve project and group DORA metrics with the REST API. |
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Use this API to retrieve details of [DORA metrics](../../user/analytics/dora_metrics.md) for your groups and projects.
Additional endpoints are available with the [GraphQL API](../graphql/reference/_ind... | ---
stage: Plan
group: Optimize
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: Retrieve project and group DORA metrics with the REST API.
title: DevOps Research and Assessmen... |
https://docs.gitlab.com/api/gitlab_ci_ymls | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api/gitlab_ci_ymls.md | 2025-08-13 | doc/api/templates | [
"doc",
"api",
"templates"
] | gitlab_ci_ymls.md | Verify | Pipeline Authoring | 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 templates API | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Use this API to retreive available [CI/CD templates](https://gitlab.com/gitlab-org/gitlab/-/tree/master/lib/gitlab/ci/templates).
Users with the Guest role cannot access CI/CD templates. ... | ---
stage: Verify
group: Pipeline Authoring
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 templates API
breadcrumbs:
- doc
- api
- templates
---
{{< details >}}
- Tier: F... |
https://docs.gitlab.com/api/gitignores | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api/gitignores.md | 2025-08-13 | doc/api/templates | [
"doc",
"api",
"templates"
] | gitignores.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 | .gitignore API | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
In GitLab, the `/gitignores` endpoint returns a list of Git `.gitignore` templates. For more information,
see the [Git documentation for `.gitignore`](https://git-scm.com/docs/gitignore).
... | ---
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: .gitignore API
breadcrumbs:
- doc
- api
- templates
---
{{< details >}}
- Tier: Free, Premium... |
https://docs.gitlab.com/api/licenses | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api/licenses.md | 2025-08-13 | doc/api/templates | [
"doc",
"api",
"templates"
] | licenses.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 | Licenses API | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
In GitLab, there is an API endpoint available for working with various open
source license templates. For more information on the terms of various
licenses, see [this site](https://choosea... | ---
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: Licenses API
breadcrumbs:
- doc
- api
- templates
---
{{< detai... |
https://docs.gitlab.com/api/dockerfiles | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api/dockerfiles.md | 2025-08-13 | doc/api/templates | [
"doc",
"api",
"templates"
] | dockerfiles.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 | Dockerfiles API | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
GitLab provides an API endpoint for Dockerfile templates available to the entire instance.
Default templates are defined at
[`vendor/Dockerfile`](https://gitlab.com/gitlab-org/gitlab-foss/... | ---
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: Dockerfiles API
breadcrumbs:
- doc
- api
- templates
---
{{< details >}}
- Tier: Free, Premiu... |
https://docs.gitlab.com/custom_project_templates | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/custom_project_templates.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | custom_project_templates.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 | Custom project templates for your instance | Configure project templates and make them available to all projects on your GitLab instance. |
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
To speed up the creation of projects on your instance, configure a group that contains template
projects. Users can then create
[new projects based on your templates](../user/project/_index.md#create-a-proj... | ---
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: true
description: Configure project templates and make them available to all projects... |
https://docs.gitlab.com/static_objects_external_storage | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/static_objects_external_storage.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | static_objects_external_storage.md | Create | Remote Development | 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 storage for static objects | Configure external storage, such as a CDN, for static objects in your GitLab repository. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
Configure GitLab to serve repository static objects (such as archives or raw blobs) from external
storage such as a content delivery network (CDN).
## Configure external storage
To configure external storage for stat... | ---
stage: Create
group: Remote Development
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 external storage, such as a CDN, for static objects in your
GitLab repo... |
https://docs.gitlab.com/issue_closing_pattern | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/issue_closing_pattern.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | issue_closing_pattern.md | Create | Code Review | 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 | Issue closing pattern | Instance administrators can configure a custom issue closing pattern for their GitLab instance. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
{{< alert type="note" >}}
For user documentation about issue closing patterns, see
[Closing issues automatically](../user/project/issues/managing_issues.md#closing-issues-automatically).
{{< /alert >}}
When a commit... | ---
stage: Create
group: Code Review
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: Instance administrators can configure a custom issue closing pattern
for their GitLab in... |
https://docs.gitlab.com/email_from_gitlab | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/email_from_gitlab.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | email_from_gitlab.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 | Email from GitLab | null |
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Administrators can email all users, or users of a chosen group or project.
Users receive the email at their primary email address.
You might use this functionality to notify your users:
- About a new proj... | ---
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
gitlab_dedicated: true
title: Email from GitLab
breadcrumbs:
- doc
- administration
---
{{< details >}}
... |
https://docs.gitlab.com/server_hooks | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/server_hooks.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | server_hooks.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 | Git server hooks | Configure Git server hooks. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
{{< history >}}
- [Renamed](https://gitlab.com/gitlab-org/gitlab/-/issues/372991) from server hooks to Git server hooks in GitLab 15.6.
{{< /history >}}
Git server hooks (not to be confused with [system hooks](syste... | ---
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: Git server hooks
description: Configure Git server hooks.
breadcrumbs:
- doc
- administration
--... |
https://docs.gitlab.com/file_hooks | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/file_hooks.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | file_hooks.md | Create | Import | 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 | File hooks | Create custom file hooks to integrate your GitLab Self-Managed instance with external services without modifying source code. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
Use custom file hooks (not to be confused with [server hooks](server_hooks.md) or [system hooks](system_hooks.md)),
to introduce custom integrations without modifying the GitLab source code.
A file hook runs on each e... | ---
stage: Create
group: Import
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: File hooks
description: Create custom file hooks to integrate your GitLab Self-Managed instance
wit... |
https://docs.gitlab.com/libravatar | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/libravatar.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | libravatar.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 | Using the Libravatar service with GitLab | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
GitLab by default supports the [Gravatar](https://gravatar.com) avatar service.
Libravatar is another service that delivers your avatar (profile picture) to
other websites. The Libravatar API is
[heavily based on Grav... | ---
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: Using the Libravatar service with GitLab
breadcrumbs:
- doc
- administration
---
{{<... |
https://docs.gitlab.com/auditor_users | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/auditor_users.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | auditor_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 | Auditor users | null |
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Auditor users have read-only access to all groups, projects, and other resources in the instance.
Auditor users:
- Have read-only access to all groups and projects.
- Due to a [known issue](https://gitl... | ---
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: Auditor users
breadcrumbs:
- doc
- administration
---
{{< details >... |
https://docs.gitlab.com/environment_variables | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/environment_variables.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | environment_variables.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 | Environment variables | Override supported environment variables. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
GitLab exposes certain environment variables which can be used to override
their defaults values.
People usually configure GitLab with:
- `/etc/gitlab/gitlab.rb` for Linux package installations.
- `gitlab.yml` for se... | ---
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: Environment variables
description: Override supported environment variables.
breadcrum... |
https://docs.gitlab.com/load_balancer | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/load_balancer.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | load_balancer.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 | Load Balancer for multi-node GitLab | Use a load balancer with multi-node a multi-node instance. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
In a multi-node GitLab configuration, you need a load balancer to route
traffic to the application servers. The specifics on which load balancer to use
or the exact configuration is beyond the scope of GitLab documenta... | ---
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: Load Balancer for multi-node GitLab
description: Use a load balancer with multi-node a... |
https://docs.gitlab.com/read_only_gitlab | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/read_only_gitlab.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | read_only_gitlab.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 | Place GitLab into a read-only state | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
{{< alert type="note" >}}
The recommended method to place GitLab in a read-only state is to enable
[maintenance mode](maintenance_mode/_index.md).
{{< /alert >}}
In some cases, you might want to place GitLab under a... | ---
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: Place GitLab into a read-only state
breadcrumbs:
- doc
- administration
---
{{< deta... |
https://docs.gitlab.com/diff_limits | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/diff_limits.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | diff_limits.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 | Diff limits administration | Configure the maximum diff size to display on GitLab Self-Managed. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Showing the full contents of large files can cause merge requests to load more slowly.
To prevent this, set maximum values for the diff size, number of files changed, and number of
lines changed.
Whe... | ---
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: true
description: Configure the maximum diff size to display on GitLab Self-Managed.
... |
https://docs.gitlab.com/appearance | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/appearance.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | appearance.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 | GitLab appearance | Customize your GitLab instance appearance, including logos, favicons, sign-in pages, Progressive Web App settings, system messages, and color themes. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
You can update your settings to change the look and feel of your instance.
To open the **Appearance** settings:
1. On the left sidebar, at the bottom, select **Admin**.
1. Select **Settings > Appear... | ---
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
gitlab_dedicated: true
description: Customize your GitLab instance appearance, including logos, favicons,
... |
https://docs.gitlab.com/configure | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/configure.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | configure.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 | Configure GitLab | Configuration settings. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
Customize and configure GitLab Self-Managed.
- [Admin area](admin_area.md)
- [Agent server for Kubernetes](clusters/kas.md)
- [Application cache interval](application_settings_cache.md)
- [Cells](cells.md)
- [CI/CD](c... | ---
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
description: Configuration settings.
title: Configure GitLab
breadcrumbs:
- doc
- administrat... |
https://docs.gitlab.com/custom_html_header_tags | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/custom_html_header_tags.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | custom_html_header_tags.md | Software Supply Chain Security | Compliance | 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 | Custom HTML header tags | Learn how to modify the HTML header tags of your GitLab instance. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/153877) in GitLab 17.1.
{{< /history >}}
If you self-manage a GitLab instance in the EU, or any jurisdiction that
requires a cooki... | ---
stage: Software Supply Chain Security
group: Compliance
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 to modify the HTML header tags of your GitLab instance.
t... |
https://docs.gitlab.com/internal_users | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/internal_users.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | internal_users.md | Software Supply Chain Security | Compliance | 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 | Internal users | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/97584) in GitLab 15.4, bots are indicated with a badge in user listings.
{{< /history >}}
GitLab use... | ---
stage: Software Supply Chain Security
group: Compliance
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: Internal users
breadcrumbs:
- doc
- administration
---
{{< details >}}
... |
https://docs.gitlab.com/system_hooks | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/system_hooks.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | system_hooks.md | Create | Import | 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 | System hooks | Use system hooks to trigger HTTP POST requests from GitLab events. Includes JSON payload examples. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
System hooks (not to be confused with [server hooks](server_hooks.md) or [file hooks](file_hooks.md)) perform HTTP POST
requests and are triggered on the following events:
- `group_create`
- `group_d... | ---
stage: Create
group: Import
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: System hooks
description: Use system hooks to trigger HTTP POST requests from ... |
https://docs.gitlab.com/merge_request_diffs | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/merge_request_diffs.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | merge_request_diffs.md | Create | Code Review | 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 | Merge request diffs storage | Configure external storage for merge request diffs on your GitLab instance. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
Merge request diffs are size-limited copies of diffs associated with merge
requests. When viewing a merge request, diffs are sourced from these copies
wherever possible as a performance optimization.
By default, GitLa... | ---
stage: Create
group: Code Review
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 external storage for merge request diffs on your GitLab instance.
title: Merge r... |
https://docs.gitlab.com/uploads | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/uploads.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | uploads.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 administration | Administer uploads storage. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
Uploads represent all user data that may be sent to GitLab as a single file. For example, avatars and note attachments are uploads. Uploads are integral to GitLab functionality and therefore cannot be disabled.
{{< al... | ---
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 administration
description: Administer uploads storage.
breadcrumbs:
- doc
- a... |
https://docs.gitlab.com/terraform_state | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/terraform_state.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | terraform_state.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 | Terraform state administration | Administer Terraform state storage. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
GitLab can be used as a backend for [Terraform](../user/infrastructure/_index.md) state
files. The files are encrypted before being stored. This feature is enabled by default.
The storage location of these files defau... | ---
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: Terraform state administration
description: Administer Terraform state storage.
breadcrumbs:
- ... |
https://docs.gitlab.com/instance_review | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/instance_review.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | instance_review.md | Growth | Acquisition | 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 | Instance review | Request a free instance review. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
If you run a GitLab Self-Managed instance with 50 or more users on the Free tier
([either Community Edition or unlicensed Enterprise Edition](https://about.gitlab.com/install/ce-or-ee/)),
you can request a free instanc... | ---
stage: Growth
group: Acquisition
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: Instance review
description: Request a free instance review.
breadcrumbs:
- doc
- administration... |
https://docs.gitlab.com/labels | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/labels.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | labels.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 | Labels administration | Configure labels to add to new projects. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
To manage labels for the GitLab instance:
1. On the left sidebar, at the bottom, select **Admin**.
1. Select **Labels**.
For more details on how to manage labels, see [Labels](../user/project/labels... | ---
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: Labels administration
description: Configure labels to add to new pr... |
https://docs.gitlab.com/broadcast_messages | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/broadcast_messages.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | broadcast_messages.md | Growth | Engagement | 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 | Broadcast messages | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
GitLab can display two types of broadcast messages to users of a GitLab instance:
- Banners
- Notifications
Broadcast messages can be managed using the [broadcast messages API](../api/broadcast_mess... | ---
stage: Growth
group: Engagement
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: Broadcast messages
breadcrumbs:
- doc
- administration
---
{{< details >}}
- Tier: Free, Premi... |
https://docs.gitlab.com/moderate_users | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/moderate_users.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | moderate_users.md | Fulfillment | Provision | 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 | Moderate users | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
If you are an instance administrator, you have several options to moderate and control user access.
{{< alert type="note" >}}
This topic is specifically related to user moderation in GitLab Self-Man... | ---
stage: Fulfillment
group: Provision
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: Moderate users
breadcrumbs:
- doc
- administration
---
{{< details >... |
https://docs.gitlab.com/git_protocol | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/git_protocol.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | git_protocol.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 | Configuring Git Protocol v2 | Set and configure Git protocol v2 for GitLab Self-Managed. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
Git protocol v2 improves the v1 wire protocol in several ways and is
enabled by default in GitLab for HTTP requests. To enable SSH, additional
configuration is required by an administrator.
More details about the new ... | ---
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: Set and configure Git protocol v2 for GitLab Self-Managed.
title: Configuring Git Protocol... |
https://docs.gitlab.com/smime_signing_email | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/smime_signing_email.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | smime_signing_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 | Signing outgoing email with S/MIME | Configure S/MIME for outgoing email. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
Notification emails sent by GitLab can be signed with S/MIME for improved
security.
Be aware that S/MIME certificates and TLS/SSL certificates are not the
same and are used for different purposes: TLS creates a secure... | ---
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: Signing outgoing email with S/MIME
description: Configure S/MIME for outgoing email.
b... |
https://docs.gitlab.com/cells | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/cells.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | cells.md | Tenant Scale | Cells Infrastructure | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Cells | Test cell functionality. |
{{< details >}}
- Offering: GitLab.com
- Status: Experiment
{{< /details >}}
{{< alert type="note" >}}
This feature is available for administrators of GitLab.com only. This feature is not available for GitLab Self-Managed or GitLab Dedicated instances.
{{< /alert >}}
{{< alert type="disclaimer" />}}
{{< alert ... | ---
stage: Tenant Scale
group: Cells Infrastructure
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Cells
description: Test cell functionality.
breadcrumbs:
- doc
- adm... |
https://docs.gitlab.com/administer_users | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/administer_users.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | administer_users.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 | Administer users | Administer GitLab users. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
Administer and manage users in GitLab Self-Managed.
## User accounts
- [Create users](../user/profile/account/create_accounts.md)
- [Reset user passwords](../security/reset_user_password.md)
- [Locked user accounts](... | ---
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: Administer GitLab users.
title: Administer users
breadcrumbs:
- doc
- administration
---
{{... |
https://docs.gitlab.com/application_settings_cache | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/application_settings_cache.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | application_settings_cache.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 | Application cache interval | Manage the GitLab application cache. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
By default, GitLab caches application settings for 60 seconds. Occasionally,
you may need to increase that interval to have more delay between application
setting changes and when users notice those changes in the appl... | ---
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: Application cache interval
description: Manage the GitLab application cache.
breadcrumbs:
- doc
- a... |
https://docs.gitlab.com/polling | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/polling.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | polling.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 | Polling interval multiplier | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
The GitLab UI polls for updates for different resources (such as issue notes, issue titles, and pipeline
statuses) on a schedule appropriate to the resource.
Adjust the multiplier on these schedules ... | ---
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
gitlab_dedicated: true
title: Polling interval multiplier
breadcrumbs:
- doc
- administration... |
https://docs.gitlab.com/invalidate_markdown_cache | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/invalidate_markdown_cache.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | invalidate_markdown_cache.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 | Markdown cache | Invalidate the Markdown cache. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
For performance reasons, GitLab caches the HTML version of Markdown text in fields such as:
- Comments.
- Issue descriptions.
- Merge request descriptions.
These cached versions can become outdated, such as when the ... | ---
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
title: Markdown cache
description: Invalidate the Markdown cache.
breadcrumbs:
- doc
- administrat... |
https://docs.gitlab.com/review_abuse_reports | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/review_abuse_reports.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | review_abuse_reports.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 | Review abuse reports | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
View and resolve abuse reports from GitLab users.
GitLab administrators can view and [resolve](#resolving-abuse-reports) abuse
reports in the **Admin** area.
## Receive notification of abuse reports... | ---
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: Review abuse reports
breadcrumbs:
- doc
- admin... |
https://docs.gitlab.com/analytics | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/analytics.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | analytics.md | Plan | Optimize | 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 | Use ClickHouse for analytics reports | Enable and configure ClickHouse for data analytics in GitLab. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- ClickHouse data collector [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/414610) in GitLab 16.3 [with a flag](feature_flags/_index.md) named `clickhouse_data... | ---
stage: Plan
group: Optimize
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
description: Enable and configure ClickHouse for data analytics in GitLab.
title: Use... |
https://docs.gitlab.com/docs_self_host | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/docs_self_host.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | docs_self_host.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 | Host the GitLab product documentation | Host the product documentation yourself. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
If you are not able to access the GitLab product documentation at `docs.gitlab.com`,
you can host the documentation yourself instead.
{{< alert type="note" >}}
The local help of your instance does not include all the... | ---
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: Host the GitLab product documentation
description: Host the product documentation your... |
https://docs.gitlab.com/nfs | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/nfs.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | nfs.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 | Using NFS with GitLab | Use NFS with GitLab. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
NFS can be used as an alternative for object storage but this isn't typically
recommended for performance reasons.
For data objects such as LFS, Uploads, and Artifacts, an [Object Storage service](object_storage.md)
i... | ---
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: Using NFS with GitLab
description: Use NFS with GitLab.
breadcrumbs:
- doc
- administr... |
https://docs.gitlab.com/administration | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/_index.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | _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 | Administer GitLab | Learn how to install, configure, update, and maintain your GitLab instance. |
Learn how to administer GitLab Self-Managed.
{{< cards >}}
- [Get started](get_started.md)
- [All feature flags](feature_flags/list.md)
- [Authentication and authorization](auth/_index.md)
- [Configure GitLab](configure.md)
- [Update your Admin area settings](settings/_index.md)
- [Maintain GitLab](operations/_inde... | ---
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
description: Learn how to install, configure, update, and maintain your GitLab instance.
titl... |
https://docs.gitlab.com/guest_users | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/guest_users.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | guest_users.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 | Guest users | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Users with the Guest role have limited access and capabilities compared to other user roles. Their [permissions](../user/permissions.md) are restricted and designed to provide only basic v... | ---
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: Guest users
breadcrumbs:
- doc
- administration
---
{{< details >}}
... |
https://docs.gitlab.com/timezone | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/timezone.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | timezone.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 | Change your time zone | Change the time zone for an instance. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
{{< alert type="note" >}}
Users can set their [time zone in their profile](../user/profile/_index.md#set-your-time-zone).
New users do not have a default time zone and must
explicitly set it before it displays on thei... | ---
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: Change your time zone
description: Change the time zone for an instance.
breadcrumbs:
... |
https://docs.gitlab.com/object_storage | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/object_storage.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | object_storage.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 | Object storage | Configure an object storage service for data. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
GitLab supports using an object storage service for holding numerous types of data.
It's recommended over NFS and
in general it's better in larger setups as object storage is
typically much more performant, reliable, a... | ---
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
gitlab_dedicated: false
title: Object storage
description: Configure an object storage servic... |
https://docs.gitlab.com/reply_by_email_postfix_setup | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/reply_by_email_postfix_setup.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | reply_by_email_postfix_setup.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 | Set up Postfix for incoming email | Configure Postfix for incoming email. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
This document takes you through the steps of setting up a basic Postfix mail
server with IMAP authentication on Ubuntu, to be used with [incoming email](incoming_email.md).
The instructions make the assumption that yo... | ---
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: Set up Postfix for incoming email
description: Configure Postfix for incoming email.
b... |
https://docs.gitlab.com/license_file | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/license_file.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | license_file.md | Fulfillment | Provision | 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 | Activate GitLab EE with a license file or key | null |
If you receive a license file from GitLab (for example, for a trial), you can
upload it to your instance or add it during installation. The license file is
a base64-encoded ASCII text file with a `.gitlab-license` extension.
The first time you sign in to your GitLab instance, a note with a
link to the **Add license*... | ---
stage: Fulfillment
group: Provision
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: Activate GitLab EE with a license file or key
breadcrumbs:
- doc
- administration
---
If yo... |
https://docs.gitlab.com/duo_add_on_seat_management_with_ldap | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/duo_add_on_seat_management_with_ldap.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | duo_add_on_seat_management_with_ldap.md | Fulfillment | Seat 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 | GitLab Duo add-on seat management with LDAP | null |
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/175101) in GitLab 17.8.
{{< /history >}}
GitLab administrators can configure automatic GitLab Duo add-on seat assignment based on LDAP g... | ---
stage: Fulfillment
group: Seat 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
title: GitLab Duo add-on seat management with LDAP
breadcrumbs:
- doc
- administration
---
{... |
https://docs.gitlab.com/review_spam_logs | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/review_spam_logs.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | review_spam_logs.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 | Review spam logs | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
GitLab tracks user activity and flags certain behavior for potential spam.
In the **Admin** area, a GitLab administrator can view and resolve spam logs.
## Manage spam logs
{{< history >}}
- **Tru... | ---
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: Review spam logs
breadcrumbs:
- doc
- administr... |
https://docs.gitlab.com/geo_sites | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/geo_sites.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | geo_sites.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 | Geo sites Admin area | Configure Geo sites. |
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
You can configure various settings for GitLab Geo sites. For more information, see
[Geo documentation](geo/_index.md).
On either the primary or secondary site:
1. On the left sidebar, at the bottom, select **Admin**.
1. Se... | ---
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
gitlab_dedicated: false
title: Geo sites Admin area
description: Configure Geo sites.
breadcrumbs:
- doc
... |
https://docs.gitlab.com/dormant_project_deletion | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/dormant_project_deletion.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | dormant_project_deletion.md | Tenant Scale | Organizations | 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 | Dormant project deletion | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/85689) in GitLab 15.0 [with a flag](feature_flags/_index.md) named `inactive_projects_deletion`. Disabled by defau... | ---
stage: Tenant Scale
group: Organizations
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: Dormant project deletion
breadcrumbs:
- doc
- administration
---
... |
https://docs.gitlab.com/inactive_project_deletion | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/inactive_project_deletion.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | inactive_project_deletion.md | null | null | null | null | null |
<!-- markdownlint-disable -->
This document was moved to [another location](dormant_project_deletion.md).
<!-- This redirect file can be deleted after <2025-08-20>. -->
<!-- Redirects that point to other docs in the same project expire in three months. -->
<!-- Redirects that point to docs in a different project or... | ---
redirect_to: dormant_project_deletion.md
remove_date: '2025-08-20'
breadcrumbs:
- doc
- administration
---
<!-- markdownlint-disable -->
This document was moved to [another location](dormant_project_deletion.md).
<!-- This redirect file can be deleted after <2025-08-20>. -->
<!-- Redirects that point to other d... |
https://docs.gitlab.com/admin_area | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/admin_area.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | admin_area.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 | GitLab Admin area | Manage your GitLab instance and configure features in the UI. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
The **Admin** area provides a web UI to manage and configure features of a
GitLab Self-Managed instance. If you are an administrator, to access the **Admin** area:
- In GitLab 17.3 and later: on the ... | ---
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: Manage your GitLab instance and configure features in the UI.
title: GitLab Admin area
breadc... |
https://docs.gitlab.com/repository_checks | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/repository_checks.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | repository_checks.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 checks | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
You can use [`git fsck`](https://git-scm.com/docs/git-fsck) to verify the integrity of all data
committed to a repository. GitLab administrators can:
- [Manually trigger this check for a project](#ch... | ---
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: true
title: Repository checks
breadcrumbs:
- doc
- administration
---
{{< details >... |
https://docs.gitlab.com/credentials_inventory | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/credentials_inventory.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | credentials_inventory.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 | Credentials inventory | null |
{{< details >}}
- Tier: Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- Group access tokens [added](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/102959) in GitLab 15.6.
{{< /history >}}
{{< alert type="note" >}}
For GitLab.com, see [Credentials inventory f... | ---
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: true
title: Credentials inventory
breadcrumbs:
- doc
- adm... |
https://docs.gitlab.com/encrypted_configuration | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/encrypted_configuration.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | encrypted_configuration.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 | Encrypted Configuration | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
GitLab can read settings for certain features from encrypted settings files. The supported features are:
- [Incoming email `user` and `password`](incoming_email.md#use-encrypted-credentials).
- [LDAP `bind_dn` and `pa... | ---
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: Encrypted Configuration
breadcrumbs:
- doc
- administration
---
{{< details >}}
- T... |
https://docs.gitlab.com/instance_limits | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/instance_limits.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | instance_limits.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 | GitLab application limits | Configure limits on an instance. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
GitLab, like most large applications, enforces limits in certain features to maintain a
minimum quality of performance. Allowing some features to be limitless could affect security,
performance, data, or could even exh... | ---
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: GitLab application limits
description: Configure limits on an instance.
breadcrumbs:
-... |
https://docs.gitlab.com/user_settings | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user_settings.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | user_settings.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 | Modify global user settings | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
You can modify settings for every user in your GitLab instance.
## Prerequisites
- You must be an administrator of GitLab Self-Managed.
## Prevent users from creating top-level groups
By default, new users can crea... | ---
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: Modify global user settings
breadcrumbs:
- doc
- administration
---
... |
https://docs.gitlab.com/incoming_email | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/incoming_email.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | incoming_email.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 | Incoming email | Configure incoming email. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
GitLab has several features based on receiving incoming email messages:
- [Reply by Email](reply_by_email.md): allow GitLab users to comment on issues
and merge requests by replying to notification email.
- [New iss... | ---
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: Incoming email
description: Configure incoming email.
breadcrumbs:
... |
https://docs.gitlab.com/license | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/license.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | license.md | Fulfillment | Provision | 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 | Activate GitLab Enterprise Edition (EE) | null |
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
When you install a new GitLab instance without a license, only Free features
are enabled. To enable more features in GitLab Enterprise Edition (EE), activate
your instance with an activation code.
## Activate GitLab EE
Pre... | ---
stage: Fulfillment
group: Provision
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: Activate GitLab Enterprise Edition (EE)
breadcrumbs:
- doc
- administration
---
{{< details... |
https://docs.gitlab.com/user_cohorts | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/user_cohorts.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | user_cohorts.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 | User Cohorts | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
You can analyze your users' GitLab activities over time.
How do you interpret the user cohorts table? Let's review an example with the
following user cohorts:
![User cohort table showing retention a... | ---
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
gitlab_dedicated: true
title: User Cohorts
breadcrumbs:
- doc
- administration
---
{{< details >}}
- Ti... |
https://docs.gitlab.com/restart_gitlab | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/restart_gitlab.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | restart_gitlab.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 restart GitLab | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
Depending on how you installed GitLab, there are different methods to restart
its services.
{{< alert type="note" >}}
A short downtime is expected for all methods.
{{< /alert >}}
## Linux package installations
If ... | ---
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 restart GitLab
breadcrumbs:
- doc
- administration
---
{{< details >}}
- Tie... |
https://docs.gitlab.com/merge_requests_approvals | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/merge_requests_approvals.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | merge_requests_approvals.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 | Merge request approvals | Configure merge request approvals for your GitLab instance. |
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Merge request approval rules prevent users from overriding certain project settings.
When enabled, these settings are
[enforced for all projects and groups](../user/project/merge_requests/approvals/settings... | ---
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: true
description: Configure merge request approvals for your GitLab instance.
title: ... |
https://docs.gitlab.com/get_started | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/get_started.md | 2025-08-13 | doc/administration | [
"doc",
"administration"
] | get_started.md | none | Tutorials | For assistance with this tutorial, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. | Get started administering GitLab | Administration overview. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
Get started with GitLab administration. Configure your organization and its authentication, then secure, monitor,
and back up GitLab.
## Authentication
Authentication is the first step in making your installation sec... | ---
stage: none
group: Tutorials
info: For assistance with this tutorial, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects.
description: Administration overview.
title: Get started administering GitLab
breadcrumbs:
- doc
- administration
---
{{< details... |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.