0e8a00cd14
Includes: - New enhanced overview button. - Aligning the top table. - Start of thorough edit and table reorganisation. |
||
|---|---|---|
| .. | ||
| administration | ||
| api | ||
| articles | ||
| ci | ||
| container_registry | ||
| customization | ||
| development | ||
| downgrade_ee_to_ce | ||
| gitlab-basics | ||
| hooks | ||
| img | ||
| incoming_email | ||
| install | ||
| integration | ||
| intro | ||
| legal | ||
| logs | ||
| markdown | ||
| migrate_ci_to_ce | ||
| monitoring | ||
| operations | ||
| pages | ||
| permissions | ||
| policy | ||
| profile | ||
| project_services | ||
| public_access | ||
| raketasks | ||
| security | ||
| ssh | ||
| system_hooks | ||
| topics | ||
| university | ||
| update | ||
| user | ||
| web_hooks | ||
| workflow | ||
| README.md | ||
README.md
| comments | description |
|---|---|
| false | Learn how to use and administer GitLab, the most scalable Git-based fully integrated platform for software development. |
GitLab Documentation
Welcome to GitLab Documentation.
Here you can access the complete documentation for GitLab, the single application for the entire DevOps lifecycle.
Overview
No matter how you use GitLab, we have documentation for you.
|
User documentation
Discover features and concepts for GitLab users. |
Administrator documentation
Everything GitLab administrators need to know. |
|
Contributing to GitLab
At GitLab, everyone can contribute! |
New to Git and GitLab?
We have resources to get you started. |
|
Building an integration with GitLab?
Consult our our automation and integration documentation. |
Coming to GitLab from another platform?
Consult our handy guides. |
TIP: Tip: You can also find documentation topics arranged by DevOps Lifecycle stage.
Popular Documentation
Have a look at some of our most popular documentation resources:
| Popular Topic | Description |
|---|---|
Configuring .gitlab-ci.yml |
Complete syntax documentation for configuring your CI pipelines. |
| GitLab CI/CD examples | Get up to speed quickly with common CI/CD scenarios. |
| GitLab Container Registry | Host containers within GitLab. |
| GitLab Pages | Host static websites for your projects with GitLab. |
| Kubernetes integration | Use GitLab with Kubernetes. |
| SSH authentication | Secure your network communications. |
| Using Docker images | Build and test your applications with Docker. |
Complete DevOps with GitLab
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:
The following sections provide links to documentation for each DevOps stage:
| DevOps Stage | Documentation for |
|---|---|
| Manage | Statistics and analytics features. |
| Plan | Project planning and management features. |
| Create | Source code and data creation and management features. |
| Verify | Testing, code quality, and continuous integration features. |
| Package | Docker container registry. |
| Release | Application release and delivery features. |
| Configure | Application and infrastructure configuration tools. |
| Monitor | Application monitoring and metrics features. |
| Secure | Security capability feature. |
Manage
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 Topics | Description |
|---|---|
| Authentication and Authorization | Supported authentication and authorization providers. |
| GitLab Cycle Analytics | Measure the time it takes to go from an idea to production for each project you have. |
| Instance Statistics | Discover statistics on how many GitLab features you use and user activity. |
Plan
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 Topics | Description |
|---|---|
| Discussions | Threads, comments, and resolvable discussions in issues, commits, and merge requests. |
| Due Dates | Keep track of issue deadlines. |
| Quick Actions | Shortcuts for common actions on issues or merge requests, replacing the need to click buttons or use dropdowns in GitLab's UI. |
| Issues, including confidential issues, issue and merge request templates, and moving issues | Project issues, restricting access to issues, create templates for submitting new issues and merge requests, and moving issues between projects. |
| Labels | Categorize issues or merge requests with descriptive labels. |
| Milestones | Set milestones for delivery of issues and merge requests, with optional due date. |
| Project Issue Board | Display issues on a Scrum or Kanban board. |
| Time Tracking | Track time spent on issues and merge requests. |
| Todos | Keep track of work requiring attention with a chronological list displayed on a simple dashboard. |
Create
Consolidate source code into a single DVCS 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 Topics | Description |
|---|---|
| Create a project | Create a project. |
| Fork a project | Duplicate a project. |
| GitLab Pages | Build, test, and deploy your static website with GitLab Pages. |
| Groups and Subgroups | Organize your projects in groups. |
| Importing and exporting projects between instances | Move projects. |
| Project access | Set up your project's visibility to public, internal, or private. |
| Project settings | Project configuration. |
| Projects | Host source code and bring many parts of GitLab together. |
| Search through GitLab | Search for issues, merge requests, projects, groups, todos, and issues in Issue Boards. |
| Snippets | Snippets allow you to create little bits of code. |
| Web IDE | Edit files within GitLab's user interface. |
| Wikis | Enhance your repository documentation with built-in wikis. |
| Repositories Topics | Description |
|---|---|
| Branches and the default branch | How to use branches in GitLab. |
| Commits and signing commits | Work with commits, and use GPG to sign your commits. |
| Create a branch | Create branches within GitLab's user interface. |
| Create a file, upload a file, and create a directory | Create and upload files, and create directories within GitLab. |
| Delete merged branches | Bulk delete branches after their changes are merged. |
| File templates | File templates for common files. |
| Files | Files management. |
| Jupyter Notebook files | GitLab's support for .ipynb files. |
| Protected branches | Use protected branches. |
| Repositories | Manage source code repositories in GitLab's user interface. |
| Start a merge request | Start merge request when commiting via GitLab's user interface. |
| Merge Requests Topics | Description |
|---|---|
| Checking out merge requests locally | Tips for working with merge requests locally. |
| Cherry-picking | Use GitLab for cherry-picking changes. |
| Merge request discussion resolution | Resolve discussions, move discussions in a merge request to an issue, only allow merge requests to be merged if all discussions are resolved. |
| Merge requests | Merge request management. |
| Work In Progress "WIP" merge requests | Prevent merges of work-in-progress merge requests. |
| Integrations Topics | Description |
|---|---|
| GitLab Integration | Integrate with multiple third-party services with GitLab to allow external issue trackers and external authentication. |
| Project Services | Integrate a project with external services, such as CI and chat. |
| Trello Power-Up | Integrate with GitLab's Trello Power-Up. |
| Automation Topics | Description |
|---|---|
| API | Automate GitLab via a simple and powerful API. |
| GitLab Webhooks | Let GitLab notify you when new code has been pushed to your project. |
Verify
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 Topics | Description |
|---|---|
| GitLab CI/CD | Explore the features and capabilities of Continuous Integration, Continuous Delivery, and Continuous Deployment with GitLab. |
| JUnit test reports | Display JUnit test reports on merge requests. |
| Pipeline Graphs | Visualize builds. |
| Review Apps | Preview changes to your app right from a merge request. |
Package
GitLab Container Registry gives you the enhanced security and access controls of custom Docker images without 3rd party add-ons. Easily upload and download images from GitLab CI/CD with full Git repository management integration.
The following documentation relates to the DevOps Package stage:
| Package Topics | Description |
|---|---|
| GitLab Container Registry | Learn how to use GitLab's built-in Container Registry. |
Release
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 Topics | Description |
|---|---|
| Auto Deploy | Configure GitLab CI for the deployment of your application. |
| Environments and deployments | With environments, you can control the continuous deployment of your software within GitLab. |
| GitLab Pages | Build, test, and deploy a static site directly from GitLab. |
| Protected Runners | Select Runners to only pick jobs for protected branches and tags. |
| Scheduled Pipelines | Execute pipelines on a schedule. |
Configure
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 Topics | Description |
|---|---|
| Auto DevOps | Automatically employ a complete DevOps lifecycle. |
| Easy creation of Kubernetes clusters on GKE | Use Google Kubernetes Engine and GitLab. |
| Executable Runbooks | Documented procedures that explain how to carry out particular processes. |
| Installing Applications | Deploy Helm, Ingress, and Prometheus on Kubernetes. |
| Mattermost slash commands | |
| Protected variables | Restrict variables to protected branches and tags. |
| Slack slash commands |
Monitor
Measure how long it takes to go from planning to monitoring and ensure your applications are always responsive and available.
GitLab collects and displays performance metrics for deployed apps using Prometheus so you can know in an instant how code changes impact your production environment.
The following documentation relates to the DevOps Monitor stage:
| Monitor Topics | Description |
|---|---|
| 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 check | GitLab provides liveness and readiness probes to indicate service health and reachability to required services. |
| Prometheus project integration | Configure the Prometheus integration per project and monitor your CI/CD environments. |
| Prometheus metrics | Let Prometheus collect metrics from various services, like Kubernetes, NGINX, NGINX ingress controller, HAProxy, and Amazon Cloud Watch. |
Secure
The following documentation relates to the DevOps Secure stage:
| Monitor Topics | Description |
|---|---|
| Container Scanning | Use Clair to scan docker images 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: Start working on your command line and on GitLab.
- GitLab Workflow: Enhance your workflow with the best of GitLab Workflow.
- See also GitLab Workflow - an overview.
- GitLab CI/CD quick start guide.
- Auto DevOps.
- GitLab Markdown: GitLab's advanced formatting system (GitLab Flavored Markdown).
User account
Learn more about GitLab account management:
- User account: Manage your account
- Authentication: Account security with two-factor authentication, set up your ssh keys and deploy keys for secure access to your projects.
- Profile settings: Manage your profile settings, two factor authentication and more.
- User permissions: Learn what each role in a project (external/guest/reporter/developer/maintainer/owner) can do.
Git and GitLab
Learn more about using Git, and using Git with GitLab:
- Git: Getting started with Git, branching strategies, Git LFS, advanced use.
- Git cheatsheet: Download a PDF describing the most used Git operations.
- GitLab Flow: explore the best of Git with the GitLab Flow strategy.
GitLab subscriptions
You have two options to use GitLab:
- GitLab self-managed: Install, administer, and maintain your own GitLab instance.
- GitLab.com: GitLab's SaaS offering. You don't need to install anything to use GitLab.com, you only need to sign up and start using GitLab straight away.
GitLab self-managed
With GitLab self-managed, you deploy your own GitLab instance on-premises or on a private cloud of your choice. GitLab self-managed is available for free and with paid subscriptions: Core, Starter, Premium, and Ultimate.
Every feature available in Core is also available in Starter, Premium, and Ultimate. Starter features are also available in Premium and Ultimate, and Premium features are also available in Ultimate.
GitLab.com
GitLab.com is hosted, managed, and administered by GitLab, Inc., with free and paid subscriptions for individuals and teams: Free, Bronze, Silver, and Gold.
GitLab.com subscriptions grants access to the same features available in GitLab self-managed, except administration tools and settings:
- GitLab.com Free includes the same features available in Core.
- GitLab.com Bronze includes the same features available in GitLab Starter.
- GitLab.com Silver includes the same features available in GitLab Premium.
- GitLab.com Gold includes the same features available in GitLab Ultimate.
For supporting the open source community and encouraging the development of open source projects, GitLab grants access to Gold features for all GitLab.com public projects, regardless of the subscription.
To know more about GitLab subscriptions and licensing, please refer to the GitLab Product Marketing Handbook.
Coming to GitLab from another platform
If you are coming to GitLab from another platform, you'll find the following information useful:
- Importing to GitLab: Import your projects from GitHub, Bitbucket, GitLab.com, FogBugz and SVN into GitLab.
- Migrating from SVN: Convert a SVN repository to Git and GitLab.
Building an integration with GitLab
There are many ways to integration with GitLab, including:
- Our API.
- Other integrations and automation.
Contributing to GitLab
GitLab Community Edition is open source and GitLab Enterprise Edition is open-core. Learn how to contribute to GitLab:
- Development: All styleguides and explanations how to contribute.
- Legal: Contributor license agreements.
- Writing documentation: Contributing to GitLab Docs.