Please check gitlab-tutorial

Skip to content

CI/CD Admin area settings

DETAILS: Tier: Free, Premium, Ultimate Offering: Self-managed

The Admin area has the instance settings for CI/CD-related features, including runners, job artifacts, and the package registry.

Auto DevOps

To enable (or disable) Auto DevOps for all projects:

  1. On the left sidebar, at the bottom, select Admin.
  2. Select Settings > CI/CD.
  3. Check (or uncheck to disable) the box that says Default to Auto DevOps pipeline for all projects.
  4. Optionally, set up the Auto DevOps base domain which is used for Auto Deploy and Auto Review Apps.
  5. Select Save changes for the changes to take effect.

Every existing project and newly created ones that don't have a .gitlab-ci.yml use the Auto DevOps pipelines.

Runners

Enable instance runners for new projects

You can set all new projects to have instance runners available by default.

  1. On the left sidebar, at the bottom, select Admin.
  2. Select Settings > CI/CD.
  3. Expand Continuous Integration and Deployment.
  4. Select the Enable instance runners for new projects checkbox.

Any time a new project is created, the instance runners are available.

Add a message for instance runners

To display details about the instance runners in all projects' runner settings:

  1. On the left sidebar, at the bottom, select Admin.
  2. Select Settings > CI/CD.
  3. Expand Continuous Integration and Deployment.
  4. Enter text, including Markdown if you want, in the Instance runner details field.

To view the rendered details:

  1. On the left sidebar, select Search or go to and find your project or group.
  2. Select Settings > CI/CD.
  3. Expand Runners.

A project's runner settings shows a message about instance runner guidelines.

Enable a project runner for multiple projects

If you have already registered a project runner you can assign that runner to other projects.

To enable a project runner for more than one project:

  1. On the left sidebar, at the bottom, select Admin.
  2. From the left sidebar, select CI/CD > Runners.
  3. Select the runner you want to edit.
  4. In the upper-right corner, select Edit ({pencil}).
  5. Under Restrict projects for this runner, search for a project.
  6. To the left of the project, select Enable.
  7. Repeat this process for each additional project.

Disable runner version management

By default, GitLab instances periodically fetch official runner version data from GitLab.com to determine whether the runners need upgrades.

To disable your instance fetching this data:

  1. On the left sidebar, at the bottom, select Admin.
  2. Select Settings > CI/CD.
  3. Expand Runners.
  4. In the Runner version management section, clear the Fetch GitLab Runner release version data from GitLab.com checkbox.
  5. Select Save changes.

Restrict runner registration by all users in an instance

GitLab administrators can adjust who is allowed to register runners, by showing and hiding areas of the UI. This setting does not affect the ability to create a runner from the UI or through an authenticated API call.

When the registration sections are hidden in the UI, members of the project or group must contact administrators to enable runner registration in the group or project. If you plan to prevent registration, ensure users have access to the runners they need to run jobs.

By default, all members of a project and group are able to register runners.

To restrict all users in an instance from registering runners:

  1. On the left sidebar, at the bottom, select Admin.
  2. Select Settings > CI/CD.
  3. Expand Runners.
  4. In the Runner registration section, clear the Members of the project can register runners and Members of the group can register runners checkboxes to remove runner registration from the UI.
  5. Select Save changes.

NOTE: After you disable runner registration by members of a project, the registration token automatically rotates. The token is no longer valid and you must use the new registration token for the project.

Restrict runner registration by all members in a group

Prerequisites:

GitLab administrators can adjust group permissions to restrict runner registration by group members.

To restrict runner registration by members in a specific group:

  1. On the left sidebar, at the bottom, select Admin.
  2. Select Overview > Groups and find your group.
  3. Select Edit.
  4. Clear the New group runners can be registered checkbox if you want to disable runner registration by all members in the group. If the setting is read-only, you must enable runner registration for the instance.
  5. Select Save changes.

Allow runner registrations tokens

WARNING: The ability to pass a runner registration token, and support for certain configuration arguments was deprecated in GitLab 15.6 and will be removed in GitLab 18.0. Runner authentication tokens should be used instead. For more information, see Migrating to the new runner registration workflow.

In GitLab 17.0, the use of runner registration tokens to create runners will be disabled in all GitLab instances. Users must use runner authentication tokens instead. If you have not yet migrated to the use of runner authentication tokens, you can allow runner registration tokens. This setting and support for runner registration tokens will be removed in GitLab 18.0.

  1. On the left sidebar, at the bottom, select Admin.
  2. Select Settings > CI/CD.
  3. Expand Runners.
  4. Select the Allow runner registration token checkbox.

Artifacts

Maximum artifacts size

An administrator can set the maximum size of the job artifacts for:

  • The entire instance
  • Each project
  • Each group

For the setting on GitLab.com, see Artifacts maximum size.

