203 lines
10 KiB
Markdown
203 lines
10 KiB
Markdown
# Requirements
|
|
|
|
## Operating Systems
|
|
|
|
### Supported Unix distributions
|
|
|
|
- Ubuntu
|
|
- Debian
|
|
- CentOS
|
|
- openSUSE
|
|
- Red Hat Enterprise Linux (please use the CentOS packages and instructions)
|
|
- Scientific Linux (please use the CentOS packages and instructions)
|
|
- Oracle Linux (please use the CentOS packages and instructions)
|
|
|
|
For the installations options please see [the installation page on the GitLab website](https://about.gitlab.com/installation/).
|
|
|
|
### Unsupported Unix distributions
|
|
|
|
- Arch Linux
|
|
- Fedora
|
|
- FreeBSD
|
|
- Gentoo
|
|
- macOS
|
|
|
|
On the above unsupported distributions is still possible to install GitLab yourself.
|
|
Please see the [installation from source guide](installation.md) and the [installation guides](https://about.gitlab.com/installation/) for more information.
|
|
|
|
### Non-Unix operating systems such as Windows
|
|
|
|
GitLab is developed for Unix operating systems.
|
|
It does **not** run on Windows, and we have no plans to support it in the near future. For the latest development status view this [issue](https://gitlab.com/gitlab-org/gitlab-ce/issues/46567).
|
|
Please consider using a virtual machine to run GitLab.
|
|
|
|
## Ruby versions
|
|
|
|
GitLab requires Ruby (MRI) 2.3. Support for Ruby versions below 2.3 (2.1, 2.2) will stop with GitLab 8.13.
|
|
|
|
You will have to use the standard MRI implementation of Ruby.
|
|
We love [JRuby](http://jruby.org/) and [Rubinius](http://rubini.us/) but GitLab
|
|
needs several Gems that have native extensions.
|
|
|
|
## Hardware requirements
|
|
|
|
### Storage
|
|
|
|
The necessary hard drive space largely depends on the size of the repos you want to store in GitLab but as a *rule of thumb* you should have at least as much free space as all your repos combined take up.
|
|
|
|
If you want to be flexible about growing your hard drive space in the future consider mounting it using LVM so you can add more hard drives when you need them.
|
|
|
|
Apart from a local hard drive you can also mount a volume that supports the network file system (NFS) protocol. This volume might be located on a file server, a network attached storage (NAS) device, a storage area network (SAN) or on an Amazon Web Services (AWS) Elastic Block Store (EBS) volume.
|
|
|
|
If you have enough RAM memory and a recent CPU the speed of GitLab is mainly limited by hard drive seek times. Having a fast drive (7200 RPM and up) or a solid state drive (SSD) will improve the responsiveness of GitLab.
|
|
|
|
### CPU
|
|
|
|
- 1 core supports up to 100 users but the application can be a bit slower due to having all workers and background jobs running on the same core
|
|
- **2 cores** is the **recommended** number of cores and supports up to 500 users
|
|
- 4 cores supports up to 2,000 users
|
|
- 8 cores supports up to 5,000 users
|
|
- 16 cores supports up to 10,000 users
|
|
- 32 cores supports up to 20,000 users
|
|
- 64 cores supports up to 40,000 users
|
|
- More users? Run it on [multiple application servers](https://about.gitlab.com/high-availability/)
|
|
|
|
### Memory
|
|
|
|
You need at least 8GB of addressable memory (RAM + swap) to install and use GitLab!
|
|
The operating system and any other running applications will also be using memory
|
|
so keep in mind that you need at least 4GB available before running GitLab. With
|
|
less memory GitLab will give strange errors during the reconfigure run and 500
|
|
errors during usage.
|
|
|
|
- 4GB RAM + 4GB swap supports up to 100 users but it will be very slow
|
|
- **8GB RAM** is the **recommended** memory size for all installations and supports up to 100 users
|
|
- 16GB RAM supports up to 2,000 users
|
|
- 32GB RAM supports up to 4,000 users
|
|
- 64GB RAM supports up to 8,000 users
|
|
- 128GB RAM supports up to 16,000 users
|
|
- 256GB RAM supports up to 32,000 users
|
|
- More users? Run it on [multiple application servers](https://about.gitlab.com/high-availability/)
|
|
|
|
We recommend having at least [2GB of swap on your server](https://askubuntu.com/a/505344/310789), even if you currently have
|
|
enough available RAM. Having swap will help reduce the chance of errors occurring
|
|
if your available memory changes. We also recommend [configuring the kernel's swappiness setting](https://askubuntu.com/a/103916)
|
|
to a low value like `10` to make the most of your RAM while still having the swap
|
|
available when needed.
|
|
|
|
Notice: The 25 workers of Sidekiq will show up as separate processes in your process overview (such as `top` or `htop`) but they share the same RAM allocation since Sidekiq is a multithreaded application. Please see the section below about Unicorn workers for information about how many you need of those.
|
|
|
|
## Database
|
|
|
|
The server running the database should have _at least_ 5-10 GB of storage
|
|
available, though the exact requirements depend on the size of the GitLab
|
|
installation (e.g. the number of users, projects, etc).
|
|
|
|
We currently support the following databases:
|
|
|
|
- PostgreSQL (highly recommended)
|
|
- MySQL/MariaDB (strongly discouraged, not all GitLab features are supported, no support for [MySQL/MariaDB GTID](https://mariadb.com/kb/en/mariadb/gtid/))
|
|
|
|
We highly recommend the use of PostgreSQL instead of MySQL/MariaDB as not all
|
|
features of GitLab work with MySQL/MariaDB:
|
|
|
|
1. MySQL support for subgroups was [dropped with GitLab 9.3][post].
|
|
See [issue #30472][30472] for more information.
|
|
1. GitLab Geo does [not support MySQL](https://docs.gitlab.com/ee/gitlab-geo/database.html#mysql-replication).
|
|
1. [Zero downtime migrations][zero] do not work with MySQL
|
|
1. GitLab [optimizes the loading of dashboard events](https://gitlab.com/gitlab-org/gitlab-ce/issues/31806) using [PostgreSQL LATERAL JOINs](https://blog.heapanalytics.com/postgresqls-powerful-new-join-type-lateral/).
|
|
1. In general, SQL optimized for PostgreSQL may run much slower in MySQL due to
|
|
differences in query planners. For example, subqueries that work well in PostgreSQL
|
|
may not be [performant in MySQL](https://dev.mysql.com/doc/refman/5.7/en/optimizing-subqueries.html)
|
|
1. We expect this list to grow over time.
|
|
|
|
Existing users using GitLab with MySQL/MariaDB are advised to
|
|
[migrate to PostgreSQL](../update/mysql_to_postgresql.md) instead.
|
|
|
|
[30472]: https://gitlab.com/gitlab-org/gitlab-ce/issues/30472
|
|
[zero]: ../update/README.md#upgrading-without-downtime
|
|
[post]: https://about.gitlab.com/2017/06/22/gitlab-9-3-released/#dropping-support-for-subgroups-in-mysql
|
|
|
|
### PostgreSQL Requirements
|
|
|
|
As of GitLab 10.0, PostgreSQL 9.6 or newer is required, and earlier versions are
|
|
not supported. We highly recommend users to use PostgreSQL 9.6 as this
|
|
is the PostgreSQL version used for development and testing.
|
|
|
|
Users using PostgreSQL must ensure the `pg_trgm` extension is loaded into every
|
|
GitLab database. This extension can be enabled (using a PostgreSQL super user)
|
|
by running the following query for every database:
|
|
|
|
```
|
|
CREATE EXTENSION pg_trgm;
|
|
```
|
|
|
|
On some systems you may need to install an additional package (e.g.
|
|
`postgresql-contrib`) for this extension to become available.
|
|
|
|
#### Additional requirements for GitLab Geo
|
|
|
|
If you are using [GitLab Geo](https://docs.gitlab.com/ee/development/geo.html), the [tracking database](https://docs.gitlab.com/ee/development/geo.html#geo-tracking-database) also requires the `postgres_fdw` extension.
|
|
|
|
```
|
|
CREATE EXTENSION postgres_fdw;
|
|
```
|
|
|
|
## Unicorn Workers
|
|
|
|
It's possible to increase the amount of unicorn workers and this will usually help to reduce the response time of the applications and increase the ability to handle parallel requests.
|
|
|
|
For most instances we recommend using: CPU cores + 1 = unicorn workers.
|
|
So for a machine with 2 cores, 3 unicorn workers is ideal.
|
|
|
|
For all machines that have 2GB and up we recommend a minimum of three unicorn workers.
|
|
If you have a 1GB machine we recommend to configure only two Unicorn workers to prevent excessive swapping.
|
|
|
|
To change the Unicorn workers when you have the Omnibus package (which defaults to the recommendation above) please see [the Unicorn settings in the Omnibus GitLab documentation](https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/doc/settings/unicorn.md#unicorn-settings).
|
|
|
|
## Redis and Sidekiq
|
|
|
|
Redis stores all user sessions and the background task queue.
|
|
The storage requirements for Redis are minimal, about 25kB per user.
|
|
Sidekiq processes the background jobs with a multithreaded process.
|
|
This process starts with the entire Rails stack (200MB+) but it can grow over time due to memory leaks.
|
|
On a very active server (10,000 active users) the Sidekiq process can use 1GB+ of memory.
|
|
|
|
## Prometheus and its exporters
|
|
|
|
As of Omnibus GitLab 9.0, [Prometheus](https://prometheus.io) and its related
|
|
exporters are enabled by default, to enable easy and in depth monitoring of
|
|
GitLab. Approximately 200MB of memory will be consumed by these processes, with
|
|
default settings.
|
|
|
|
If you would like to disable Prometheus and it's exporters or read more information
|
|
about it, check the [Prometheus documentation](../administration/monitoring/prometheus/index.md).
|
|
|
|
## GitLab Runner
|
|
|
|
We strongly advise against installing GitLab Runner on the same machine you plan
|
|
to install GitLab on. Depending on how you decide to configure GitLab Runner and
|
|
what tools you use to exercise your application in the CI environment, GitLab
|
|
Runner can consume significant amount of available memory.
|
|
|
|
Memory consumption calculations, that are available above, will not be valid if
|
|
you decide to run GitLab Runner and the GitLab Rails application on the same
|
|
machine.
|
|
|
|
It is also not safe to install everything on a single machine, because of the
|
|
[security reasons] - especially when you plan to use shell executor with GitLab
|
|
Runner.
|
|
|
|
We recommend using a separate machine for each GitLab Runner, if you plan to
|
|
use the CI features.
|
|
|
|
[security reasons]: https://gitlab.com/gitlab-org/gitlab-runner/blob/master/docs/security/index.md
|
|
|
|
## Supported web browsers
|
|
|
|
We support the current and the previous major release of Firefox, Chrome/Chromium, Safari and Microsoft browsers (Microsoft Edge and Internet Explorer 11).
|
|
|
|
Each time a new browser version is released, we begin supporting that version and stop supporting the third most recent version.
|
|
|
|
Note: We do not support running GitLab with JavaScript disabled in the browser and have no plans of supporting that
|
|
in the future because we have features such as Issue Boards which require JavaScript extensively.
|