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/ci/pipeline_security | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/pipeline_security.md | 2025-08-13 | doc/ci/pipelines | [
"doc",
"ci",
"pipelines"
] | pipeline_security.md | null | null | null | null | null |
<!-- markdownlint-disable -->
This document was moved to [another location](../pipeline_security/_index.md).
<!-- This redirect file can be deleted after <2025-09-24>. -->
<!-- Redirects that point to other docs in the same project expire in three months. -->
<!-- Redirects that point to docs in a different project... | ---
redirect_to: ../pipeline_security/_index.md
remove_date: '2025-09-24'
breadcrumbs:
- doc
- ci
- pipelines
---
<!-- markdownlint-disable -->
This document was moved to [another location](../pipeline_security/_index.md).
<!-- This redirect file can be deleted after <2025-09-24>. -->
<!-- Redirects that point to o... |
https://docs.gitlab.com/ci/merged_results_pipelines | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/merged_results_pipelines.md | 2025-08-13 | doc/ci/pipelines | [
"doc",
"ci",
"pipelines"
] | merged_results_pipelines.md | Verify | Pipeline Execution | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Merged results pipelines | null |
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
A merged results pipeline runs on the result of the source and target branches merged together.
It is a type of [merge request pipeline](merge_request_pipelines.md).
GitLab creates an internal ... | ---
stage: Verify
group: Pipeline Execution
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Merged results pipelines
breadcrumbs:
- doc
- ci
- pipelines
---
{{< details >}}
- Tie... |
https://docs.gitlab.com/ci/compute_minutes | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/compute_minutes.md | 2025-08-13 | doc/ci/pipelines | [
"doc",
"ci",
"pipelines"
] | compute_minutes.md | Verify | Pipeline Execution | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Compute minutes | Calculations, quotas, purchase information. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Renamed](https://gitlab.com/groups/gitlab-com/-/epics/2150) from "CI/CD minutes" to "compute quota" or "compute minutes" in GitLab 16.1.
{{< /history >}}
The usage of... | ---
stage: Verify
group: Pipeline Execution
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Calculations, quotas, purchase information.
title: Compute minutes
breadcrumbs:
- d... |
https://docs.gitlab.com/ci/downstream_pipelines_troubleshooting | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/downstream_pipelines_troubleshooting.md | 2025-08-13 | doc/ci/pipelines | [
"doc",
"ci",
"pipelines"
] | downstream_pipelines_troubleshooting.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 | Troubleshooting downstream pipelines | null |
## Trigger job fails and does not create multi-project pipeline
With multi-project pipelines, the trigger job fails and does not create the downstream pipeline if:
- The downstream project is not found.
- The user that creates the upstream pipeline does not have [permission](../../user/permissions.md)
to create p... | ---
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: Troubleshooting downstream pipelines
breadcrumbs:
- doc
- ci
- pipelines
---
## Trigger... |
https://docs.gitlab.com/ci/merge_request_pipelines | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/merge_request_pipelines.md | 2025-08-13 | doc/ci/pipelines | [
"doc",
"ci",
"pipelines"
] | merge_request_pipelines.md | Verify | Pipeline Execution | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Merge request pipelines | Learn how to use merge request pipelines in GitLab CI/CD to test changes efficiently, run targeted jobs, and improve code quality before merging. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
You can configure your pipeline to run every time you make changes to the
source branch in a merge request.
This type of pipeline, called a merge request pipeline, runs when you:
- Creat... | ---
stage: Verify
group: Pipeline Execution
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Learn how to use merge request pipelines in GitLab CI/CD to test changes
efficien... |
https://docs.gitlab.com/ci/pipelines | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/_index.md | 2025-08-13 | doc/ci/pipelines | [
"doc",
"ci",
"pipelines"
] | _index.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 pipelines | Configuration, automation, stages, schedules, and efficiency. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
CI/CD pipelines are the fundamental component of GitLab CI/CD. Pipelines are configured
in a `.gitlab-ci.yml` file by using [YAML keywords](../yaml/_index.md).
Pipelines can run automatic... | ---
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 pipelines
description: Configuration, automation, stages, schedules, and efficiency... |
https://docs.gitlab.com/ci/schedules | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/schedules.md | 2025-08-13 | doc/ci/pipelines | [
"doc",
"ci",
"pipelines"
] | schedules.md | Verify | Pipeline Execution | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Scheduled pipelines | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Use scheduled pipelines to run GitLab CI/CD [pipelines](_index.md) at regular intervals.
## Prerequisites
For a scheduled pipeline to run:
- The schedule owner must have the Developer r... | ---
stage: Verify
group: Pipeline Execution
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Scheduled pipelines
breadcrumbs:
- doc
- ci
- pipelines
---
{{< details >}}
- Tier: Fr... |
https://docs.gitlab.com/ci/settings | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/settings.md | 2025-08-13 | doc/ci/pipelines | [
"doc",
"ci",
"pipelines"
] | settings.md | Verify | Pipeline Execution | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Customize pipeline configuration | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
You can customize how pipelines run for your project.
<i class="fa fa-youtube-play youtube" aria-hidden="true"></i>
For an overview of pipelines, watch the video [GitLab CI Pipeline, Arti... | ---
stage: Verify
group: Pipeline Execution
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Customize pipeline configuration
breadcrumbs:
- doc
- ci
- pipelines
---
{{< details >}... |
https://docs.gitlab.com/ci/dedicated_hosted_runner_compute_minutes | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/dedicated_hosted_runner_compute_minutes.md | 2025-08-13 | doc/ci/pipelines | [
"doc",
"ci",
"pipelines"
] | dedicated_hosted_runner_compute_minutes.md | Production Engineering | Runners Platform | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Compute usage for GitLab-hosted runners on GitLab Dedicated | Compute minutes, usage tracking, quota management for GitLab-hosted runners on GitLab Dedicated. |
{{< details >}}
- Tier: Ultimate
- Offering: GitLab Dedicated
{{< /details >}}
A GitLab Dedicated instance can have both GitLab Self-Managed instance runners and GitLab-hosted instance runners.
As an administrator of a GitLab Dedicated instance, you can track and monitor compute minutes used by
namespaces running... | ---
stage: Production Engineering
group: Runners Platform
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Compute minutes, usage tracking, quota management for GitLab-hosted r... |
https://docs.gitlab.com/ci/pipeline_types | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/pipeline_types.md | 2025-08-13 | doc/ci/pipelines | [
"doc",
"ci",
"pipelines"
] | pipeline_types.md | Verify | Pipeline Execution | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Types of pipelines | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Multiple types of pipelines can run in a project, including:
- Branch pipelines
- Tag pipelines
- Merge request pipelines
- Merged results pipelines
- Merge trains
These types of pipelin... | ---
stage: Verify
group: Pipeline Execution
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Types of pipelines
breadcrumbs:
- doc
- ci
- pipelines
---
{{< details >}}
- Tier: Fre... |
https://docs.gitlab.com/ci/downstream_pipelines | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/downstream_pipelines.md | 2025-08-13 | doc/ci/pipelines | [
"doc",
"ci",
"pipelines"
] | downstream_pipelines.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 | Downstream pipelines | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
A downstream pipeline is any GitLab CI/CD pipeline triggered by another pipeline.
Downstream pipelines run independently and concurrently to the upstream pipeline
that triggered them.
- A... | ---
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: Downstream pipelines
breadcrumbs:
- doc
- ci
- pipelines
---
{{< details >}}
- Tier: F... |
https://docs.gitlab.com/ci/pipeline_architectures | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/pipeline_architectures.md | 2025-08-13 | doc/ci/pipelines | [
"doc",
"ci",
"pipelines"
] | pipeline_architectures.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 | Pipeline architecture | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Pipelines are the fundamental building blocks for CI/CD in GitLab. This page documents
some of the important concepts related to them.
You can structure your pipelines with different meth... | ---
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: Pipeline architecture
breadcrumbs:
- doc
- ci
- pipelines
---
{{< details >}}
- Tier: ... |
https://docs.gitlab.com/ci/mr_pipeline_troubleshooting | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/mr_pipeline_troubleshooting.md | 2025-08-13 | doc/ci/pipelines | [
"doc",
"ci",
"pipelines"
] | mr_pipeline_troubleshooting.md | Verify | Pipeline Execution | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Troubleshooting merge request pipelines | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
When working with merge request pipelines, you might encounter the following issues.
## Two pipelines when pushing to a branch
If you get duplicate pipelines in merge requests, your pipe... | ---
stage: Verify
group: Pipeline Execution
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Troubleshooting merge request pipelines
breadcrumbs:
- doc
- ci
- pipelines
---
{{< det... |
https://docs.gitlab.com/ci/pipeline_efficiency | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/pipeline_efficiency.md | 2025-08-13 | doc/ci/pipelines | [
"doc",
"ci",
"pipelines"
] | pipeline_efficiency.md | Verify | Pipeline Execution | This page is maintained by Developer Relations, author @dnsmichi, see https://handbook.gitlab.com/handbook/marketing/developer-relations/developer-advocacy/content/#maintained-documentation | Pipeline efficiency | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
[CI/CD Pipelines](_index.md) are the fundamental building blocks for [GitLab CI/CD](../_index.md).
Making pipelines more efficient helps you save developer time, which:
- Speeds up your D... | ---
stage: Verify
group: Pipeline Execution
info: This page is maintained by Developer Relations, author @dnsmichi, see https://handbook.gitlab.com/handbook/marketing/developer-relations/developer-advocacy/content/#maintained-documentation
title: Pipeline efficiency
breadcrumbs:
- doc
- ci
- pipelines
---
{{< details... |
https://docs.gitlab.com/ci/merge_trains | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/merge_trains.md | 2025-08-13 | doc/ci/pipelines | [
"doc",
"ci",
"pipelines"
] | merge_trains.md | Verify | Pipeline Execution | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Merge trains | null |
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [In GitLab 16.0 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/359057), the **Start merge train** and **Start merge train when pipeline succeeds** buttons became **S... | ---
stage: Verify
group: Pipeline Execution
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Merge trains
breadcrumbs:
- doc
- ci
- pipelines
---
{{< details >}}
- Tier: Premium, ... |
https://docs.gitlab.com/ci/instance_runner_compute_minutes | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/instance_runner_compute_minutes.md | 2025-08-13 | doc/ci/pipelines | [
"doc",
"ci",
"pipelines"
] | instance_runner_compute_minutes.md | Verify | Pipeline Execution | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Compute usage for instance runners | Compute minutes, purchasing, usage tracking, quota management for instance runners on GitLab.com and GitLab Self-Managed. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
The amount of compute minute usage that projects can consume to run jobs on admin-managed [instance runners](../runners/runners_scope.md#instance-runners)
is limited. This limit is tracked... | ---
stage: Verify
group: Pipeline Execution
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Compute minutes, purchasing, usage tracking, quota management for instance
runner... |
https://docs.gitlab.com/ci/quick_start | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/_index.md | 2025-08-13 | doc/ci/quick_start | [
"doc",
"ci",
"quick_start"
] | _index.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 | Tutorial: Create and run your first GitLab CI/CD pipeline | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
This tutorial shows you how to configure and run your first CI/CD pipeline in GitLab.
If you are already familiar with [basic CI/CD concepts](../_index.md), you can learn about
common key... | ---
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: 'Tutorial: Create and run your first GitLab CI/CD pipeline'
breadcrumbs:
- doc
- ci
- qui... |
https://docs.gitlab.com/ci/tutorial | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/tutorial.md | 2025-08-13 | doc/ci/quick_start | [
"doc",
"ci",
"quick_start"
] | tutorial.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 | Tutorial: Create a complex pipeline | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
This tutorial walks you through configuring a progressively more complex CI/CD pipeline
through small, iterative steps. The pipeline is always fully functional,
but it gains more functiona... | ---
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: 'Tutorial: Create a complex pipeline'
breadcrumbs:
- doc
- ci
- quick_start
---
{{< det... |
https://docs.gitlab.com/ci/runner_fleet_dashboard_groups | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/runner_fleet_dashboard_groups.md | 2025-08-13 | doc/ci/runners | [
"doc",
"ci",
"runners"
] | runner_fleet_dashboard_groups.md | Verify | Runner | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Runner fleet dashboard for groups | null |
{{< details >}}
- Tier: Ultimate
- Offering: GitLab.com, GitLab Self-Managed
- Status: Beta
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/151640) as a [beta](../../policy/development_stages_support.md#beta) in GitLab 17.0 [with a flag](../../administration/f... | ---
stage: Verify
group: Runner
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Runner fleet dashboard for groups
breadcrumbs:
- doc
- ci
- runners
---
{{< details >}}
- Tier: Ul... |
https://docs.gitlab.com/ci/new_creation_workflow | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/new_creation_workflow.md | 2025-08-13 | doc/ci/runners | [
"doc",
"ci",
"runners"
] | new_creation_workflow.md | Verify | Runner | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Migrating to the new runner registration workflow | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< alert type="disclaimer" />}}
In GitLab 16.0, we introduced a new runner creation workflow that uses runner authentication tokens to register
runners. The legacy workflow that uses reg... | ---
stage: Verify
group: Runner
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Migrating to the new runner registration workflow
breadcrumbs:
- doc
- ci
- runners
---
{{< details... |
https://docs.gitlab.com/ci/configure_runners | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/configure_runners.md | 2025-08-13 | doc/ci/runners | [
"doc",
"ci",
"runners"
] | configure_runners.md | Verify | Runner | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Configuring runners | Set timeouts, protect sensitive information, control behavior with tags and variables, and configure artifact and cache settings of your GitLab Runner. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
This document describes how to configure runners in the GitLab UI.
If you need to configure runners on the machine where you installed GitLab Runner, see
[the GitLab Runner documentation]... | ---
stage: Verify
group: Runner
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Set timeouts, protect sensitive information, control behavior with tags
and variables, and co... |
https://docs.gitlab.com/ci/runners_scope | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/runners_scope.md | 2025-08-13 | doc/ci/runners | [
"doc",
"ci",
"runners"
] | runners_scope.md | Verify | Runner | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Manage runners | Learn about the types of runners, their availability, and how to manage them. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
GitLab Runner has the following types of runners, which are available based on who you want to have access:
- [Instance runners](#instance-runners) are available to all groups and project... | ---
stage: Verify
group: Runner
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Learn about the types of runners, their availability, and how to manage
them.
title: Manage r... |
https://docs.gitlab.com/ci/runner_fleet_dashboard | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/runner_fleet_dashboard.md | 2025-08-13 | doc/ci/runners | [
"doc",
"ci",
"runners"
] | runner_fleet_dashboard.md | Verify | Runner | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Runner fleet dashboard for administrators | null |
{{< details >}}
- Tier: Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/424495) in GitLab 16.6
{{< /history >}}
As a GitLab administrator, you can use the runner fleet dashboard to assess the health of your instance runners.
... | ---
stage: Verify
group: Runner
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Runner fleet dashboard for administrators
breadcrumbs:
- doc
- ci
- runners
---
{{< details >}}
- ... |
https://docs.gitlab.com/ci/long_polling | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/long_polling.md | 2025-08-13 | doc/ci/runners | [
"doc",
"ci",
"runners"
] | long_polling.md | Verify | Runner | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Long polling | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
By default, a GitLab Runner polls a GitLab instance for new CI/CD
jobs periodically. The actual polling interval [depends on the `check_interval` and number of runners configured in the ru... | ---
stage: Verify
group: Runner
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Long polling
breadcrumbs:
- doc
- ci
- runners
---
{{< details >}}
- Tier: Free, Premium, Ultimate... |
https://docs.gitlab.com/ci/provision_runners_google_cloud | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/provision_runners_google_cloud.md | 2025-08-13 | doc/ci/runners | [
"doc",
"ci",
"runners"
] | provision_runners_google_cloud.md | Verify | Runner | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Provision runners in Google Cloud Compute Engine | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/438316) in GitLab 16.10 [with a flag](../../administration/feature_flags/_index.md) named `google_cloud_support_feature_flag`. This feature is in [be... | ---
stage: Verify
group: Runner
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Provision runners in Google Cloud Compute Engine
breadcrumbs:
- doc
- ci
- runners
---
{{< details ... |
https://docs.gitlab.com/ci/git_submodules | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/git_submodules.md | 2025-08-13 | doc/ci/runners | [
"doc",
"ci",
"runners"
] | git_submodules.md | Verify | Pipeline Execution | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Using Git submodules with GitLab CI/CD | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Use [Git submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules) to keep
a Git repository as a subdirectory of another Git repository. You can clone another
repository into your p... | ---
stage: Verify
group: Pipeline Execution
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Using Git submodules with GitLab CI/CD
breadcrumbs:
- doc
- ci
- runners
---
{{< detail... |
https://docs.gitlab.com/ci/runners | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/_index.md | 2025-08-13 | doc/ci/runners | [
"doc",
"ci",
"runners"
] | _index.md | Verify | Runner | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Runners | Configuration and job execution. |
Runners are the agents that run the [GitLab Runner](https://docs.gitlab.com/runner/) application, to execute GitLab CI/CD jobs in a pipeline.
They are responsible for running your builds, tests, deployments, and other CI/CD tasks defined in `.gitlab-ci.yml` files.
## Runner execution flow
The following is a basic w... | ---
stage: Verify
group: Runner
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Runners
description: Configuration and job execution.
breadcrumbs:
- doc
- ci
- runners
---
Runners... |
https://docs.gitlab.com/ci/runners/windows | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/runners/windows.md | 2025-08-13 | doc/ci/runners/hosted_runners | [
"doc",
"ci",
"runners",
"hosted_runners"
] | windows.md | Production Engineering | Runners Platform | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Hosted runners on Windows | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com
- Status: Beta
{{< /details >}}
Hosted runners on Windows autoscale by launching virtual machines on
the Google Cloud Platform. This solution uses an
[autoscaling driver](https://gitlab.com/gitlab-org/ci-cd/custom-executor-drivers/autoscaler/-/... | ---
stage: Production Engineering
group: Runners Platform
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Hosted runners on Windows
breadcrumbs:
- doc
- ci
- runners
- hosted_runner... |
https://docs.gitlab.com/ci/runners/linux | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/runners/linux.md | 2025-08-13 | doc/ci/runners/hosted_runners | [
"doc",
"ci",
"runners",
"hosted_runners"
] | linux.md | Production Engineering | Runners Platform | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Hosted runners on Linux | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com
{{< /details >}}
Hosted runners on Linux for GitLab.com run on Google Cloud Compute Engine. Each job gets a fully isolated, ephemeral virtual machine (VM). The default region is `us-east1`.
Each VM uses the Google Container-Optimized OS (COS) ... | ---
stage: Production Engineering
group: Runners Platform
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Hosted runners on Linux
breadcrumbs:
- doc
- ci
- runners
- hosted_runners
... |
https://docs.gitlab.com/ci/runners/hosted_runners | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/runners/_index.md | 2025-08-13 | doc/ci/runners/hosted_runners | [
"doc",
"ci",
"runners",
"hosted_runners"
] | _index.md | Production Engineering | Runners Platform | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | GitLab-hosted runners | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Dedicated
{{< /details >}}
Use GitLab-hosted runners to run your CI/CD jobs on GitLab.com and GitLab Dedicated.
These runners can build, test, and deploy applications on different environments.
To create and register your own runners, ... | ---
stage: Production Engineering
group: Runners Platform
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: GitLab-hosted runners
breadcrumbs:
- doc
- ci
- runners
- hosted_runners
--... |
https://docs.gitlab.com/ci/runners/macos | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/runners/macos.md | 2025-08-13 | doc/ci/runners/hosted_runners | [
"doc",
"ci",
"runners",
"hosted_runners"
] | macos.md | Production Engineering | Runners Platform | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Hosted runners on macOS | null |
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com
- Status: Beta
{{< /details >}}
Hosted runners on macOS provide an on-demand macOS environment, fully integrated with GitLab [CI/CD](../../_index.md).
You can use these runners to build, test, and deploy apps for the Apple ecosystem (macOS, iOS, watc... | ---
stage: Production Engineering
group: Runners Platform
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Hosted runners on macOS
breadcrumbs:
- doc
- ci
- runners
- hosted_runners
... |
https://docs.gitlab.com/ci/runners/gpu_enabled | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/runners/gpu_enabled.md | 2025-08-13 | doc/ci/runners/hosted_runners | [
"doc",
"ci",
"runners",
"hosted_runners"
] | gpu_enabled.md | Production Engineering | Runners Platform | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | GPU-enabled hosted runners | null |
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com
{{< /details >}}
GitLab provides GPU-enabled hosted runners to accelerate heavy compute workloads for ModelOps
or HPC such as the training or deployment of Large Language Models (LLMs) as part of ModelOps workloads.
GitLab provides GPU-enabled runne... | ---
stage: Production Engineering
group: Runners Platform
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: GPU-enabled hosted runners
breadcrumbs:
- doc
- ci
- runners
- hosted_runne... |
https://docs.gitlab.com/ci/kubernetes_dashboard | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/kubernetes_dashboard.md | 2025-08-13 | doc/ci/environments | [
"doc",
"ci",
"environments"
] | kubernetes_dashboard.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 | Dashboard for Kubernetes | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
- Status: Beta
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/390769) in GitLab 16.1, with [flags](../../administration/feature_flags/_index.md) named `envir... | ---
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: Dashboard for Kubernetes
breadcrumbs:
- doc
- ci
- environments
---
{{< details >}}
- Tier: ... |
https://docs.gitlab.com/ci/deployments | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/deployments.md | 2025-08-13 | doc/ci/environments | [
"doc",
"ci",
"environments"
] | deployments.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 | Deployments | Deployments, rollbacks, safety, and approvals. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
When you deploy a version of your code to an environment, you create a deployment.
There is usually only one active deployment per environment.
GitLab:
- Provides a full history of deplo... | ---
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: Deployments
description: Deployments, rollbacks, safety, and approvals.
breadcrumbs:
- doc
- ci... |
https://docs.gitlab.com/ci/environments | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/_index.md | 2025-08-13 | doc/ci/environments | [
"doc",
"ci",
"environments"
] | _index.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 | Environments | Environments, variables, dashboards, and review apps. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
A GitLab environment represents a specific deployment target for your application, like development, staging, or production. Use it to manage different configurations and deploy code durin... | ---
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: Environments
description: Environments, variables, dashboards, and review apps.
breadcrumbs:
- ... |
https://docs.gitlab.com/ci/deployment_safety | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/deployment_safety.md | 2025-08-13 | doc/ci/environments | [
"doc",
"ci",
"environments"
] | deployment_safety.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 | Deployment safety | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
[Deployment jobs](../jobs/_index.md#deployment-jobs) are a specific kind of CI/CD
job. They can be more sensitive than other jobs in a pipeline,
and might need to be treated with extra car... | ---
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: Deployment safety
breadcrumbs:
- doc
- ci
- environments
---
{{< details >}}
- Tier: Free, P... |
https://docs.gitlab.com/ci/environments_dashboard | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/environments_dashboard.md | 2025-08-13 | doc/ci/environments | [
"doc",
"ci",
"environments"
] | environments_dashboard.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 | Environments Dashboard | null |
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
The Environments Dashboard provides a cross-project
environment-based view that lets you see the big picture
of what is going on in each environment. From a single
location, you can track the pr... | ---
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: Environments Dashboard
breadcrumbs:
- doc
- ci
- environments
---
{{< details >}}
- Tier: Pr... |
https://docs.gitlab.com/ci/incremental_rollouts | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/incremental_rollouts.md | 2025-08-13 | doc/ci/environments | [
"doc",
"ci",
"environments"
] | incremental_rollouts.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 | Incremental rollouts with GitLab CI/CD | Kubernetes, CI/CD, risk mitigation, and deployment. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
When rolling out changes to your application, it is possible to release production changes
to only a portion of your Kubernetes pods as a risk mitigation strategy. By releasing
production ... | ---
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: Incremental rollouts with GitLab CI/CD
description: Kubernetes, CI/CD, risk mitigation, and dep... |
https://docs.gitlab.com/ci/configure_kubernetes_deployments | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/configure_kubernetes_deployments.md | 2025-08-13 | doc/ci/environments | [
"doc",
"ci",
"environments"
] | configure_kubernetes_deployments.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 | Configure Kubernetes deployments (deprecated) | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< alert type="warning" >}}
This feature was [deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5.
{{< /alert >}}
If you are deploying to a [Kubernetes... | ---
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: Configure Kubernetes deployments (deprecated)
breadcrumbs:
- doc
- ci
- environments
---
{{< ... |
https://docs.gitlab.com/ci/deployment_approvals | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/deployment_approvals.md | 2025-08-13 | doc/ci/environments | [
"doc",
"ci",
"environments"
] | deployment_approvals.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 | Deployment approvals | Require approvals prior to deploying to a Protected Environment |
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
You can require additional approvals for deployments to protected
environments. Deployments are blocked until all required approvals are
given.
Use deployment approvals to accommodate testing,
... | ---
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
description: Require approvals prior to deploying to a Protected Environment
title: Deployment approva... |
https://docs.gitlab.com/ci/external_deployment_tools | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/external_deployment_tools.md | 2025-08-13 | doc/ci/environments | [
"doc",
"ci",
"environments"
] | external_deployment_tools.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 | Track deployments of an external deployment tool | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
While GitLab offers a [built-in deployment solution](_index.md), you might prefer to use an external deployment tool, such as Heroku or ArgoCD.
GitLab can receive deployment events from th... | ---
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: Track deployments of an external deployment tool
breadcrumbs:
- doc
- ci
- environments
---
{... |
https://docs.gitlab.com/ci/protected_environments | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/protected_environments.md | 2025-08-13 | doc/ci/environments | [
"doc",
"ci",
"environments"
] | protected_environments.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 | Protected environments | null |
{{< details >}}
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
[Environments](_index.md) can be used for both testing and
production reasons.
Because deploy jobs can be raised by different users with different roles, it's
important to be able to protect sp... | ---
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: Protected environments
breadcrumbs:
- doc
- ci
- environments
---
{{< details >}}
- Tier: Pr... |
https://docs.gitlab.com/ci/ssh_keys | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/ssh_keys.md | 2025-08-13 | doc/ci/jobs | [
"doc",
"ci",
"jobs"
] | ssh_keys.md | Software Supply Chain Security | Pipeline Security | To 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 SSH keys with GitLab CI/CD | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
GitLab does not have built-in support for managing SSH keys in a build
environment (where the GitLab Runner runs).
Use SSH keys when you want to:
- Check out internal submodules.
- Downl... | ---
stage: Software Supply Chain Security
group: Pipeline Security
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 SSH keys with GitLab CI/CD
breadcrumbs:
- doc
- ci
- jobs
--... |
https://docs.gitlab.com/ci/jobs | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/_index.md | 2025-08-13 | doc/ci/jobs | [
"doc",
"ci",
"jobs"
] | _index.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 Jobs | Configuration, rules, caching, artifacts, and logs. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
CI/CD jobs are the fundamental elements of a [GitLab CI/CD pipeline](../pipelines/_index.md).
Jobs are configured in the `.gitlab-ci.yml` file with a list of commands to execute
to accompl... | ---
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 Jobs
description: Configuration, rules, caching, artifacts, and logs.
breadcrumbs:
... |
https://docs.gitlab.com/ci/job_logs | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/job_logs.md | 2025-08-13 | doc/ci/jobs | [
"doc",
"ci",
"jobs"
] | job_logs.md | Verify | Pipeline Execution | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | CI/CD job logs | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
A job log displays the full execution history of a [CI/CD job](_index.md).
## View job logs
To view job logs:
1. Select the project for which you want to view job logs.
1. On the left s... | ---
stage: Verify
group: Pipeline Execution
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: CI/CD job logs
breadcrumbs:
- doc
- ci
- jobs
---
{{< details >}}
- Tier: Free, Premiu... |
https://docs.gitlab.com/ci/job_troubleshooting | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/job_troubleshooting.md | 2025-08-13 | doc/ci/jobs | [
"doc",
"ci",
"jobs"
] | job_troubleshooting.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 | Troubleshooting jobs | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
When working with jobs, you might encounter the following issues.
## Jobs or pipelines run unexpectedly when using `changes:`
You might have jobs or pipelines that run unexpectedly when ... | ---
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: Troubleshooting jobs
breadcrumbs:
- doc
- ci
- jobs
---
{{< details >}}
- Tier: Free, ... |
https://docs.gitlab.com/ci/fine_grained_permissions | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/fine_grained_permissions.md | 2025-08-13 | doc/ci/jobs | [
"doc",
"ci",
"jobs"
] | fine_grained_permissions.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 | Fine-grained permissions for CI/CD job tokens | null |
<!--
This documentation is auto-generated by a Rake task.
Please do not edit this file directly. To update this file, run:
`bundle exec rake ci:job_tokens:compile_docs`.
To make changes to the output of the Rake task,
edit `tooling/ci/job_tokens/docs/templates/fine_grained_permissions.md.erb`.
-->
{{< de... | ---
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: Fine-grained permissions for CI/CD job tokens
breadcrumbs:
- doc
- ci
... |
https://docs.gitlab.com/ci/job_artifacts | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/job_artifacts.md | 2025-08-13 | doc/ci/jobs | [
"doc",
"ci",
"jobs"
] | job_artifacts.md | Verify | Pipeline Execution | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Job artifacts | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Jobs can output an archive of files and directories. This output is known as a job artifact.
You can download job artifacts by using the GitLab UI or the [API](../../api/job_artifacts.md)... | ---
stage: Verify
group: Pipeline Execution
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Job artifacts
breadcrumbs:
- doc
- ci
- jobs
---
{{< details >}}
- Tier: Free, Premium... |
https://docs.gitlab.com/ci/job_artifacts_troubleshooting | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/job_artifacts_troubleshooting.md | 2025-08-13 | doc/ci/jobs | [
"doc",
"ci",
"jobs"
] | job_artifacts_troubleshooting.md | Verify | Pipeline Execution | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Troubleshooting job artifacts | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
When working with [job artifacts](job_artifacts.md), you might encounter the following issues.
## Job does not retrieve certain artifacts
By default, jobs fetch all artifacts from previo... | ---
stage: Verify
group: Pipeline Execution
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Troubleshooting job artifacts
breadcrumbs:
- doc
- ci
- jobs
---
{{< details >}}
- Tie... |
https://docs.gitlab.com/ci/job_rules | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/job_rules.md | 2025-08-13 | doc/ci/jobs | [
"doc",
"ci",
"jobs"
] | job_rules.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 | Specify when jobs run with `rules` | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Use [`rules`](../yaml/_index.md#rules) to include or exclude jobs in pipelines.
Rules are evaluated in order until the first match. When a match is found, the job
is either included or ex... | ---
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: Specify when jobs run with `rules`
breadcrumbs:
- doc
- ci
- jobs
---
{{< details >}}
... |
https://docs.gitlab.com/ci/job_control | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/job_control.md | 2025-08-13 | doc/ci/jobs | [
"doc",
"ci",
"jobs"
] | job_control.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 | Control how jobs run | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Before a new pipeline starts, GitLab checks the pipeline configuration to determine
which jobs can run in that pipeline. You can configure jobs to run depending on
conditions like the valu... | ---
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: Control how jobs run
breadcrumbs:
- doc
- ci
- jobs
---
{{< details >}}
- Tier: Free, ... |
https://docs.gitlab.com/ci/ci_job_token | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/ci_job_token.md | 2025-08-13 | doc/ci/jobs | [
"doc",
"ci",
"jobs"
] | ci_job_token.md | Software Supply Chain Security | Pipeline Security | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | GitLab CI/CD job token | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
When a CI/CD pipeline job is about to run, GitLab generates a unique token and makes it available
to the job as the [`CI_JOB_TOKEN` predefined variable](../variables/predefined_variables.m... | ---
stage: Software Supply Chain Security
group: Pipeline Security
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: GitLab CI/CD job token
breadcrumbs:
- doc
- ci
- jobs
---
{{< de... |
https://docs.gitlab.com/ci/caching | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/_index.md | 2025-08-13 | doc/ci/caching | [
"doc",
"ci",
"caching"
] | _index.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 | Caching in GitLab CI/CD | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
A cache is one or more files a job downloads and saves. Subsequent jobs that use
the same cache don't have to download the files again, so they execute more quickly.
To learn how to defin... | ---
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: Caching in GitLab CI/CD
breadcrumbs:
- doc
- ci
- caching
---
{{< details >}}
- Tier: ... |
https://docs.gitlab.com/ci/yaml_optimization | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/yaml_optimization.md | 2025-08-13 | doc/ci/yaml | [
"doc",
"ci",
"yaml"
] | yaml_optimization.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 | Optimize GitLab CI/CD configuration files | Use YAML anchors, !reference tags, and the `extends` keyword to reduce CI/CD configuration file complexity. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
You can reduce complexity and duplicated configuration in your GitLab CI/CD configuration
files by using:
- YAML-specific features like [anchors (`&`)](#anchors), aliases (`*`), and map m... | ---
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: Optimize GitLab CI/CD configuration files
description: Use YAML anchors, !reference tags,... |
https://docs.gitlab.com/ci/artifacts_reports | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/artifacts_reports.md | 2025-08-13 | doc/ci/yaml | [
"doc",
"ci",
"yaml"
] | artifacts_reports.md | Verify | Pipeline Execution | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | GitLab CI/CD artifacts reports types | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Use [`artifacts:reports`](_index.md#artifactsreports) to:
- Collect test reports, code quality reports, security reports, and other artifacts generated by included templates in
jobs.
- ... | ---
stage: Verify
group: Pipeline Execution
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: GitLab CI/CD artifacts reports types
breadcrumbs:
- doc
- ci
- yaml
---
{{< details >}}... |
https://docs.gitlab.com/ci/needs | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/needs.md | 2025-08-13 | doc/ci/yaml | [
"doc",
"ci",
"yaml"
] | needs.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 | Make jobs start earlier with `needs` | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
You can use the [`needs`](_index.md#needs) keyword to create dependencies between jobs
in a pipeline. Jobs run as soon as their dependencies are met, regardless of the pipeline's `stages`
... | ---
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: Make jobs start earlier with `needs`
breadcrumbs:
- doc
- ci
- yaml
---
{{< details >}}... |
https://docs.gitlab.com/ci/workflow | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/workflow.md | 2025-08-13 | doc/ci/yaml | [
"doc",
"ci",
"yaml"
] | workflow.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 | GitLab CI/CD `workflow` keyword | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Use the [`workflow`](_index.md#workflow) keyword to control when pipelines are created.
The `workflow` keyword is evaluated before jobs. For example, if a job is configured to run
for tag... | ---
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: GitLab CI/CD `workflow` keyword
breadcrumbs:
- doc
- ci
- yaml
---
{{< details >}}
- T... |
https://docs.gitlab.com/ci/signing_examples | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/signing_examples.md | 2025-08-13 | doc/ci/yaml | [
"doc",
"ci",
"yaml"
] | signing_examples.md | Software Supply Chain Security | Pipeline Security | To 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 Sigstore for keyless signing and verification | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com
{{< /details >}}
The [Sigstore](https://www.sigstore.dev/) project provides a CLI called
[Cosign](https://docs.sigstore.dev/quickstart/quickstart-cosign/) which can be used for keyless signing of container images built
with GitLab CI/CD. Keyles... | ---
stage: Software Supply Chain Security
group: Pipeline Security
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 Sigstore for keyless signing and verification
breadcrumbs:
- d... |
https://docs.gitlab.com/ci/lint | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/lint.md | 2025-08-13 | doc/ci/yaml | [
"doc",
"ci",
"yaml"
] | lint.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 | Validate GitLab CI/CD configuration | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Use the CI Lint tool to check the validity of GitLab CI/CD configuration.
You can validate the syntax from a `.gitlab-ci.yml` file or any other sample CI/CD configuration.
This tool checks... | ---
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: Validate GitLab CI/CD configuration
breadcrumbs:
- doc
- ci
- yaml
---
{{< details >}}
... |
https://docs.gitlab.com/ci/script | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/script.md | 2025-08-13 | doc/ci/yaml | [
"doc",
"ci",
"yaml"
] | script.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 | Scripts and job logs | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
You can use special syntax in [`script`](_index.md#script) sections to:
- [Split long commands](#split-long-commands) into multiline commands.
- [Use color codes](#add-color-codes-to-scri... | ---
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: Scripts and job logs
breadcrumbs:
- doc
- ci
- yaml
---
{{< details >}}
- Tier: Free, ... |
https://docs.gitlab.com/ci/deprecated_keywords | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/deprecated_keywords.md | 2025-08-13 | doc/ci/yaml | [
"doc",
"ci",
"yaml"
] | deprecated_keywords.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 | Deprecated keywords | null |
Some CI/CD keywords are deprecated and no longer recommended for use.
{{< alert type="warning" >}}
These keywords are still usable to ensure backwards compatibility,
but could be scheduled for removal in a future major milestone.
{{< /alert >}}
### Globally-defined `image`, `services`, `cache`, `before_script`, `... | ---
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: Deprecated keywords
breadcrumbs:
- doc
- ci
- yaml
---
Some CI/CD keywords are deprecat... |
https://docs.gitlab.com/ci/script_troubleshooting | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/script_troubleshooting.md | 2025-08-13 | doc/ci/yaml | [
"doc",
"ci",
"yaml"
] | script_troubleshooting.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 | Troubleshooting scripts and job logs | null |
## `Syntax is incorrect` in scripts that use `:`
If you use a colon (`:`) in a script, GitLab might output:
- `Syntax is incorrect`
- `script config should be a string or a nested array of strings up to 10 levels deep`
For example, if you use `"PRIVATE-TOKEN: ${PRIVATE_TOKEN}"` as part of a cURL command:
```yaml
... | ---
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: Troubleshooting scripts and job logs
breadcrumbs:
- doc
- ci
- yaml
---
## `Syntax is i... |
https://docs.gitlab.com/ci/yaml | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/_index.md | 2025-08-13 | doc/ci/yaml | [
"doc",
"ci",
"yaml"
] | _index.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 YAML syntax reference | Pipeline configuration keywords, syntax, examples, and inputs. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
This document lists the configuration options for the GitLab `.gitlab-ci.yml` file.
This file is where you define the CI/CD jobs that make up your pipeline.
- If you are already familiar ... | ---
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 YAML syntax reference
description: Pipeline configuration keywords, syntax, example... |
https://docs.gitlab.com/ci/includes | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/includes.md | 2025-08-13 | doc/ci/yaml | [
"doc",
"ci",
"yaml"
] | includes.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 | Use CI/CD configuration from other files | Use the `include` keyword to extend your CI/CD configuration with content from other YAML files. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
You can use [`include`](_index.md#include) to include external YAML files in your CI/CD jobs.
## Include a single configuration file
To include a single configuration file, use `include`... | ---
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: Use CI/CD configuration from other files
description: Use the `include` keyword to extend... |
https://docs.gitlab.com/ci/interactive_web_terminal | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/_index.md | 2025-08-13 | doc/ci/interactive_web_terminal | [
"doc",
"ci",
"interactive_web_terminal"
] | _index.md | Verify | Runner | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Interactive web terminals | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Interactive web terminals give the user access to a terminal in GitLab for
running one-off commands for their CI pipeline. You can think of it like a method for
debugging with SSH, but don... | ---
stage: Verify
group: Runner
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Interactive web terminals
breadcrumbs:
- doc
- ci
- interactive_web_terminal
---
{{< details >}}
-... |
https://docs.gitlab.com/ci/gitlab_google_cloud_integration | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/_index.md | 2025-08-13 | doc/ci/gitlab_google_cloud_integration | [
"doc",
"ci",
"gitlab_google_cloud_integration"
] | _index.md | Package | Container Registry | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | GitLab and Google Cloud integration | Cloud services and Kubernetes deployments. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com
{{< /details >}}
Use the Google Cloud integration to use Google Cloud resources in GitLab projects.
To get started, see [Set up the Google Cloud integration](../../tutorials/set_up_gitlab_google_integration/_index.md).
- [Google Cloud workloa... | ---
stage: Package
group: Container Registry
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: GitLab and Google Cloud integration
description: Cloud services and Kubernetes deploymen... |
https://docs.gitlab.com/ci/pipeline_editor | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ci/_index.md | 2025-08-13 | doc/ci/pipeline_editor | [
"doc",
"ci",
"pipeline_editor"
] | _index.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 | Pipeline editor | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
The pipeline editor is the primary place to edit the GitLab CI/CD configuration in
the `.gitlab-ci.yml` file in the root of your repository. To access the editor, go to **Build > Pipeline ... | ---
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: Pipeline editor
breadcrumbs:
- doc
- ci
- pipeline_editor
---
{{< details >}}
- Tier: ... |
https://docs.gitlab.com/next_steps | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/next_steps.md | 2025-08-13 | doc/install | [
"doc",
"install"
] | next_steps.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 | Steps after installing GitLab | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
Here are a few resources you might want to check out after completing the
installation.
## Email and notifications
- [SMTP](https://docs.gitlab.com/omnibus/settings/smtp.html): Configure SMTP
for proper email notif... | ---
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: Steps after installing GitLab
breadcrumbs:
- doc
- install
---
{{< details >}}
- Ti... |
https://docs.gitlab.com/requirements | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/requirements.md | 2025-08-13 | doc/install | [
"doc",
"install"
] | requirements.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 installation requirements | Prerequisites for installation. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
GitLab has specific installation requirements.
## Storage
The necessary storage space largely depends on the size of the repositories you want to have in GitLab.
As a guideline, you should have at least as much free ... | ---
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: Prerequisites for installation.
title: GitLab installation requirements
breadcru... |
https://docs.gitlab.com/install_methods | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/install_methods.md | 2025-08-13 | doc/install | [
"doc",
"install"
] | install_methods.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 | Installation methods | Linux, Helm, Docker, Operator, source, or scripts. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
You can install GitLab on several [cloud providers](cloud_providers.md),
or use one of the following methods.
## Linux package
The Linux package includes the official `deb` and `rpm` packages. The package has GitLab ... | ---
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: Linux, Helm, Docker, Operator, source, or scripts.
title: Installation methods
b... |
https://docs.gitlab.com/relative_url | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/relative_url.md | 2025-08-13 | doc/install | [
"doc",
"install"
] | relative_url.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 | Install GitLab under a relative URL | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
While you should install GitLab on its own (sub)domain, sometimes
this is not possible due to a variety of reasons. In that case, GitLab can also
be installed under a relative URL, for example `https://example.com/gitl... | ---
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: Install GitLab under a relative URL
breadcrumbs:
- doc
- install
---
{{< details >}}... |
https://docs.gitlab.com/install | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/_index.md | 2025-08-13 | doc/install | [
"doc",
"install"
] | _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 | Install GitLab | Read through the GitLab installation methods. |
You can install GitLab on most GNU/Linux distributions, on several
cloud providers, and in Kubernetes clusters.
To get the best experience, you should balance performance, reliability,
ease of administration (backups, upgrades, and troubleshooting) with the cost of hosting.
{{< cards >}}
- [Installation requirement... | ---
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: Read through the GitLab installation methods.
title: Install GitLab
breadcrumbs:... |
https://docs.gitlab.com/cloud_providers | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/cloud_providers.md | 2025-08-13 | doc/install | [
"doc",
"install"
] | cloud_providers.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 | Install GitLab on a cloud provider | AWS, Google Cloud Platform, Azure. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
You can install GitLab on several cloud providers.
| Cloud provider | Description |
|----------------------------------------------------------------|-------------|
| [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
description: AWS, Google Cloud Platform, Azure.
title: Install GitLab on a cloud provider
bre... |
https://docs.gitlab.com/installation | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/installation.md | 2025-08-13 | doc/install | [
"doc",
"install"
] | installation.md | null | null | null | null | null |
<!-- markdownlint-disable -->
This document was moved to [another location](self_compiled/_index.md).
<!-- This redirect file can be deleted after <2025-10-30>. -->
<!-- Redirects that point to other docs in the same project expire in three months. -->
<!-- Redirects that point to docs in a different project or sit... | ---
redirect_to: self_compiled/_index.md
remove_date: '2025-10-30'
breadcrumbs:
- doc
- install
---
<!-- markdownlint-disable -->
This document was moved to [another location](self_compiled/_index.md).
<!-- This redirect file can be deleted after <2025-10-30>. -->
<!-- Redirects that point to other docs in the same... |
https://docs.gitlab.com/install_ai_gateway | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/install_ai_gateway.md | 2025-08-13 | doc/install | [
"doc",
"install"
] | install_ai_gateway.md | AI-powered | AI Framework | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Install the GitLab AI gateway | Gateway between GitLab and large language models. |
The [AI gateway](../user/gitlab_duo/gateway.md)
is a standalone service that gives access to AI-native GitLab Duo features.
## Install by using Docker
The GitLab AI gateway Docker image contains all necessary code and dependencies
in a single container.
Prerequisites:
- Install a Docker container engine, like [Do... | ---
stage: AI-powered
group: AI Framework
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Gateway between GitLab and large language models.
title: Install the GitLab AI gatewa... |
https://docs.gitlab.com/postgresql_extensions | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/postgresql_extensions.md | 2025-08-13 | doc/install | [
"doc",
"install"
] | postgresql_extensions.md | Tenant Scale | Database | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Managing PostgreSQL extensions | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
This guide documents how to manage PostgreSQL extensions for installations with an external
PostgreSQL database.
You must load the following extensions into the main GitLab database (defaults to `gitlabhq_production`)... | ---
stage: Tenant Scale
group: Database
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: Managing PostgreSQL extensions
breadcrumbs:
- doc
- install
---
{{< details >}}
- Tier: Fr... |
https://docs.gitlab.com/install/openshift_and_gitlab | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/install/_index.md | 2025-08-13 | doc/install/openshift_and_gitlab | [
"doc",
"install",
"openshift_and_gitlab"
] | _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 | OpenShift support | null |
OpenShift - GitLab compatibility can be addressed in three different aspects. This page helps navigating between these aspects and provides introductory information for getting started with OpenShift and GitLab.
## What is OpenShift
OpenShift helps you to develop, deploy, and manage container-based applications. It... | ---
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: OpenShift support
breadcrumbs:
- doc
- install
- openshift_and_gitlab
---
OpenShift ... |
https://docs.gitlab.com/install/almalinux | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/install/almalinux.md | 2025-08-13 | doc/install/package | [
"doc",
"install",
"package"
] | almalinux.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 | Install the Linux package on AlmaLinux and RHEL-compatible distributions | Install the Linux package on AlmaLinux and RHEL-compatible distributions |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
{{< alert type="note" >}}
See [supported platforms](_index.md#supported-platforms) for the full list of
supported distributions and architectures.
{{< /alert >}}
## Prerequisites
- OS requirements:
- AlmaLinux 8
... | ---
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: Install the Linux package on AlmaLinux and RHEL-compatible distributions
title: ... |
https://docs.gitlab.com/install/debian | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/install/debian.md | 2025-08-13 | doc/install/package | [
"doc",
"install",
"package"
] | debian.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 | Install the Linux package on Debian | Install the Linux package on Debian |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
{{< alert type="note" >}}
See [supported platforms](_index.md#supported-platforms) for the full list of
supported distributions and architectures.
{{< /alert >}}
## Prerequisites
- OS requirements:
- Debian 11
... | ---
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: Install the Linux package on Debian
title: Install the Linux package on Debian
b... |
https://docs.gitlab.com/install/package | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/install/_index.md | 2025-08-13 | doc/install/package | [
"doc",
"install",
"package"
] | _index.md | GitLab Delivery | Build | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Install GitLab using the Linux package | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
The Linux packages are mature, scalable, and are used on GitLab.com. If you need additional
flexibility and resilience, we recommend deploying GitLab as described in the
[reference architecture documentation](../../adm... | ---
stage: GitLab Delivery
group: Build
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Install GitLab using the Linux package
breadcrumbs:
- doc
- install
- package
---
{{< detai... |
https://docs.gitlab.com/install/amazonlinux_2023 | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/install/amazonlinux_2023.md | 2025-08-13 | doc/install/package | [
"doc",
"install",
"package"
] | amazonlinux_2023.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 | Install the Linux package on Amazon Linux 2023 | Install the Linux package on Amazon Linux 2023 |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
{{< alert type="note" >}}
See [supported platforms](_index.md#supported-platforms) for the full list of
supported distributions and architectures.
{{< /alert >}}
## Prerequisites
- OS requirements:
- Amazon Linux... | ---
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: Install the Linux package on Amazon Linux 2023
title: Install the Linux package ... |
https://docs.gitlab.com/install/amazonlinux_2 | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/install/amazonlinux_2.md | 2025-08-13 | doc/install/package | [
"doc",
"install",
"package"
] | amazonlinux_2.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 | Install the Linux package on Amazon Linux 2 | Install the Linux package on Amazon Linux 2 |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
{{< alert type="note" >}}
See [supported platforms](_index.md#supported-platforms) for a full list of
supported distributions and architectures.
{{< /alert >}}
## Prerequisites
- OS requirements:
- Amazon Linux 2... | ---
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: Install the Linux package on Amazon Linux 2
title: Install the Linux package on ... |
https://docs.gitlab.com/install/ubuntu | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/install/ubuntu.md | 2025-08-13 | doc/install/package | [
"doc",
"install",
"package"
] | ubuntu.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 | Install the Linux package on Ubuntu | Install the Linux package on Ubuntu |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
{{< alert type="note" >}}
See [supported platforms](_index.md#supported-platforms) for the full list of
supported distributions and architectures.
{{< /alert >}}
## Prerequisites
- OS requirements:
- Ubuntu 20.04... | ---
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: Install the Linux package on Ubuntu
title: Install the Linux package on Ubuntu
b... |
https://docs.gitlab.com/install/suse | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/install/suse.md | 2025-08-13 | doc/install/package | [
"doc",
"install",
"package"
] | suse.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 | Install the Linux package on OpenSUSE and SLES | Install the Linux package on OpenSUSE and SLES |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
{{< alert type="note" >}}
See [supported platforms](_index.md#supported-platforms) for the full list of
supported distributions and architectures.
{{< /alert >}}
## Prerequisites
- OS requirements:
- OpenSUSE Lea... | ---
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: Install the Linux package on OpenSUSE and SLES
title: Install the Linux package ... |
https://docs.gitlab.com/install/aws | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/install/_index.md | 2025-08-13 | doc/install/aws | [
"doc",
"install",
"aws"
] | _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 | Installing a GitLab POC on Amazon Web Services (AWS) | Read through the GitLab installation methods. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
This page offers a walkthrough of a common configuration for GitLab on AWS using the official Linux package. You should customize it to accommodate your needs.
{{< alert type="note" >}}
For organizations with 1,000 u... | ---
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: Read through the GitLab installation methods.
title: Installing a GitLab POC on ... |
https://docs.gitlab.com/install/google_cloud_platform | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/install/_index.md | 2025-08-13 | doc/install/google_cloud_platform | [
"doc",
"install",
"google_cloud_platform"
] | _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 | Installing GitLab on Google Cloud Platform | Learn how to install a GitLab instance on Google Cloud Platform. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
You can install GitLab on a [Google Cloud Platform (GCP)](https://cloud.google.com/) using the official Linux package. You should customize it to accommodate your needs.
{{< alert type="note" >}}
To deploy production... | ---
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 a GitLab instance on Google Cloud Platform.
title: Installi... |
https://docs.gitlab.com/install/azure | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/install/_index.md | 2025-08-13 | doc/install/azure | [
"doc",
"install",
"azure"
] | _index.md | Systems | 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 | Install GitLab on Microsoft Azure | Learn how to spin up a pre-configured GitLab VM on Microsoft Azure. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
For users of the Microsoft Azure business cloud, GitLab has a pre-configured offering in
the [Azure Marketplace](https://azuremarketplace.microsoft.com/en-us/marketplace/).
This tutorial describes installing GitLab
Ent... | ---
stage: Systems
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 spin up a pre-configured GitLab VM on Microsoft Azure.
title: Install GitLa... |
https://docs.gitlab.com/install/configuration | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/install/configuration.md | 2025-08-13 | doc/install/docker | [
"doc",
"install",
"docker"
] | 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 | Configure GitLab running in a Docker container | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
This container uses the official Linux package, so you can use
the unique configuration file `/etc/gitlab/gitlab.rb` to configure the instance.
## Edit the configuration file
To access the GitLab configuration file, ... | ---
stage: GitLab Delivery
group: Self Managed
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Configure GitLab running in a Docker container
breadcrumbs:
- doc
- install
- docker
-... |
https://docs.gitlab.com/install/upgrade | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/install/upgrade.md | 2025-08-13 | doc/install/docker | [
"doc",
"install",
"docker"
] | upgrade.md | null | null | null | null | null |
<!-- markdownlint-disable -->
This document was moved to [another location](../../update/docker/_index.md).
<!-- This redirect file can be deleted after <2025-11-08>. -->
<!-- Redirects that point to other docs in the same project expire in three months. -->
<!-- Redirects that point to docs in a different project ... | ---
redirect_to: ../../update/docker/_index.md
remove_date: '2025-11-08'
breadcrumbs:
- doc
- install
- docker
---
<!-- markdownlint-disable -->
This document was moved to [another location](../../update/docker/_index.md).
<!-- This redirect file can be deleted after <2025-11-08>. -->
<!-- Redirects that point to o... |
https://docs.gitlab.com/install/docker | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/install/_index.md | 2025-08-13 | doc/install/docker | [
"doc",
"install",
"docker"
] | _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 | Install GitLab in a Docker container | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
To run GitLab in a Docker container, use a GitLab image, which contains all of the
necessary services in a single container.
Find the GitLab official Docker images at:
- [GitLab Docker images in Docker Hub](https://h... | ---
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: Install GitLab in a Docker container
breadcrumbs:
- doc
- install
- docker
---
{{< d... |
https://docs.gitlab.com/install/troubleshooting | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/install/troubleshooting.md | 2025-08-13 | doc/install/docker | [
"doc",
"install",
"docker"
] | troubleshooting.md | GitLab Delivery | Self Managed | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Troubleshooting GitLab running in a Docker container | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
When installing GitLab in a Docker container, you might encounter the following problems.
## Diagnose potential problems
The following commands are useful when troubleshooting your GitLab instance in a Docker contain... | ---
stage: GitLab Delivery
group: Self Managed
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Troubleshooting GitLab running in a Docker container
breadcrumbs:
- doc
- install
- do... |
https://docs.gitlab.com/install/backup | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/install/backup.md | 2025-08-13 | doc/install/docker | [
"doc",
"install",
"docker"
] | backup.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 | Back up GitLab running in a Docker container | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
You can create a GitLab backup with:
```shell
docker exec -t <container name> gitlab-backup create
```
For more information, see [Back up and restore GitLab](../../administration/backup_restore/_index.md).
{{< alert... | ---
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: Back up GitLab running in a Docker container
breadcrumbs:
- doc
- install
- docker
---... |
https://docs.gitlab.com/install/installation | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/install/installation.md | 2025-08-13 | doc/install/docker | [
"doc",
"install",
"docker"
] | installation.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 | Install GitLab in a Docker container | Learn about the prerequisites, strategies, and steps for installing GitLab in a Docker container. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
To install GitLab in a Docker container, use Docker Compose, Docker Engine, or Docker Swarm mode.
Prerequisites:
- You must have a working [Docker installation](https://docs.docker.com/engine/install/#server) that is... | ---
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 about the prerequisites, strategies, and steps for installing GitLab
in ... |
https://docs.gitlab.com/install/self_compiled | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/install/_index.md | 2025-08-13 | doc/install/self_compiled | [
"doc",
"install",
"self_compiled"
] | _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 | Self-compiled installation | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
This is the official installation guide to set up a production GitLab server
using the source files. It was created for and tested on **Debian/Ubuntu** operating systems.
Read [requirements.md](../requirements.md) for ... | ---
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: Self-compiled installation
breadcrumbs:
- doc
- install
- self_compiled
---
{{< deta... |
https://docs.gitlab.com/corporate_contributor_license_agreement | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/corporate_contributor_license_agreement.md | 2025-08-13 | doc/legal | [
"doc",
"legal"
] | corporate_contributor_license_agreement.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 | Corporate contributor license agreement | null |
<!-- vale off -->
You accept and agree to the following terms and conditions for Your present and
future Contributions submitted to GitLab Inc. Except for the license granted
herein to GitLab Inc. and recipients of software distributed by GitLab Inc., You
reserve all right, title, and interest in and to Your Contrib... | ---
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: Corporate contributor license agreement
breadcrumbs:
- doc
- legal
---
<!-- vale off -->
You acc... |
https://docs.gitlab.com/use_generative_ai | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/use_generative_ai.md | 2025-08-13 | doc/legal | [
"doc",
"legal"
] | use_generative_ai.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 | Use of generative AI | null |
Some content on `docs.gitlab.com` was created with the assistance of generative AI tools.
All content, AI-generated or human-created, is reviewed for accuracy and readability by a GitLab team member.
For more information about making AI-generated contributions to GitLab documentation, see our [DCO or our CLA terms](... | ---
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: Use of generative AI
breadcrumbs:
- doc
- legal
---
Some content on `docs.gitlab.com` was created... |
https://docs.gitlab.com/individual_contributor_license_agreement | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/individual_contributor_license_agreement.md | 2025-08-13 | doc/legal | [
"doc",
"legal"
] | individual_contributor_license_agreement.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 | Individual contributor license agreement | null |
<!-- vale off -->
You accept and agree to the following terms and conditions for Your present and
future Contributions submitted to GitLab Inc. Except for the license granted
herein to GitLab Inc. and recipients of software distributed by GitLab Inc., You
reserve all right, title, and interest in and to Your Contrib... | ---
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: Individual contributor license agreement
breadcrumbs:
- doc
- legal
---
<!-- vale off -->
You ac... |
https://docs.gitlab.com/developer_certificate_of_origin | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/developer_certificate_of_origin.md | 2025-08-13 | doc/legal | [
"doc",
"legal"
] | developer_certificate_of_origin.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 | Developer Certificate of Origin Version 1.1 | null |
<!-- vale off -->
Copyright (C) 2004, 2006 The Linux Foundation and its contributors, 1 Letterman Drive, Suite D4700, San Francisco, CA 94129, USA
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
By making a contribution to this project, I certi... | ---
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: Developer Certificate of Origin Version 1.1
breadcrumbs:
- doc
- legal
---
<!-- vale off -->
Cop... |
https://docs.gitlab.com/legal | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/_index.md | 2025-08-13 | doc/legal | [
"doc",
"legal"
] | _index.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 | Legal | null |
Please read through the [GitLab License Agreement](https://gitlab.com/gitlab-org/gitlab/-/blob/master/CONTRIBUTING.md).
| ---
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: Legal
breadcrumbs:
- doc
- legal
---
Please read through the [GitLab License Agreement](https://g... |
https://docs.gitlab.com/licensing_policy | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/licensing_policy.md | 2025-08-13 | doc/legal | [
"doc",
"legal"
] | licensing_policy.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 | Acceptable Use of User Licenses | null |
## User Licenses and Affiliates
### Affiliated companies' ability to separately purchase user licenses under one master agreement
Affiliated companies may each purchase user licenses directly from GitLab under one master agreement,
subject to the terms of an applicable transaction document between GitLab and the sp... | ---
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: Acceptable Use of User Licenses
breadcrumbs:
- doc
- legal
---
## User Licenses and Affiliates
#... |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.