gitlab-org--gitlab-foss/doc/install/index.md

6.4 KiB

stage group info comments description type
Enablement Distribution To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments false Read through the GitLab installation methods. index

Installation (FREE SELF)

GitLab can be installed in most GNU/Linux distributions, and with several cloud providers. To get the best experience from GitLab, you must balance performance, reliability, ease of administration (backups, upgrades, and troubleshooting), and the cost of hosting.

Requirements

Before you install GitLab, be sure to review the system requirements. The system requirements include details about the minimum hardware, software, database, and additional requirements to support GitLab.

Choose the installation method

Depending on your platform, select from the following available methods to install GitLab:

Installation method Description When to choose
Linux package The official deb/rpm packages (also known as Omnibus GitLab) that contains a bundle of GitLab and the components it depends on, including PostgreSQL, Redis, and Sidekiq. This is the recommended method for getting started. The Linux packages are mature, scalable, and are used today on GitLab.com. If you need additional flexibility and resilience, we recommend deploying GitLab as described in the reference architecture documentation.
Helm charts The cloud native Helm chart for installing GitLab and all of its components on Kubernetes. When installing GitLab on Kubernetes, there are some trade-offs that you need to be aware of:
- Administration and troubleshooting requires Kubernetes knowledge.
- It can be more expensive for smaller installations. The default installation requires more resources than a single node Linux package deployment, as most services are deployed in a redundant fashion.
- There are some feature limitations to be aware of.

Use this method if your infrastructure is built on Kubernetes and you're familiar with how it works. The methods for management, observability, and some concepts are different than traditional deployments.
Docker The GitLab packages, Dockerized. Use this method if you're familiar with Docker.
Source Install GitLab and all of its components from scratch. Use this method if none of the previous methods are available for your platform. Useful for unsupported systems like *BSD.
GitLab Environment Toolkit (GET) The GitLab Environment toolkit provides a set of automation tools to deploy a reference architecture on most major cloud providers. Since GET is in beta and not yet recommended for production use, use this method if you want to test deploying GitLab in scalable environment.

Install GitLab on cloud providers

Regardless of the installation method, you can install GitLab on several cloud providers, assuming the cloud provider supports it. Here are several possible installation methods, the majority which use the Linux packages:

Cloud provider Description
AWS (HA) Install GitLab on AWS using the community AMIs provided by GitLab.
Google Cloud Platform (GCP) Install GitLab on a VM in GCP.
Azure Install GitLab from Azure Marketplace.
DigitalOcean Install GitLab on DigitalOcean. You can also test GitLab on DigitalOcean using Docker Machine.

Next steps

Here are a few resources you might want to check out after completing the installation:

  • Upload a license or start a free trial: Activate all GitLab Enterprise Edition functionality with a license.
  • Set up runners: Set up one or more GitLab Runners, the agents that are responsible for all of the GitLab CI/CD features.
  • GitLab Pages: Configure GitLab Pages to allow hosting of static sites.
  • GitLab Registry: With the GitLab Container Registry, every project can have its own space to store Docker images.
  • Secure GitLab: Recommended practices to secure your GitLab instance.
  • SMTP: Configure SMTP for proper email notifications support.
  • LDAP: Configure LDAP to be used as an authentication mechanism for GitLab.
  • Back up and restore GitLab: Learn the different ways you can back up or restore GitLab.
  • Upgrade GitLab: Every 22nd of the month, a new feature-rich GitLab version is released. Learn how to upgrade to it, or to an interim release that contains a security fix.
  • Scaling GitLab: GitLab supports several different types of clustering.
  • Advanced Search: Leverage Elasticsearch for faster, more advanced code search across your entire GitLab instance.
  • Geo replication: Geo is the solution for widely distributed development teams.
  • Release and maintenance policy: Learn about GitLab policies governing version naming, as well as release pace for major, minor, patch, and security releases.
  • Pricing: Pricing for the different tiers.