requirements.md 9.99 KB
Newer Older
1 2 3
# Requirements

## Operating Systems
4

5
### Supported Unix distributions
6

7 8
- Ubuntu
- Debian
9
- CentOS
10
- openSUSE
11
- Red Hat Enterprise Linux (please use the CentOS packages and instructions)
12 13
- Scientific Linux (please use the CentOS packages and instructions)
- Oracle Linux (please use the CentOS packages and instructions)
14

15 16
For the installations options please see [the installation page on the GitLab website](https://about.gitlab.com/installation/).

17
### Unsupported Unix distributions
18 19

- Arch Linux
20
- Fedora
21
- FreeBSD
22 23
- Gentoo
- macOS
24

25
On the above unsupported distributions is still possible to install GitLab yourself.
26
Please see the [installation from source guide](installation.md) and the [installation guides](https://about.gitlab.com/installation/) for more information.
27

28
### Non-Unix operating systems such as Windows
29

30 31
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).
32
Please consider using a virtual machine to run GitLab.
33

34
## Ruby versions
35

36
GitLab requires Ruby (MRI) 2.3. Support for Ruby versions below 2.3 (2.1, 2.2) will stop with GitLab 8.13.
37

38
You will have to use the standard MRI implementation of Ruby.
39 40
We love [JRuby](http://jruby.org/) and [Rubinius](http://rubini.us/) but GitLab
needs several Gems that have native extensions.
41

42
## Hardware requirements
43

44 45
### Storage

46
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.
47 48 49 50 51 52 53

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.

54
### CPU
55

Ian Lee's avatar
Ian Lee committed
56
- 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
57 58 59
- **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
60 61 62
- 16 cores supports up to 10,000 users
- 32 cores supports up to 20,000 users
- 64 cores supports up to 40,000 users
63
- More users? Run it on [multiple application servers](https://about.gitlab.com/high-availability/)
64

65
### Memory
66

67
You need at least 8GB of addressable memory (RAM + swap) to install and use GitLab!
68
The operating system and any other running applications will also be using memory
69
so keep in mind that you need at least 4GB available before running GitLab. With
70 71
less memory GitLab will give strange errors during the reconfigure run and 500
errors during usage.
72

73 74
- 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
75 76 77 78 79
- 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
80
- More users? Run it on [multiple application servers](https://about.gitlab.com/high-availability/)
81

82
We recommend having at least [2GB of swap on your server](https://askubuntu.com/a/505344/310789), even if you currently have
Chris Spicer's avatar
Chris Spicer committed
83
enough available RAM. Having swap will help reduce the chance of errors occurring
René Genz's avatar
René Genz committed
84
if your available memory changes. We also recommend [configuring the kernel's swappiness setting](https://askubuntu.com/a/103916)
85 86
to a low value like `10` to make the most of your RAM while still having the swap
available when needed.
87

88
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.
89

90 91
## Database

92 93 94 95
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).

96 97
We currently support the following databases:

98
- PostgreSQL (highly recommended)
99
- MySQL/MariaDB (strongly discouraged, not all GitLab features are supported, no support for [MySQL/MariaDB GTID](https://mariadb.com/kb/en/mariadb/gtid/))
100

Sid Sijbrandij's avatar
Sid Sijbrandij committed
101
We highly recommend the use of PostgreSQL instead of MySQL/MariaDB as not all
102
features of GitLab work with MySQL/MariaDB:
103

104
1. MySQL support for subgroups was [dropped with GitLab 9.3][post].
105 106 107
   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
108 109 110 111
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)
Sid Sijbrandij's avatar
Sid Sijbrandij committed
112
1. We expect this list to grow over time.
113

114
Existing users using GitLab with MySQL/MariaDB are advised to
115
[migrate to PostgreSQL](../update/mysql_to_postgresql.md) instead.
116

117 118
[30472]: https://gitlab.com/gitlab-org/gitlab-ce/issues/30472
[zero]: ../update/README.md#upgrading-without-downtime
119
[post]: https://about.gitlab.com/2017/06/22/gitlab-9-3-released/#dropping-support-for-subgroups-in-mysql
120

121 122
### PostgreSQL Requirements

Nick Thomas's avatar
Nick Thomas committed
123
As of GitLab 10.0, PostgreSQL 9.6 or newer is required, and earlier versions are
124
not supported. We highly recommend users to use PostgreSQL 9.6 as this
125
is the PostgreSQL version used for development and testing.
126

127 128 129 130
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:

131 132 133
```
CREATE EXTENSION pg_trgm;
```
134 135 136 137

On some systems you may need to install an additional package (e.g.
`postgresql-contrib`) for this extension to become available.

138 139 140 141 142 143 144 145
#### 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;
```

146 147 148 149 150 151 152 153 154 155
## 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.

156
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).
157

158 159 160
## Redis and Sidekiq

Redis stores all user sessions and the background task queue.
Sid Sijbrandij's avatar
Sid Sijbrandij committed
161
The storage requirements for Redis are minimal, about 25kB per user.
162 163
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.
Ben Bodenmiller's avatar
Ben Bodenmiller committed
164
On a very active server (10,000 active users) the Sidekiq process can use 1GB+ of memory.
165

166 167
## Prometheus and its exporters

168 169 170 171
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.
172

173 174
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).
175

176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
## 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.

194
[security reasons]: https://gitlab.com/gitlab-org/gitlab-runner/blob/master/docs/security/index.md
195

196
## Supported web browsers
197

198
We support the current and the previous major release of Firefox, Chrome/Chromium, Safari and Microsoft browsers (Microsoft Edge and Internet Explorer 11).
199

200
Each time a new browser version is released, we begin supporting that version and stop supporting the third most recent version.
201 202 203

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.