The value is in MB, and the default value is 100 MB per job. An administrator can change the default value for the:

  • Instance:

    1. On the left sidebar, at the bottom, select Admin.
    2. On the left sidebar, select Settings > CI/CD > Continuous Integration and Deployment.
    3. Change the value of Maximum artifacts size (MB).
    4. Select Save changes for the changes to take effect.

  • Group (this overrides the instance setting):

    1. Go to the group's Settings > CI/CD > General Pipelines.
    2. Change the value of Maximum artifacts size (in MB).
    3. Select Save changes for the changes to take effect.

  • Project (this overrides the instance and group settings):

    1. Go to the project's Settings > CI/CD > General Pipelines.
    2. Change the value of Maximum artifacts size (in MB).
    3. Select Save changes for the changes to take effect.

Default artifacts expiration

The default expiration time of the job artifacts can be set in the Admin area of your GitLab instance. The syntax of duration is described in artifacts:expire_in and the default value is 30 days.

  1. On the left sidebar, at the bottom, select Admin.
  2. Select Settings > CI/CD.
  3. Change the value of default expiration time.
  4. Select Save changes for the changes to take effect.

This setting is set per job and can be overridden in .gitlab-ci.yml. To disable the expiration, set it to 0. The default unit is in seconds.

NOTE: Any changes to this setting applies to new artifacts only. The expiration time is not be updated for artifacts created before this setting was changed. The administrator may need to manually search for and expire previously-created artifacts, as described in the troubleshooting documentation.

Keep the latest artifacts for all jobs in the latest successful pipelines

When enabled (default), the artifacts of the most recent pipeline for each Git ref (branches and tags) are locked against deletion and kept regardless of the expiry time.

When disabled, the latest artifacts for any new successful or fixed pipelines are allowed to expire.

This setting takes precedence over the project setting. If disabled for the entire instance, you cannot enable this in individual projects.

To disable the setting:

  1. On the left sidebar, at the bottom, select Admin.
  2. Select Settings > CI/CD.
  3. Expand Continuous Integration and Deployment.
  4. Clear the Keep the latest artifacts for all jobs in the latest successful pipelines checkbox.
  5. Select Save changes

When you disable the feature, the latest artifacts do not immediately expire. A new pipeline must run before the latest artifacts can expire and be deleted.

NOTE: All application settings have a customizable cache expiry interval which can delay the settings affect.

Disable the external redirect page for job artifacts

By default, GitLab Pages shows an external redirect page when a user tries to view a job artifact served by GitLab Pages. This page warns about the potential for malicious user-generated content, as described in issue 352611.

Self-managed administrators can disable the external redirect warning page, so you can view job artifact pages directly:

  1. On the left sidebar, at the bottom, select Admin.
  2. Select Settings > CI/CD.
  3. Expand Continuous Integration and Deployment.
  4. Deselect Enable the external redirect page for job artifacts.

Archive jobs

You can archive old jobs to prevent them from being re-run individually. Archived jobs display a lock icon ({lock}) and This job is archived at the top of the job log.

To set the duration for which the jobs are considered as old and expired:

  1. On the left sidebar, at the bottom, select Admin.
  2. Select Settings > CI/CD.
  3. Expand the Continuous Integration and Deployment section.
  4. Set the value of Archive jobs.
  5. Select Save changes for the changes to take effect.

After that time passes, the jobs are archived in the background and no longer able to be retried. Make it empty to never expire jobs. It has to be no less than 1 day, for example: 15 days, 1 month, 2 years.

For the value set for GitLab.com, see Scheduled job archiving.

Protect CI/CD variables by default

To set all new CI/CD variables as protected by default:

  1. On the left sidebar, at the bottom, select Admin.
  2. Select Settings > CI/CD.
  3. Select Protect CI/CD variables by default.

Maximum includes

The maximum number of includes per pipeline can be set for the entire instance. The default is 150.

  1. On the left sidebar, at the bottom, select Admin.
  2. Select Settings > CI/CD.
  3. Change the value of Maximum includes.
  4. Select Save changes for the changes to take effect.

Maximum downstream pipeline trigger rate

The maximum number of downstream pipelines that can be triggered per minute (for a given project, user, and commit) can be set for the entire instance. The default value is 0 (no restriction).

  1. On the left sidebar, at the bottom, select Admin.
  2. Select Settings > CI/CD.
  3. Change the value of Maximum downstream pipeline trigger rate.
  4. Select Save changes for the changes to take effect.

Default CI/CD configuration file

The default CI/CD configuration file and path for new projects can be set in the Admin area of your GitLab instance (.gitlab-ci.yml if not set):

  1. On the left sidebar, at the bottom, select Admin.
  2. Select Settings > CI/CD.
  3. Input the new file and path in the Default CI/CD configuration file field.
  4. Select Save changes for the changes to take effect.

It is also possible to specify a custom CI/CD configuration file for a specific project.

