GitLab Docs

Welcome to GitLab Documentation.

Here you can access the complete documentation for GitLab, the single application for the entire DevOps lifecycle.


No matter how you use GitLab, we have documentation for you.

Essential DocumentationEssential Documentation
User Documentation
Discover features and concepts for GitLab users.
Administrator documentation
Everything GitLab self-managed administrators need to know.
Contributing to GitLab
At GitLab, everyone can contribute!
New to Git and GitLab?
We have the resources to get you started.
Building an integration with GitLab?
Consult our automation and integration documentation.
Coming to GitLab from another platform?
Consult our handy guides.
Install GitLab
Installation options for different platforms.
Information for new and existing customers.
Update GitLab
Update your GitLab self-managed instance to the latest version.
GitLab Releases
What’s new in GitLab.

Have a look at some of our most popular documentation resources:

Popular TopicDescription
Configuring .gitlab-ci.ymlComplete syntax documentation for configuring your CI pipelines.
GitLab CI/CD examplesGet up to speed quickly with common CI/CD scenarios.
GitLab Container RegistryHost Docker images within GitLab.
GitLab PagesHost static websites for your projects with GitLab. settingsSettings for
Kubernetes integrationUse GitLab with Kubernetes.
SSH authenticationSecure your network communications.
Using Docker imagesBuild and test your applications with Docker.
GraphQLExplore GitLab’s GraphQL API.

The entire DevOps Lifecycle

GitLab is the first single application for software development, security, and operations that enables Concurrent DevOps, making the software lifecycle faster and radically improving the speed of business.

GitLab provides solutions for all the stages of the DevOps lifecycle:

DevOps Stages

GitLab is like a top-of-the-line kitchen for making software. As the executive chef, you decide what software you want to serve. Using your recipe, GitLab handles all the prep work, cooking, and delivery, so you can turn around orders faster than ever.

The following sections provide links to documentation for each DevOps stage:

DevOps StageDocumentation for
ManageStatistics and analytics features.
PlanProject planning and management features.
CreateSource code and data creation and management features.
VerifyTesting, code quality, and continuous integration features.
PackageDocker container registry.
ReleaseApplication release and delivery features.
ConfigureApplication and infrastructure configuration tools.
MonitorApplication monitoring and metrics features.
SecureSecurity capability features.
Back to Overview


GitLab provides statistics and insight into ways you can maximize the value of GitLab in your organization.

The following documentation relates to the DevOps Manage stage:

Manage TopicsDescription
Authentication and
Supported authentication and authorization providers.
GitLab Value Stream AnalyticsMeasure the time it takes to go from an idea to production for each project you have.
Instance StatisticsDiscover statistics on how many GitLab features you use and user activity.
Back to Overview


Whether you use Waterfall, Agile, or Conversational Development, GitLab streamlines your collaborative workflows.

Visualize, prioritize, coordinate, and track your progress your way with GitLab’s flexible project management tools.

The following documentation relates to the DevOps Plan stage:

Plan TopicsDescription
Burndown Charts Watch your project’s progress throughout a specific milestone.
DiscussionsThreads, comments, and resolvable threads in issues, commits, and merge requests.
Due DatesKeep track of issue deadlines.
Epics Tracking groups of issues that share a theme.
Issues, including confidential issues,
issue and merge request templates,
and moving issues
Project issues and restricting access to issues as well as creating templates for submitting new issues and merge requests. Also, moving issues between projects.
LabelsCategorize issues or merge requests with descriptive labels.
MilestonesSet milestones for delivery of issues and merge requests, with optional due date.
Project Issue BoardDisplay issues on a Scrum or Kanban board.
Quick ActionsShortcuts for common actions on issues or merge requests, replacing the need to click buttons or use dropdowns in GitLab’s UI.
Related Issues Create a relationship between issues.
Roadmap Visualize epic timelines.
Service Desk A simple way to allow people to create issues in your GitLab instance without needing their own user account.
Time TrackingTrack time spent on issues and merge requests.
TodosKeep track of work requiring attention with a chronological list displayed on a simple dashboard.
Back to Overview


Consolidate source code into a single distributed version control system that’s easily managed and controlled without disrupting your workflow.

GitLab’s Git repositories come complete with branching tools and access controls, providing a scalable, single source of truth for collaborating on projects and code.

The following documentation relates to the DevOps Create stage:

Projects and Groups

Create Topics - Projects and GroupsDescription
Advanced global search Leverage Elasticsearch for faster, more advanced code search across your entire GitLab instance.
Advanced syntax search Use advanced queries for more targeted search results.
Contribution analytics See detailed statistics of group contributors.
Create and fork projects, and
import and export projects
between instances
Create, duplicate, and move projects.
File locking Lock files to avoid merge conflicts.
GitLab PagesBuild, test, and deploy your static website with GitLab Pages.
Groups and SubgroupsOrganize your projects in groups.
Issues Analytics Check how many issues were created per month.
Projects, including project access
and settings
Host source code, and control your project’s visibility and set configuration.
Search through GitLabSearch for issues, merge requests, projects, groups, and todos.
SnippetsSnippets allow you to create little bits of code.
Web IDEEdit files within GitLab’s user interface.
WikisEnhance your repository documentation with built-in wikis.
Back to Overview


