requirements.md 7,5 КБ
Newer Older
Marin Jankovski's avatar
Marin Jankovski включено в состав коммита
1
2
3
# Requirements

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

Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
5
### Supported Unix distributions
randx's avatar
randx включено в состав коммита
6

dosire's avatar
dosire включено в состав коммита
7
8
- Ubuntu
- Debian
Riyad Preukschas's avatar
Riyad Preukschas включено в состав коммита
9
- CentOS
Ewan Edwards's avatar
Ewan Edwards включено в состав коммита
10
- Red Hat Enterprise Linux (please use the CentOS packages and instructions)
Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
11
12
- Scientific Linux (please use the CentOS packages and instructions)
- Oracle Linux (please use the CentOS packages and instructions)
Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
13

Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
14
15
For the installations options please see [the installation page on the GitLab website](https://about.gitlab.com/installation/).

Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
16
### Unsupported Unix distributions
Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
17

Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
18
- OS X
Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
19
- Arch Linux
randx's avatar
randx включено в состав коммита
20
- Fedora
Riyad Preukschas's avatar
Riyad Preukschas включено в состав коммита
21
- Gentoo
Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
22
- FreeBSD
randx's avatar
randx включено в состав коммита
23

Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
24
On the above unsupported distributions is still possible to install GitLab yourself.
Chris Wilson's avatar
Chris Wilson включено в состав коммита
25
Please see the [installation from source guide](installation.md) and the [installation guides](https://about.gitlab.com/installation/) for more information.
Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
26

Ben Bodenmiller's avatar
Ben Bodenmiller включено в состав коммита
27
### Non-Unix operating systems such as Windows
Riyad Preukschas's avatar
Riyad Preukschas включено в состав коммита
28

Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
29
GitLab is developed for Unix operating systems.
Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
30
GitLab does **not** run on Windows and we have no plans of supporting it in the near future.
Ciro Santilli's avatar
Ciro Santilli включено в состав коммита
31
Please consider using a virtual machine to run GitLab.
Riyad Preukschas's avatar
Riyad Preukschas включено в состав коммита
32

Ciro Santilli's avatar
Ciro Santilli включено в состав коммита
33
## Ruby versions
randx's avatar
randx включено в состав коммита
34

James Lopez's avatar
James Lopez включено в состав коммита
35
GitLab requires Ruby (MRI) 2.1.x and currently does not work with versions 2.2 or 2.3.
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
36

dosire's avatar
dosire включено в состав коммита
37
You will have to use the standard MRI implementation of Ruby.
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
38
39
We love [JRuby](http://jruby.org/) and [Rubinius](http://rubini.us/) but GitLab
needs several Gems that have native extensions.
randx's avatar
randx включено в состав коммита
40

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

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

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
45
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 включено в состав коммита
46
47
48
49
50
51
52

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.

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

Ian Lee's avatar
Ian Lee включено в состав коммита
55
- 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
dosire's avatar
dosire включено в состав коммита
56
57
58
- **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
William Karavites's avatar
William Karavites включено в состав коммита
59
60
61
- 16 cores supports up to 10,000 users
- 32 cores supports up to 20,000 users
- 64 cores supports up to 40,000 users
Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
62
- More users? Run it on [multiple application servers](https://about.gitlab.com/high-availability/)
Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
63

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

Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
66
You need at least 2GB of addressable memory (RAM + swap) to install and use GitLab!
DJ Mountney's avatar
DJ Mountney включено в состав коммита
67
68
69
70
The operating system and any other running applications will also be using memory
so keep in mind that you need at least 2GB available before running GitLab. With
less memory GitLab will give strange errors during the reconfigure run and 500
errors during usage.
Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
71

Paul Johnson's avatar
Paul Johnson включено в состав коммита
72
- 512MB RAM + 1.5GB of swap is the absolute minimum but we strongly **advise against** this amount of memory. See the unicorn worker section below for more advice.
Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
73
74
- 1GB RAM + 1GB swap supports up to 100 users but it will be very slow
- **2GB RAM** is the **recommended** memory size for all installations and supports up to 100 users
Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
75
76
77
78
79
80
- 4GB RAM supports up to 1,000 users
- 8GB RAM supports up to 2,000 users
- 16GB RAM supports up to 4,000 users
- 32GB RAM supports up to 8,000 users
- 64GB RAM supports up to 16,000 users
- 128GB RAM supports up to 32,000 users
Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
81
- More users? Run it on [multiple application servers](https://about.gitlab.com/high-availability/)
Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
82

DJ Mountney's avatar
DJ Mountney включено в состав коммита
83
We recommend having at least 1GB of swap on your server, even if you currently have
Chris Spicer's avatar
Chris Spicer включено в состав коммита
84
enough available RAM. Having swap will help reduce the chance of errors occurring
DJ Mountney's avatar
DJ Mountney включено в состав коммита
85
86
if your available memory changes.

Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
87
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 many you need of those.
Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
88

Grzegorz Bizon's avatar
Grzegorz Bizon включено в состав коммита
89
90
## Gitlab Runner

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
91
92
93
94
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.
Grzegorz Bizon's avatar
Grzegorz Bizon включено в состав коммита
95

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
96
97
98
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.
Grzegorz Bizon's avatar
Grzegorz Bizon включено в состав коммита
99

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
100
101
102
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.
Grzegorz Bizon's avatar
Grzegorz Bizon включено в состав коммита
103

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
104
105
106
107
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-ci-multi-runner/blob/master/docs/security/index.md
Grzegorz Bizon's avatar
Grzegorz Bizon включено в состав коммита
108

Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
109
## Unicorn Workers
Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
110

Phil Hughes's avatar
Phil Hughes включено в состав коммита
111
It's possible to increase the amount of unicorn workers and this will usually help for to reduce the response time of the applications and increase the ability to handle parallel requests.
Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
112

Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
113
114
For most instances we recommend using: CPU cores + 1 = unicorn workers.
So for a machine with 2 cores, 3 unicorn workers is ideal.
Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
115

Marin Jankovski's avatar
Marin Jankovski включено в состав коммита
116
For all machines that have 1GB and up we recommend a minimum of three unicorn workers.
Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
117
118
119
If you have a 512MB machine with a magnetic (non-SSD) swap drive we recommend to configure only one Unicorn worker to prevent excessive swapping.
With one Unicorn worker only git over ssh access will work because the git over HTTP access requires two running workers (one worker to receive the user request and one worker for the authorization check).
If you have a 512MB machine with a SSD drive you can use two Unicorn workers, this will allow HTTP access although it will be slow due to swapping.
randx's avatar
randx включено в состав коммита
120

Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
121
122
To change the Unicorn workers when you have the Omnibus package 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).

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

Sytse Sijbrandij (admin)'s avatar
Sytse Sijbrandij (admin) включено в состав коммита
125
If you want to run the database separately expect a size of about 1 MB per user.
Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
126

Yorick Peterse's avatar
Yorick Peterse включено в состав коммита
127
128
129
130
131
132
133
134
135
136
137
### PostgreSQL Requirements

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.

Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
138
139
140
## Redis and Sidekiq

Redis stores all user sessions and the background task queue.
Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
141
The storage requirements for Redis are minimal, about 25kB per user.
Sytse Sijbrandij's avatar
Sytse Sijbrandij включено в состав коммита
142
143
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 включено в состав коммита
144
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 включено в состав коммита
145

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

- Chrome (Latest stable version)
Job van der Voort's avatar
Job van der Voort включено в состав коммита
149
- Firefox (Latest released version and [latest ESR version](https://www.mozilla.org/en-US/firefox/organizations/))
Pascal Herbert's avatar
Pascal Herbert включено в состав коммита
150
- Safari 7+ (known problem: required fields in html5 do not work)
Jeroen van Baarsen's avatar
Jeroen van Baarsen включено в состав коммита
151
- Opera (Latest released version)
Jacob Schatz's avatar
Jacob Schatz включено в состав коммита
152
- Internet Explorer (IE) 11+ but please make sure that you have the `Compatibility View` mode disabled.
Connor Shea's avatar
Connor Shea включено в состав коммита
153
- Edge (Latest stable version)