Set CI/CD limits

  • Maximum number of active pipelines per project setting removed in GitLab 16.0.
  • Maximum number of jobs in a single pipeline setting moved from GitLab Enterprise Edition to GitLab Community Edition in 17.6.

You can configure some CI/CD limits from the Admin area:

  1. On the left sidebar, at the bottom, select Admin.
  2. Select Settings > CI/CD.
  3. Expand the Continuous Integration and Deployment section.
  1. In the CI/CD limits section, you can set the following limits:
    • Maximum number of jobs in a single pipeline
    • Total number of jobs in currently active pipelines
    • Maximum number of pipeline subscriptions to and from a project
    • Maximum number of pipeline schedules
    • Maximum number of needs dependencies that a job can have
    • Maximum number of runners registered per group
    • Maximum number of runners registered per project
    • Maximum number of downstream pipelines in a pipeline's hierarchy tree

Job token permissions

You can configure the CI/CD job token access setting for all projects from the Admin area.

  1. On the left sidebar, at the bottom, select Admin.
  2. Select Settings > CI/CD.
  3. Expand the Continuous Integration and Deployment section.
  4. Enable Enable and enforce job token allowlist for all projects setting to require all projects to control job token access with the allowlist.

Disable the pipeline suggestion banner

By default, a banner displays in merge requests with no pipeline suggesting a walkthrough on how to add one.

A banner displays guidance on how to get started with GitLab Pipelines.

To disable the banner:

  1. On the left sidebar, at the bottom, select Admin.
  2. Select Settings > CI/CD.
  3. Clear the Enable pipeline suggestion banner checkbox.
  4. Select Save changes.

Required pipeline configuration

DETAILS: Tier: Ultimate Offering: Self-managed

  • Moved from GitLab Premium to GitLab Ultimate in 15.0.
  • Deprecated in GitLab 15.9.
  • Removed in GitLab 17.0.
  • Re-added behind the required_pipelines feature flag in GitLab 17.4. Disabled by default.

WARNING: This feature was deprecated in GitLab 15.9 and was removed in 17.0. From 17.4, it is available only behind the feature flag required_pipelines, disabled by default. Use compliance pipelines instead. This change is a breaking change.

You can set a CI/CD template as a required pipeline configuration for all projects on a GitLab instance. You can use a template from:

  • The default CI/CD templates.

  • A custom template stored in an instance template repository.

    NOTE: When you use a configuration defined in an instance template repository, nested include: keywords (including include:file, include:local, include:remote, and include:template) do not work.

The project CI/CD configuration merges into the required pipeline configuration when a pipeline runs. The merged configuration is the same as if the required pipeline configuration added the project configuration with the include keyword. To view a project's full merged configuration, View full configuration in the pipeline editor.

To select a CI/CD template for the required pipeline configuration:

  1. On the left sidebar, at the bottom, select Admin Area.
  2. Select Settings > CI/CD.
  3. Expand the Required pipeline configuration section.
  4. Select a CI/CD template from the dropdown list.
  5. Select Save changes.

Package registry configuration

Maven Forwarding

DETAILS: Tier: Premium, Ultimate Offering: Self-managed

GitLab administrators can disable the forwarding of Maven requests to Maven Central.

To disable forwarding Maven requests:

  1. On the left sidebar, at the bottom, select Admin.
  2. Select Settings > CI/CD.
  3. Expand the Package Registry section.
  4. Clear the checkbox Forward Maven package requests to the Maven Registry if the packages are not found in the GitLab Package Registry.
  5. Select Save changes.

npm Forwarding

DETAILS: Tier: Premium, Ultimate Offering: Self-managed

GitLab administrators can disable the forwarding of npm requests to npmjs.com.

To disable it:

  1. On the left sidebar, at the bottom, select Admin.
  2. Select Settings > CI/CD.
  3. Expand the Package Registry section.
  4. Clear the checkbox Forward npm package requests to the npm Registry if the packages are not found in the GitLab Package Registry.
  5. Select Save changes.

PyPI Forwarding

DETAILS: Tier: Premium, Ultimate Offering: Self-managed

GitLab administrators can disable the forwarding of PyPI requests to pypi.org.

To disable it:

  1. On the left sidebar, at the bottom, select Admin.
  2. Select Settings > CI/CD.
  3. Expand the Package Registry section.
  4. Clear the checkbox Forward PyPI package requests to the PyPI Registry if the packages are not found in the GitLab Package Registry.
  5. Select Save changes.

Package file size limits

GitLab administrators can adjust the maximum allowed file size for each package type.

To set the maximum file size:

  1. On the left sidebar, at the bottom, select Admin.
  2. Select Settings > CI/CD.
  3. Expand the Package Registry section.
  4. Find the package type you would like to adjust.
  5. Enter the maximum file size, in bytes.
  6. Select Save size limits.