Create Topics - RepositoriesDescription
Branches and the default branchHow to use branches in GitLab.
Commits and signing commitsWork with commits, and use GPG to sign your commits.
Create branches, create
and upload files, and create directories
Create branches, create and upload files, and create directories within GitLab.
Delete merged branchesBulk delete branches after their changes are merged.
File templatesFile templates for common files.
FilesFiles management.
Jupyter Notebook filesGitLab’s support for .ipynb files.
Protected branchesUse protected branches.
Push rules Additional control over pushes to your projects.
RepositoriesManage source code repositories in GitLab’s user interface.
Repository mirroring Push to or pull from repositories outside of GitLab
Start a merge requestStart merge request when committing via GitLab’s user interface.
Back to Overview

Merge Requests

Create Topics - Merge RequestsDescription
Checking out merge requests locallyTips for working with merge requests locally.
Cherry-pickingUse GitLab for cherry-picking changes.
Merge request thread resolutionResolve threads, move threads in a merge request to an issue, and only allow merge requests to be merged if all threads are resolved.
Merge requestsMerge request management.
Work In Progress “WIP” merge requestsPrevent merges of work-in-progress merge requests.
Back to Overview

Integration and Automation

Create Topics - Integration and AutomationDescription
GitLab APIIntegrate GitLab via a simple and powerful API.
GitLab IntegrationIntegrate with multiple third-party services with GitLab to allow external issue trackers and external authentication.
GitLab WebhooksLet GitLab notify you when new code has been pushed to your project.
Jira Development Panel See GitLab information in the Jira Development Panel.
Project ServicesIntegrate a project with external services, such as CI and chat.
Trello Power-UpIntegrate with GitLab’s Trello Power-Up.
Back to Overview


Spot errors sooner, improve security and shorten feedback cycles with built-in static code analysis, code testing, code quality, dependency checking, and Review Apps. Customize your approval workflow controls, automatically test the quality of your code, and spin up a staging environment for every code change.

GitLab Continuous Integration is the most popular next generation testing system that scales to run your tests faster.

The following documentation relates to the DevOps Verify stage:

Verify TopicsDescription
Code Quality reports Analyze source code quality.
GitLab CI/CDExplore the features and capabilities of Continuous Integration with GitLab.
JUnit test reportsDisplay JUnit test reports on merge requests.
Multi-project pipelines Visualize entire pipelines that span multiple projects, including all cross-project inter-dependencies.
Pipeline GraphsVisualize builds.
Review AppsPreview changes to your application right from a merge request.
Back to Overview


GitLab Packages allows organizations to utilize GitLab as a private repository for a variety of common package managers. Users are able to build and publish packages, which can be easily consumed as a dependency in downstream projects.

The following documentation relates to the DevOps Package stage:

Package TopicsDescription
Container RegistryThe GitLab Container Registry enables every project in GitLab to have its own space to store Docker images.
Dependency Proxy The GitLab Dependency Proxy sets up a local proxy for frequently used upstream images/packages.
Conan Repository The GitLab Conan Repository enables every project in GitLab to have its own space to store Conan packages.
Maven Repository The GitLab Maven Repository enables every project in GitLab to have its own space to store Maven packages.
NPM Registry The GitLab NPM Registry enables every project in GitLab to have its own space to store NPM packages.
Back to Overview


Spend less time configuring your tools, and more time creating. Whether you’re deploying to one server or thousands, build, test, and release your code confidently and securely with GitLab’s built-in Continuous Delivery and Deployment.

The following documentation relates to the DevOps Release stage:

Release TopicsDescription
Auto DeployConfigure GitLab for the deployment of your application.
Canary Deployments Employ a popular CI strategy where a small portion of the fleet is updated to the new version first.
Deploy Boards View the current health and status of each CI environment running on Kubernetes, displaying the status of the pods in the deployment.
Environments and deploymentsWith environments, you can control the continuous deployment of your software within GitLab.
Environment-specific variablesLimit scope of variables to specific environments.
GitLab CI/CDExplore the features and capabilities of Continuous Deployment and Delivery with GitLab.
GitLab PagesBuild, test, and deploy a static site directly from GitLab.
Protected RunnersSelect Runners to only pick jobs for protected branches and tags.
Scheduled PipelinesExecute pipelines on a schedule.
Back to Overview


Automate your entire workflow from build to deploy and monitoring with GitLab Auto DevOps. Best practice templates get you started with minimal to zero configuration. Then customize everything from buildpacks to CI/CD.

