requirements.md 12,5 КБ
Newer Older
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
1
2
3
4
---
type: reference
---

Marin Jankovski's avatar
Marin Jankovski включено в состав коммита
5
6
# Requirements

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
7
8
9
This page includes useful information on the supported Operating Systems as well
as the hardware requirements that are needed to install and use GitLab.

Marin Jankovski's avatar
Marin Jankovski включено в состав коммита
10
## Operating Systems
Riyad Preukschas's avatar
Riyad Preukschas включено в состав коммита
11

Russell Dickenson's avatar
Russell Dickenson включено в состав коммита
12
### Supported Linux distributions
randx's avatar
randx включено в состав коммита
13

dosire's avatar
dosire включено в состав коммита
14
15
- Ubuntu
- Debian
Riyad Preukschas's avatar
Riyad Preukschas включено в состав коммита
16
- CentOS
Balasankar C's avatar
Balasankar C включено в состав коммита
17
- openSUSE
Ewan Edwards's avatar
Ewan Edwards включено в состав коммита
18
- Red Hat Enterprise Linux (please use the CentOS packages and instructions)
Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
19
20
- Scientific Linux (please use the CentOS packages and instructions)
- Oracle Linux (please use the CentOS packages and instructions)
Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
21

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
22
For the installations options, see [the main installation page](README.md).
Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
23

Russell Dickenson's avatar
Russell Dickenson включено в состав коммита
24
### Unsupported Linux distributions and Unix-like operating systems
Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
25
26

- Arch Linux
randx's avatar
randx включено в состав коммита
27
- Fedora
Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
28
- FreeBSD
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
29
30
- Gentoo
- macOS
randx's avatar
randx включено в состав коммита
31

Russell Dickenson's avatar
Russell Dickenson включено в состав коммита
32
Installation of GitLab on these operating systems is possible, but not supported.
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
33
Please see the [installation from source guide](installation.md) and the [installation guides](https://about.gitlab.com/install/) for more information.
Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
34

Russell Dickenson's avatar
Russell Dickenson включено в состав коммита
35
### Microsoft Windows
Riyad Preukschas's avatar
Riyad Preukschas включено в состав коммита
36

Russell Dickenson's avatar
Russell Dickenson включено в состав коммита
37
GitLab is developed for Linux-based operating systems.
GitLab Bot's avatar
GitLab Bot включено в состав коммита
38
It does **not** run on Microsoft 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/issues/22337).
Ciro Santilli's avatar
Ciro Santilli включено в состав коммита
39
Please consider using a virtual machine to run GitLab.
Riyad Preukschas's avatar
Riyad Preukschas включено в состав коммита
40

GitLab Bot's avatar
GitLab Bot включено в состав коммита
41
## Software requirements
randx's avatar
randx включено в состав коммита
42

GitLab Bot's avatar
GitLab Bot включено в состав коммита
43
### Ruby versions
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
44

GitLab Bot's avatar
GitLab Bot включено в состав коммита
45
46
47
48
GitLab requires Ruby (MRI) 2.6. Beginning in GitLab 12.2, we  no longer support Ruby 2.5 and lower.

