| .. | ||
| aws | ||
| azure | ||
| google_cloud_platform | ||
| kubernetes | ||
| openshift_and_gitlab | ||
| pivotal | ||
| digitaloceandocker.md | ||
| docker.md | ||
| google-protobuf.md | ||
| installation.md | ||
| ldap.md | ||
| README.md | ||
| redis.md | ||
| relative_url.md | ||
| requirements.md | ||
| structure.md | ||
| comments | description | type |
|---|---|---|
| false | Read through the GitLab installation methods. | index |
Installation (CORE ONLY)
GitLab can be installed in most GNU/Linux distributions and in a number of cloud providers. To get the best experience from GitLab, you need to balance performance, reliability, ease of administration (backups, upgrades and troubleshooting), and cost of hosting.
There are many ways you can install GitLab depending on your platform:
- Omnibus GitLab: The official deb/rpm packages that contain a bundle of GitLab and the various components it depends on, like PostgreSQL, Redis, Sidekiq, etc.
- GitLab Helm chart: The cloud native Helm chart for installing GitLab and all its components on Kubernetes.
- Docker: The Omnibus GitLab packages dockerized.
- Source: Install GitLab and all its components from scratch.
TIP: If in doubt, choose Omnibus: The Omnibus GitLab packages are mature, scalable and are used today on GitLab.com. The Helm charts are recommended for those who are familiar with Kubernetes.
Requirements
Before installing GitLab, it is of critical importance to review the system requirements. The system requirements include details on the minimum hardware, software, database, and additional requirements to support GitLab.
Installing GitLab using the Omnibus GitLab package (recommended)
The Omnibus GitLab package uses our official deb/rpm repositories. This is recommended for most users.
If you need additional flexibility and resilience, we recommend deploying GitLab as described in our reference architecture documentation.
> Install GitLab using the Omnibus GitLab package.
Installing GitLab on Kubernetes via the GitLab Helm charts
NOTE: Kubernetes experience required: We recommend being familiar with Kubernetes before using it to deploy GitLab in production. The methods for management, observability, and some concepts are different than traditional deployments.
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 Omnibus deployment, as most services are deployed in a redundant fashion.
- There are some feature limitations to be aware of.
> Install GitLab on Kubernetes using the GitLab Helm charts.
Installing GitLab with Docker
GitLab maintains a set of official Docker images based on the Omnibus GitLab package.
> Install GitLab using the official GitLab Docker images.
Installing GitLab from source
If the Omnibus GitLab package is not available in your distribution, you can install GitLab from source: Useful for unsupported systems like *BSD. For an overview of the directory structure, read the structure documentation.
Installing GitLab on cloud providers
GitLab can be installed on a variety of cloud providers by using any of the above methods, provided the cloud provider supports it.
- Install on AWS: Install Omnibus GitLab on AWS using the community AMIs that GitLab provides.
- Install GitLab on Google Cloud Platform: Install Omnibus GitLab on a VM in GCP.
- Install GitLab on Azure: Install Omnibus GitLab from Azure Marketplace.
- Install GitLab on OpenShift: Install GitLab on OpenShift by using GitLab's Helm charts.
- Install GitLab on DC/OS: Install GitLab on Mesosphere DC/OS via the GitLab-Mesosphere integration.
- Install GitLab on DigitalOcean: Install Omnibus GitLab on DigitalOcean.
- Testing only! DigitalOcean and Docker Machine: Quickly test any version of GitLab on DigitalOcean using Docker Machine.
Securing your GitLab installation
After completing your installation, check out our recommended practices to secure your GitLab instance.