| [**User Documentation**](user/index.md)<br/>Discover features and concepts for GitLab users. | [**Administrator documentation**](administration/index.md)<br/>Everything GitLab self-managed administrators need to know. |
| [**Contributing to GitLab**](#contributing-to-gitlab)<br/>At GitLab, everyone can contribute! | [**New to Git and GitLab?**](#new-to-git-and-gitlab)<br/>We have resources to get you started. |
| [**Building an integration with GitLab?**](#building-an-integration-with-gitlab)<br/>Consult our automation and integration documentation. | [**Coming to GitLab from another platform?**](#coming-to-gitlab-from-another-platform)<br/>Consult our handy guides. |
| [**Install GitLab**](https://about.gitlab.com/install/)<br/>Installation options for different platforms. | [**Subscribe to GitLab**](#subscribe-to-gitlab)<br/>Get access to more features. |
| [**Update GitLab**](update/README.md)<br/>Update your GitLab self-managed instance to the latest version. | [**GitLab Releases**](https://about.gitlab.com/releases/)<br/>What's new in GitLab. |
## Popular Documentation
Have a look at some of our most popular documentation resources:
| [Authentication and Authorization](administration/auth/README.md)**[CORE ONLY]** | Supported authentication and authorization providers. |
| [GitLab Cycle Analytics](user/project/cycle_analytics.md) | Measure the time it takes to go from an [idea to production](https://about.gitlab.com/2016/08/05/continuous-integration-delivery-and-deployment-with-gitlab/#from-idea-to-production-with-gitlab) for each project you have. |
| [Instance Statistics](user/instance_statistics/index.md) | Discover statistics on how many GitLab features you use and user activity. |
| [Epics](user/group/epics/index.md)**[ULTIMATE]** | Tracking groups of issues that share a theme. |
-[Related Issues](user/project/issues/related_issues.md): create a relationship between issues.**[STARTER]**
| [Issues](user/project/issues/index.md), including [confidential issues](user/project/issues/confidential_issues.md), [issue and merge request templates](user/project/description_templates.md), and [moving issues](user/project/issues/moving_issues.md) | Project issues, restricting access to issues, create templates for submitting new issues and merge requests, and moving issues between projects. |
-[Issues and merge requests templates](user/project/description_templates.md): Create templates for submitting new issues and merge requests.
| [Labels](user/project/labels.md) | Categorize issues or merge requests with descriptive labels. |
-[Labels](user/project/labels.md): Categorize your issues or merge requests based on descriptive titles.
| [Milestones](user/project/milestones/index.md) | Set milestones for delivery of issues and merge requests, with optional due date. |
-[Milestones](user/project/milestones/index.md): Organize issues and merge requests into a cohesive group, optionally setting a due date.
| [Project Issue Board](user/project/issue_board.md) | Display issues on a Scrum or Kanban board. |
-[Burndown Charts](user/project/milestones/burndown_charts.md): Watch your project's progress throughout a specific milestone. **[STARTER]**
| [Quick Actions](user/project/quick_actions.md) | Shortcuts for common actions on issues or merge requests, replacing the need to click buttons or use dropdowns in GitLab's UI. |
-[Todos](workflow/todos.md): A chronological list of to-dos that are waiting for your input, all in a simple dashboard.
| [Related Issues](user/project/issues/related_issues.md)**[STARTER]** | Create a relationship between issues. |
-[GitLab Quick Actions](user/project/quick_actions.md): Textual shortcuts for common actions on issues or merge requests that are usually done by clicking buttons or dropdowns in GitLab's UI.
-[Service Desk](user/project/service_desk.md): A simple way to allow people to create issues in your GitLab instance without needing their own user account. **[PREMIUM]**
| [Service Desk](user/project/service_desk.md)**[PREMIUM]** | A simple way to allow people to create issues in your GitLab instance without needing their own user account. |
| [Time Tracking](workflow/time_tracking.md) | Track time spent on issues and merge requests. |
#### Migrate and import your projects from other platforms
| [Todos](workflow/todos.md) | Keep track of work requiring attention with a chronological list displayed on a simple dashboard. |
-[Importing to GitLab](user/project/import/index.md): Import your projects from GitHub, Bitbucket, GitLab.com, FogBugz and SVN into GitLab.
<divalign="right">
-[Migrating from SVN](workflow/importing/migrating_from_svn.md): Convert a SVN repository to Git and GitLab.
-[Importing and exporting projects between instances](user/project/settings/import_export.md).
| [Advanced global search](user/search/advanced_global_search.md)**[STARTER]** | Leverage Elasticsearch for faster, more advanced code search across your entire GitLab instance. |
-[Project access](public_access/public_access.md): Setting up your project's visibility to public, internal, or private.
| [Advanced syntax search](user/search/advanced_search_syntax.md)**[STARTER]** | Use advanced queries for more targeted search results. |
-[GitLab Pages](user/project/pages/index.md): Build, test, and deploy your static website with GitLab Pages.
| [Contribution analytics](user/group/contribution_analytics/index.md)**[STARTER]** | See detailed statistics of group contributors. |
-[Groups](user/group/index.md): Organize your projects in groups.
| [Create](gitlab-basics/create-project.md) and [fork](gitlab-basics/fork-project.md) projects, and [import and export projects between instances](user/project/settings/import_export.md) | Create, duplicate, and move projects. |
| [Groups](user/group/index.md) and [Subgroups](user/group/subgroups/index.md) | Organize your projects in groups. |
-[Contribution Analytics](user/group/contribution_analytics/index.md): See detailed statistics of group contributors. **[STARTER]**
| [Issues Analytics](user/group/issues_analytics/index.md)**[PREMIUM]** | Check how many issues were created per month. |
-[Issues Analytics](user/group/issues_analytics/index.md): Check how many issues were created per month. **[PREMIUM]**
| [Projects](user/project/index.md), including [project access](public_access/public_access.md) and [settings](user/project/settings/index.md) | Host source code, and control your project's visibility and set configuration. |
-[Search through GitLab](user/search/index.md): Search for issues, merge requests, projects, groups, todos, and issues in Issue Boards.
| [Search through GitLab](user/search/index.md) | Search for issues, merge requests, projects, groups, and todos. |
-[Advanced Global Search](user/search/advanced_global_search.md): Leverage Elasticsearch for faster, more advanced code search across your entire GitLab instance. **[STARTER]**
| [Snippets](user/snippets.md) | Snippets allow you to create little bits of code. |
-[Advanced Syntax Search](user/search/advanced_search_syntax.md): Use advanced queries for more targeted search results. **[STARTER]**
| [Web IDE](user/project/web_ide/index.md) | Edit files within GitLab's user interface. |
-[Snippets](user/snippets.md): Snippets allow you to create little bits of code.
| [Wikis](user/project/wiki/index.md) | Enhance your repository documentation with built-in wikis. |
-[Wikis](user/project/wiki/index.md): Enhance your repository documentation with built-in wikis.
| [Branches](user/project/repository/branches/index.md) and the [default branch](user/project/repository/branches/index.md#default-branch) | How to use branches in GitLab. |
-[Create a file](user/project/repository/web_editor.md#create-a-file)
| [Commits](user/project/repository/index.md#commits) and [signing commits](user/project/repository/gpg_signed_commits/index.md) | Work with commits, and use GPG to sign your commits. |
-[Upload a file](user/project/repository/web_editor.md#upload-a-file)
| [Create branches](user/project/repository/web_editor.md#create-a-new-branch), [create](user/project/repository/web_editor.md#create-a-file) and [upload](user/project/repository/web_editor.md#upload-a-file) files, and [create directories](user/project/repository/web_editor.md#create-a-directory) | Create branches, create and upload files, and create directories within GitLab. |
-[Merge Request discussion resolution](user/discussions/index.md#moving-a-single-discussion-to-a-new-issue): Resolve discussions, move discussions in a merge request to an issue, only allow merge requests to be merged if all discussions are resolved.
| [Checking out merge requests locally](user/project/merge_requests/index.md#checkout-merge-requests-locally) | Tips for working with merge requests locally. |
| [Merge request discussion resolution](user/discussions/index.md#moving-a-single-discussion-to-a-new-issue) | Resolve discussions, move discussions in a merge request to an issue, and only allow merge requests to be merged if all discussions are resolved. |
| [Work In Progress "WIP" merge requests](user/project/merge_requests/work_in_progress_merge_requests.md) | Prevent merges of work-in-progress merge requests. |
-[Project Services](user/project/integrations/project_services.md): Integrate a project with external services, such as CI and chat.
<divalign="right">
-[GitLab Integration](integration/README.md): Integrate with multiple third-party services with GitLab to allow external issue trackers and external authentication.
| [GitLab API](api/README.md) | Integrate GitLab via a simple and powerful API. |
| [GitLab Integration](integration/README.md) | Integrate with multiple third-party services with GitLab to allow external issue trackers and external authentication. |
| [GitLab Webhooks](user/project/integrations/webhooks.md) | Let GitLab notify you when new code has been pushed to your project. |
| [JIRA Development Panel](integration/jira_development_panel.md)**[PREMIUM]** | See GitLab information in the JIRA Development Panel. |
| [Project Services](user/project/integrations/project_services.md) | Integrate a project with external services, such as CI and chat. |
| [Trello Power-Up](integration/trello_power_up.md) | Integrate with GitLab's Trello Power-Up. |
apps. Customize your approval workflow controls, automatically test the quality
Apps. Customize your approval workflow controls, automatically test the quality
of your code, and spin up a staging environment for every code change. GitLab
of your code, and spin up a staging environment for every code change.
Continuous Integration is the most popular next generation testing system that
GitLab Continuous Integration is the most popular next generation testing system that
scales to run your tests faster.
scales to run your tests faster.
-[GitLab CI/CD](ci/README.md): Explore the features and capabilities of Continuous Integration, Continuous Delivery, and Continuous Deployment with GitLab.
The following documentation relates to the DevOps **Verify** stage:
-[Review Apps](ci/review_apps/index.md): Preview changes to your app right from a merge request.
| [Auto Deploy](topics/autodevops/index.md#auto-deploy) | Configure GitLab for the deployment of your application. |
-[Deploy Boards](user/project/deploy_boards.md): View of the current health and status of each CI environment running on Kubernetes, displaying the status of the pods in the deployment. **[PREMIUM]**
| [Canary Deployments](user/project/canary_deployments.md)**[PREMIUM]** | Employ a popular CI strategy where a small portion of the fleet is updated to the new version first. |
-[Canary Deployments](user/project/canary_deployments.md): A popular CI strategy, where a small portion of the fleet is updated to the new version first. **[PREMIUM]**
| [Deploy Boards](user/project/deploy_boards.md)**[PREMIUM]** | View the current health and status of each CI environment running on Kubernetes, displaying the status of the pods in the deployment. |
| [Environments and deployments](ci/environments.md) | With environments, you can control the continuous deployment of your software within GitLab. |
| [Environment-specific variables](ci/variables/README.md#limiting-environment-scopes-of-variables)**[PREMIUM]** | Limit scope of variables to specific environments. |
| [GitLab CI/CD](ci/README.md) | Explore the features and capabilities of Continuous Deployment and Delivery with GitLab. |
| [GitLab Pages](user/project/pages/index.md) | Build, test, and deploy a static site directly from GitLab. |
| [Protected Runners](ci/runners/README.md#protected-runners) | Select Runners to only pick jobs for protected branches and tags. |
| [Scheduled Pipelines](user/project/pipelines/schedules.md) | Execute pipelines on a schedule. |
| [Easy creation of Kubernetes clusters on GKE](user/project/clusters/index.md#adding-and-creating-a-new-gke-cluster-via-gitlab) | Use Google Kubernetes Engine and GitLab. |
| [Executable Runbooks](user/project/clusters/runbooks/index.md) | Documented procedures that explain how to carry out particular processes. |
| [GitLab ChatOps](ci/chatops/README.md)**[ULTIMATE]** | Interact with CI/CD jobs through chat services. |
| [Installing Applications](user/project/clusters/index.md#installing-applications) | Deploy Helm, Ingress, and Prometheus on Kubernetes. |
| [Mattermost slash commands](user/project/integrations/mattermost_slash_commands.md) | Enable and use slash commands from within Mattermost. |
| [Multiple Kubernetes Clusters](user/project/clusters/index.md#multiple-kubernetes-clusters)**[PREMIUM]** | Associate more than one Kubernetes clusters to your project. |
| [Protected variables](ci/variables/README.md#protected-variables) | Restrict variables to protected branches and tags. |
| [Slack slash commands](user/project/integrations/slack_slash_commands.md) | Enable and use slash commands from within Slack. |
Back to Overview <iclass="fa fa-angle-double-up"aria-hidden="true"></i>
</a>
</div>
### Monitor
### Monitor
Measure how long it takes to go from planning to monitoring and ensure your
Ensure your applications are always responsive and available.
applications are always responsive and available. GitLab collects and displays
performance metrics for deployed apps using Prometheus so you can know in an
GitLab collects and displays performance metrics for deployed applications so you can know in an
instant how code changes impact your production environment.
instant how code changes impact your production environment.
-[GitLab Prometheus](administration/monitoring/prometheus/index.md): Configure the bundled Prometheus to collect various metrics from your GitLab instance.
The following documentation relates to the DevOps **Monitor** stage:
-[Prometheus project integration](user/project/integrations/prometheus.md): Configure the Prometheus integration per project and monitor your CI/CD environments.
-[Prometheus metrics](user/project/integrations/prometheus_library/index.md): Let Prometheus collect metrics from various services, like Kubernetes, NGINX, NGINX ingress controller, HAProxy, and Amazon Cloud Watch.
| Monitor Topics | Description |
-[GitLab Performance Monitoring](administration/monitoring/performance/index.md): Use InfluxDB and Grafana to monitor the performance of your GitLab instance (will be eventually replaced by Prometheus).
-[Health check](user/admin_area/monitoring/health_check.md): GitLab provides liveness and readiness probes to indicate service health and reachability to required services.
| [GitLab Performance Monitoring](administration/monitoring/performance/index.md)**[CORE ONLY]** | Use InfluxDB and Grafana to monitor the performance of your GitLab instance (will be eventually replaced by Prometheus). |
-[GitLab Cycle Analytics](user/project/cycle_analytics.md): Cycle Analytics measures the time it takes to go from an
| [GitLab Prometheus](administration/monitoring/prometheus/index.md)**[CORE ONLY]** | Configure the bundled Prometheus to collect various metrics from your GitLab instance. |
[idea to production](https://about.gitlab.com/2016/08/05/continuous-integration-delivery-and-deployment-with-gitlab/#from-idea-to-production-with-gitlab) for each project you have.
| [Health check](user/admin_area/monitoring/health_check.md) | GitLab provides liveness and readiness probes to indicate service health and reachability to required services. |
| [Prometheus project integration](user/project/integrations/prometheus.md) | Configure the Prometheus integration per project and monitor your CI/CD environments. |
| [Prometheus metrics](user/project/integrations/prometheus_library/index.md) | Let Prometheus collect metrics from various services, like Kubernetes, NGINX, NGINX ingress controller, HAProxy, and Amazon Cloud Watch. |
| [Container Scanning](user/project/merge_requests/container_scanning.md)**[ULTIMATE]** | Use Clair to scan docker images for known vulnerabilities. |
| [Dependency Scanning](user/project/merge_requests/dependency_scanning.md)**[ULTIMATE]** | Analyze your dependencies for known vulnerabilities. |
| [Dynamic Application Security Testing (DAST)](user/project/merge_requests/dast.md)**[ULTIMATE]** | Analyze running web applications for known vulnerabilities. |
| [Group Security Dashboard](user/group/security_dashboard/index.md)**[ULTIMATE]** | View vulnerabilities in all the projects in a group and its subgroups. |
| [License Management](user/project/merge_requests/license_management.md)**[ULTIMATE]** | Search your project's dependencies for their licenses. |
| [Project Security Dashboard](user/project/security_dashboard.md)**[ULTIMATE]** | View the latest security reports for your project. |
| [Static Application Security Testing (SAST)](user/project/merge_requests/sast.md)**[ULTIMATE]** | Analyze source code for known vulnerabilities. |
-[GitLab Basics](gitlab-basics/README.md): Start working on your command line and on GitLab.
## Subscribe to GitLab
-[GitLab Workflow](workflow/README.md): Enhance your workflow with the best of GitLab Workflow.
- See also [GitLab Workflow - an overview](https://about.gitlab.com/2016/10/25/gitlab-workflow-an-overview/).
-[GitLab Markdown](user/markdown.md): GitLab's advanced formatting system (GitLab Flavored Markdown).
### User account
There are two ways to use GitLab:
-[User account](user/profile/index.md): Manage your account
-[GitLab self-managed](#gitlab-self-managed): Install, administer, and maintain your own GitLab instance.
-[Authentication](topics/authentication/index.md): Account security with two-factor authentication, set up your ssh keys and deploy keys for secure access to your projects.
-[GitLab.com](#gitlab-com): GitLab's SaaS offering. You don't need to install anything to use GitLab.com,
-[Profile settings](user/profile/index.md#profile-settings): Manage your profile settings, two factor authentication and more.
you only need to [sign up](https://gitlab.com/users/sign_in) and start using GitLab straight away.
-[User permissions](user/permissions.md): Learn what each role in a project (external/guest/reporter/developer/maintainer/owner) can do.
### Git and GitLab
The following sections outline tiers and features within GitLab self-managed and GitLab.com.
-[Git](topics/git/index.md): Getting started with Git, branching strategies, Git LFS, advanced use.
<divalign="right">
-[Git cheatsheet](https://about.gitlab.com/images/press/git-cheat-sheet.pdf): Download a PDF describing the most used Git operations.
to the same features available in GitLab self-managed, **except
[administration](administration/index.md) tools and settings**.
With GitLab self-hosted, you deploy your own GitLab instance on-premises or on a private cloud of your choice. GitLab self-hosted is available for [free and with paid subscriptions](https://about.gitlab.com/pricing/): Core, Starter, Premium, and Ultimate.
TIP: **Tip:**
To support the open source community and encourage the development of open source projects, GitLab grants access to **Gold** features for all GitLab.com **public** projects, regardless of the subscription.
Every feature available in Core is also available in Starter, Premium, and Ultimate.
The following resources are available for more information on GitLab.com:
Starter features are also available in Premium and Ultimate, and Premium features are also
available in Ultimate.
### GitLab.com
-[Feature comparison](https://about.gitlab.com/pricing/gitlab-com/feature-comparison/), for information on what features are available at each tier.
-[GitLab pricing page](https://about.gitlab.com/pricing/), for subscription information and a free trial.
- Our [product marketing page](https://about.gitlab.com/handbook/marketing/product-marketing/), for additional information including:
- How [different tiers are licensed](https://about.gitlab.com/handbook/marketing/product-marketing/#tiers).
- The different [GitLab distributions](https://about.gitlab.com/handbook/marketing/product-marketing/#distributions).
GitLab.com is hosted, managed, and administered by GitLab, Inc., with
<divalign="right">
[free and paid subscriptions](https://about.gitlab.com/gitlab-com/) for individuals
| [GitLab Basics](gitlab-basics/README.md) | Start working on the command line and with GitLab. |
| [GitLab Workflow](workflow/README.md) and [overview](https://about.gitlab.com/2016/10/25/gitlab-workflow-an-overview/) | Enhance your workflow with the best of GitLab Workflow. |
| [Get started with GitLab CI/CD](ci/quick_start/README.md) | Quickly implement GitLab CI/CD. |
| [Auto DevOps](topics/autodevops/index.md) | Learn more about GitLab's Auto DevOps. |
| [User account](user/profile/index.md) | Manage your account. |
| [Authentication](topics/authentication/index.md) | Account security with two-factor authentication, set up your ssh keys, and deploy keys for secure access to your projects. |
| [Profile settings](user/profile/index.md#profile-settings) | Manage your profile settings, two factor authentication, and more. |
| [User permissions](user/permissions.md) | Learn what each role in a project can do. |