You must use the standard MRI implementation of Ruby.
We love [JRuby](https://www.jruby.org/) and [Rubinius](https://rubinius.com), but GitLab
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
49
needs several Gems that have native extensions.
randx's avatar
randx включено в состав коммита
50

GitLab Bot's avatar
GitLab Bot включено в состав коммита
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
### Go versions

The minimum required Go version is 1.12.

### Git versions

GitLab 11.11 and higher only supports Git 2.21.x and newer, and
[dropped support for older versions](https://gitlab.com/gitlab-org/gitlab-foss/issues/54255).

### Node.js versions

Beginning in GitLab 11.8, we only support Node.js 8.10.0 or higher, and dropped
support for Node.js 6.

We recommend Node 12.x, as it is faster.

GitLab uses [webpack](https://webpack.js.org/) to compile frontend assets, which requires a minimum
version of Node.js 8.10.0.

You can check which version you are running with `node -v`. If you are running
a version older than `v8.10.0`, you need to update to a newer version. You
can find instructions to install from community maintained packages or compile
from source at the [Node.js website](https://nodejs.org/en/download).

Ciro Santilli's avatar
Ciro Santilli включено в состав коммита
75
## Hardware requirements
Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
76

Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
77
78
### Storage

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
79
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.
Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
80
81
82
83
84
85
86

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.

Eric Johnson's avatar
Eric Johnson включено в состав коммита
87
88
NOTE: **Note:** Since file system performance may affect GitLab's overall performance, we do not recommend using EFS for storage. See the [relevant documentation](../administration/high_availability/nfs.md#avoid-using-awss-elastic-file-system-efs) for more details.

Ciro Santilli's avatar
Ciro Santilli включено в состав коммита
89
### CPU
Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
90

Cody West's avatar
Cody West включено в состав коммита
91
92
This is the recommended minimum hardware for a handful of example GitLab user base sizes. Your exact needs may be more, depending on your workload. Your workload is influenced by factors such as - but not limited to - how active your users are, how much automation you use, mirroring, and repo/change size.

Ian Lee's avatar
Ian Lee включено в состав коммита
93
- 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
Ben Kochie's avatar
Ben Kochie включено в состав коммита
94
95
96
97
- **2 cores** is the **recommended** minimum number of cores and supports up to 100 users
- 4 cores supports up to 500 users
- 8 cores supports up to 1,000 users
- 32 cores supports up to 5,000 users
GitLab Bot's avatar
GitLab Bot включено в состав коммита
98
- More users? Run it high-availability on [multiple application servers](https://about.gitlab.com/solutions/high-availability/)
Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
99

Ciro Santilli's avatar
Ciro Santilli включено в состав коммита
100
### Memory
Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
101

Cody West's avatar
Cody West включено в состав коммита
102
103
This is the recommended minimum hardware for a handful of example GitLab user base sizes. Your exact needs may be more, depending on your workload. Your workload is influenced by factors such as - but not limited to - how active your users are, how much automation you use, mirroring, and repo/change size.

Lee Matos's avatar
Lee Matos включено в состав коммита
104
You need at least 8GB of addressable memory (RAM + swap) to install and use GitLab!
DJ Mountney's avatar
DJ Mountney включено в состав коммита
105
The operating system and any other running applications will also be using memory
Ahmad Sherif's avatar
Ahmad Sherif включено в состав коммита
106
so keep in mind that you need at least 4GB available before running GitLab. With
DJ Mountney's avatar
DJ Mountney включено в состав коммита
107
108
less memory GitLab will give strange errors during the reconfigure run and 500
errors during usage.
Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
109

Lee Matos's avatar
Lee Matos включено в состав коммита
110
- 4GB RAM + 4GB swap supports up to 100 users but it will be very slow
Ben Kochie's avatar
Ben Kochie включено в состав коммита
111
112
113
114
- **8GB RAM** is the **recommended** minimum memory size for all installations and supports up to 100 users
- 16GB RAM supports up to 500 users
- 32GB RAM supports up to 1,000 users
- 128GB RAM supports up to 5,000 users
GitLab Bot's avatar
GitLab Bot включено в состав коммита
115
- More users? Run it high-availability on [multiple application servers](https://about.gitlab.com/solutions/high-availability/)
Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
116

Ben Bodenmiller's avatar
Ben Bodenmiller включено в состав коммита
117
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 включено в состав коммита
118
enough available RAM. Having swap will help reduce the chance of errors occurring
René Genz's avatar
René Genz включено в состав коммита
119
if your available memory changes. We also recommend [configuring the kernel's swappiness setting](https://askubuntu.com/a/103916)
DJ Mountney's avatar
DJ Mountney включено в состав коммита
120
to a low value like `10` to make the most of your RAM while still having the swap
Emilie Schario's avatar
Emilie Schario включено в состав коммита
121
122
123
available when needed.

Our [Memory Team](https://about.gitlab.com/handbook/engineering/development/enablement/memory/) is actively working to reduce the memory requirement.
DJ Mountney's avatar
DJ Mountney включено в состав коммита
124

Ben Bodenmiller's avatar
Ben Bodenmiller включено в состав коммита
125
NOTE: **Note:** 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.
Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
126

Marc Radulescu's avatar
Marc Radulescu включено в состав коммита
127
128
## Database

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
129
130
131
132
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).

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
133
134
We currently support the following databases:

Nick Thomas's avatar
Nick Thomas включено в состав коммита
135
136
137
138
- PostgreSQL

Support for MySQL was removed in GitLab 12.1. Existing users using GitLab with
MySQL/MariaDB are advised to [migrate to PostgreSQL](../update/mysql_to_postgresql.md) before upgrading.
Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
139

Yorick Peterse's avatar
Yorick Peterse включено в состав коммита
140
141
### PostgreSQL Requirements

Nick Thomas's avatar
Nick Thomas включено в состав коммита
142
As of GitLab 10.0, PostgreSQL 9.6 or newer is required, and earlier versions are
Ben Bodenmiller's avatar
Ben Bodenmiller включено в состав коммита
143
not supported. We highly recommend users to use PostgreSQL 9.6 as this
Yorick Peterse's avatar
Yorick Peterse включено в состав коммита
144
is the PostgreSQL version used for development and testing.
Ben Bodenmiller's avatar
Ben Bodenmiller включено в состав коммита
145

Yorick Peterse's avatar
Yorick Peterse включено в состав коммита
146
147
148
149
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:

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
150
151
152
```
CREATE EXTENSION pg_trgm;
```
Yorick Peterse's avatar
Yorick Peterse включено в состав коммита
153
154
155
156

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

GitLab Bot's avatar
GitLab Bot включено в состав коммита
157
158
NOTE: **Note:** Support for PostgreSQL 9.6 and 10 will be removed in GitLab 13.0 so that GitLab can benefit from PostgreSQL 11 improvements, such as partitioning. For the schedule on adding support for PostgreSQL 11 and 12, see [the related epic](https://gitlab.com/groups/gitlab-org/-/epics/2184). For the release schedule for GitLab 13.0, see [GitLab's release and maintenance policy](../policy/maintenance.md).

Joshua Lambert's avatar
Joshua Lambert включено в состав коммита
159
160
#### Additional requirements for GitLab Geo

Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
161
If you are using [GitLab Geo](../development/geo.md):
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
162
163
164
165
166
167

- We strongly recommend running Omnibus-managed instances as they are actively
  developed and tested. We aim to be compatible with most external (not managed
  by Omnibus) databases (for example, AWS RDS) but we do not guarantee
  compatibility.
- The
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
168
  [tracking database](../development/geo.md#using-the-tracking-database)
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
169
  requires the
GitLab Bot's avatar
GitLab Bot включено в состав коммита
170
  [postgres_fdw](https://www.postgresql.org/docs/9.6/postgres-fdw.html)
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
171
  extension.
Joshua Lambert's avatar
Joshua Lambert включено в состав коммита
172
173
174
175
176

```
CREATE EXTENSION postgres_fdw;
```

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
177
178
## Unicorn Workers

GitLab Bot's avatar
GitLab Bot включено в состав коммита
179
180
For most instances we recommend using: (CPU cores * 1.5) + 1 = Unicorn workers.
For example a node with 4 cores would have 7 Unicorn workers.
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
181

GitLab Bot's avatar
GitLab Bot включено в состав коммита
182
For all machines that have 2GB and up we recommend a minimum of three Unicorn workers.
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
183
184
If you have a 1GB machine we recommend to configure only two Unicorn workers to prevent excessive swapping.

GitLab Bot's avatar
GitLab Bot включено в состав коммита
185
As long as you have enough available CPU and memory capacity, it's okay to increase the number of Unicorn workers and this will usually help to reduce the response time of the applications and increase the ability to handle parallel requests.
Ben Bodenmiller's avatar
Ben Bodenmiller включено в состав коммита
186

Ben Bodenmiller's avatar
Ben Bodenmiller включено в состав коммита
187
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://docs.gitlab.com/omnibus/settings/unicorn.html).
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
188

Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
189
190
191
## Redis and Sidekiq

Redis stores all user sessions and the background task queue.
Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
192
The storage requirements for Redis are minimal, about 25kB per user.
Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
193
194
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 включено в состав коммита
195
On a very active server (10,000 active users) the Sidekiq process can use 1GB+ of memory.
Jeroen van Baarsen's avatar
Jeroen van Baarsen включено в состав коммита
196

197
198
## Prometheus and its exporters

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
199
200
201
202
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.
203

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
204
205
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).
206

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
207
208
209
210
211
212
213
214
215
216
217
218
## 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
Andrew Winata's avatar
Andrew Winata включено в состав коммита
219
[security reasons](https://docs.gitlab.com/runner/security/), especially when you plan to use shell executor with GitLab
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
220
221
222
223
Runner.

We recommend using a separate machine for each GitLab Runner, if you plan to
use the CI features.
Andrew Winata's avatar
Andrew Winata включено в состав коммита
224
225
226
227
228
229
230
231
232
233
234
235
The GitLab Runner server requirements depend on:

- The type of [executor](https://docs.gitlab.com/runner/executors/) you configured on GitLab Runner.
- Resources required to run build jobs.
- Job concurrency settings.

Since the nature of the jobs varies for each use case, you will need to experiment by adjusting the job concurrency to get the optimum setting.

For reference, GitLab.com's [auto-scaling shared runner](../user/gitlab_com/index.md#shared-runners) is configured so that a **single job** will run in a **single instance** with:

- 1vCPU.
- 3.75GB of RAM.
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
236

Ben Bodenmiller's avatar
Ben Bodenmiller включено в состав коммита
237
## Supported web browsers
Jeroen van Baarsen's avatar
Jeroen van Baarsen включено в состав коммита
238

GitLab Bot's avatar
GitLab Bot включено в состав коммита
239
GitLab supports the following web browsers:
Luke Bennett's avatar
Luke Bennett включено в состав коммита
240
241
242
243
244
245

- Firefox
- Chrome/Chromium
- Safari
- Microsoft Edge
- Internet Explorer 11
Luke "Jared" Bennett's avatar
Luke "Jared" Bennett включено в состав коммита
246

GitLab Bot's avatar
GitLab Bot включено в состав коммита
247
For the listed web browsers, GitLab supports:
Tom Atkins's avatar
Tom Atkins включено в состав коммита
248

GitLab Bot's avatar
GitLab Bot включено в состав коммита
249
250
251
- The current and previous major versions of browsers except Internet Explorer.
- Only version 11 of Internet Explorer.
- The current minor version of a supported major version.
Clement Ho's avatar
Clement Ho включено в состав коммита
252

Ben Bodenmiller's avatar
Ben Bodenmiller включено в состав коммита
253
NOTE: **Note:** We do not support running GitLab with JavaScript disabled in the browser and have no plans of supporting that
Clement Ho's avatar
Clement Ho включено в состав коммита
254
in the future because we have features such as Issue Boards which require JavaScript extensively.
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
255
256
257
258
259
260
261
262
263
264
265
266

<!-- ## Troubleshooting

Include any troubleshooting steps that you can foresee. If you know beforehand what issues
one might have when setting this up, or when something is changed, or on upgrading, it's
important to describe those, too. Think of things that may go wrong and include them here.
This is important to minimize requests for support, and to avoid doc comments with
questions that you know someone might ask.

Each scenario can be a third-level heading, e.g. `### Getting error message X`.
If you have none to add when creating a doc, leave this section in place
but commented out to help encourage others to add to it in the future. -->