Skip to content

User documentation

Welcome to GitLab! We're glad to have you here!

As a GitLab user you'll have access to all the features your subscription includes, except GitLab administrator settings, unless you have admin privileges to install, configure, and upgrade your GitLab instance.

For GitLab.com, admin privileges are restricted to the GitLab team.

If you run your own GitLab instance and are looking for the administration settings, please refer to the administration documentation.

Overview

GitLab is a fully integrated software development platform that enables you and your team to work cohesively, faster, transparently, and effectively, since the discussion of a new idea until taking that idea to production all the way through, from within the same platform.

Please check this page for an overview on GitLab's features.

Concepts

For an overview on concepts involved when developing code on GitLab, read the articles on:

Use cases

GitLab is a Git-based platform that integrates a great number of essential tools for software development and deployment, and project management:

With GitLab Enterprise Edition, you can also:

You can also integrate GitLab with numerous third-party applications, such as Mattermost, Microsoft Teams, HipChat, Trello, Slack, Bamboo CI, JIRA, and a lot more.

Projects

In GitLab, you can create projects for numerous reasons, such as, host your code, use it as an issue tracker, collaborate on code, and continuously build, test, and deploy your app with built-in GitLab CI/CD. Or, you can do it all at once, from one single project.

  • Repositories: Host your codebase in repositories with version control and as part of a fully integrated platform.
  • Issues: Explore the best of GitLab Issues' features.
  • Merge Requests: Collaborate on code, reviews, live preview changes per branch, and request approvals with Merge Requests.
  • Milestones: Work on multiple issues and merge requests towards the same target date with Milestones.

GitLab CI/CD

Use built-in GitLab CI/CD to test, build, and deploy your applications directly from GitLab. No third-party integrations needed.

  • GitLab Auto Deploy: Deploy your application out-of-the-box with GitLab Auto Deploy.
  • Review Apps: Live-preview the changes introduced by a merge request with Review Apps.
  • GitLab Pages: Publish your static site directly from GitLab with GitLab Pages. You can build, test, and deploy any Static Site Generator with Pages.
  • GitLab Container Registry: Build and deploy Docker images with Container Registry.

Account

There is a lot you can customize and configure to enjoy the best of GitLab.

  • Settings: Manage your user settings to change your personal info, personal access tokens, authorized applications, etc.
  • Authentication: Read through the authentication methods available in GitLab.
  • Permissions: Learn the different set of permissions levels for each user type (guest, reporter, developer, maintainer, owner).
  • Feature highlight: Learn more about the little blue dots around the app that explain certain features

Groups

With GitLab Groups you can assemble related projects together and grant members access to several projects at once.

Groups can also be nested in subgroups.

Discussions

In GitLab, you can comment and mention collaborators in issues, merge requests, code snippets, and commits.

When performing inline reviews to implementations to your codebase through merge requests you can gather feedback through resolvable discussions.

GitLab Flavored Markdown (GFM)

Read through the GFM documentation to learn how to apply the best of GitLab Flavored Markdown in your discussions, comments, issues and merge requests descriptions, and everywhere else GMF is supported.

Todos

Never forget to reply to your collaborators. GitLab Todos are a tool for working faster and more effectively with your team, by listing all user or group mentions, as well as issues and merge requests you're assigned to.

Search

Search and filter through groups, projects, issues, merge requests, files, code, and more.

Snippets

Snippets are code blocks that you want to store in GitLab, from which you have quick access to. You can also gather feedback on them through discussions.

Integrations

Integrate GitLab with your preferred tool, such as Trello, JIRA, etc.

Webhooks

Configure webhooks to listen for specific events like pushes, issues or merge requests. GitLab will send a POST request with data to the webhook URL.

API

Automate GitLab via API.

Git and GitLab

Learn what is Git and its best practices.

Instance statistics

See various statistics of your GitLab instance.