The following documentation relates to the DevOps Configure stage:

Configure TopicsDescription
Auto DevOpsAutomatically employ a complete DevOps lifecycle.
Create Kubernetes clustersUse Kubernetes and GitLab.
Executable RunbooksDocumented procedures that explain how to carry out particular processes.
GitLab ChatOpsInteract with CI/CD jobs through chat services.
Installing ApplicationsDeploy Helm, Ingress, and Prometheus on Kubernetes.
Mattermost slash commandsEnable and use slash commands from within Mattermost.
Multiple Kubernetes Clusters Associate more than one Kubernetes clusters to your project.
Protected variablesRestrict variables to protected branches and tags.
ServerlessRun serverless workloads on Kubernetes.
Slack slash commandsEnable and use slash commands from within Slack.
Manage your infrastructure with TerraformManage your infrastructure as you run your CI/CD pipeline.
Back to Overview


Ensure your applications are always responsive and available.

GitLab collects and displays performance metrics for deployed applications so you can know in an instant how code changes impact your production environment.

The following documentation relates to the DevOps Monitor stage:

Monitor TopicsDescription
GitLab Performance Monitoring Use InfluxDB and Grafana to monitor the performance of your GitLab instance (will be eventually replaced by Prometheus).
GitLab Prometheus Configure the bundled Prometheus to collect various metrics from your GitLab instance.
Health checkGitLab provides liveness and readiness probes to indicate service health and reachability to required services.
Prometheus project integrationConfigure the Prometheus integration per project and monitor your CI/CD environments.
Prometheus metricsLet Prometheus collect metrics from various services, like Kubernetes, NGINX, NGINX Ingress controller, HAProxy, and Amazon Cloud Watch.
Incident managementUse GitLab to help you better respond to incidents that may occur in your systems.
Back to Overview


Check your application for security vulnerabilities that may lead to unauthorized access, data leaks, and denial of services. GitLab will perform static and dynamic tests on the code of your application, looking for known flaws and report them in the merge request so you can fix them before merging. Security teams can use dashboards to get a high-level view on projects and groups, and start remediation processes when needed.

The following documentation relates to the DevOps Secure stage:

Secure TopicsDescription
Compliance Dashboard View the most recent Merge Request activity in a group.
Container Scanning Use Clair to scan docker images for known vulnerabilities.
Dependency List View your project’s dependencies and their known vulnerabilities.
Dependency Scanning Analyze your dependencies for known vulnerabilities.
Dynamic Application Security Testing (DAST) Analyze running web applications for known vulnerabilities.
Group Security Dashboard View vulnerabilities in all the projects in a group and its subgroups.
Instance Security Dashboard View vulnerabilities in all the projects you’re interested in.
License Compliance Search your project’s dependencies for their licenses.
Pipeline Security Dashboard View the security reports for your project’s pipelines.
Project Security Dashboard View the latest security reports for your project.
Static Application Security Testing (SAST) Analyze source code for known vulnerabilities.

New to Git and GitLab?

Working with new systems can be daunting.

We have the following documentation to rapidly uplift your GitLab knowledge:

GitLab basics guidesStart working on the command line and with GitLab.
GitLab workflow overviewEnhance your workflow with the best of GitLab Workflow.
Get started with GitLab CI/CDQuickly implement GitLab CI/CD.
Auto DevOpsLearn more about GitLab’s Auto DevOps.
GitLab MarkdownGitLab’s advanced formatting system (GitLab Flavored Markdown)
Back to Overview

User account

Learn more about GitLab account management:

User accountManage your account.
AuthenticationAccount security with two-factor authentication, set up your SSH keys, and deploy keys for secure access to your projects.
Profile settingsManage your profile settings, two factor authentication, and more.
User permissionsLearn what each role in a project can do.
Back to Overview

Git and GitLab

Learn more about using Git, and using Git with GitLab:

GitGetting started with Git, branching strategies, Git LFS, and advanced use.
Git cheat sheetDownload a PDF describing the most used Git operations.
GitLab FlowExplore the best of Git with the GitLab Flow strategy.
Back to Overview

Coming to GitLab from another platform

If you are coming to GitLab from another platform, you’ll find the following information useful:

Importing to GitLabImport your projects from GitHub, Bitbucket,, FogBugz, and SVN into GitLab.
Migrating from SVNConvert a SVN repository to Git and GitLab.
Back to Overview

Building an integration with GitLab

There are many ways to integrate with GitLab, including:

GitLab APIIntegrate GitLab via a simple and powerful API.
Integrations and automationAll GitLab integration and automation options.
Back to Overview

Contributing to GitLab

GitLab Community Edition is open source and GitLab Enterprise Edition is open-core.

Learn how to contribute to GitLab with the following resources:

DevelopmentHow to contribute to GitLab development.
LegalContributor license agreements.
Writing documentationHow to contribute to GitLab Docs.
Back to Overview