requirements.md 4.66 KB
Newer Older
Marin Jankovski's avatar
Marin Jankovski committed
1 2 3
# Requirements

## Operating Systems
4

5
### Supported Unix distributions
randx's avatar
randx committed
6

7 8
- Ubuntu
- Debian
9
- CentOS
10 11 12
- RedHat 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)
13

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

16
### Unsupported Unix distributions
17

18
- OS X
19
- Arch Linux
randx's avatar
randx committed
20
- Fedora
21
- Gentoo
22
- FreeBSD
randx's avatar
randx committed
23

24 25
On the above unsupported distributions is still possible to install GitLab yourself.
Please see the [manual installation guide](https://github.com/gitlabhq/gitlabhq/blob/master/doc/install/installation.md) and the [unofficial installation guides](https://github.com/gitlabhq/gitlab-public-wiki/wiki/Unofficial-Installation-Guides) on the public wiki for more information.
26

27
### Non Unix operating systems such as Windows
28

29
GitLab is developed for Unix operating systems.
30
GitLab does **not** run on Windows and we have no plans of supporting it in the near future.
31
Please consider using a virtual machine to run GitLab.
32

33
## Ruby versions
randx's avatar
randx committed
34

35
GitLab requires Ruby (MRI) 2.0 or 2.1
dosire's avatar
dosire committed
36
You will have to use the standard MRI implementation of Ruby.
Tobias Pfeiffer's avatar
Tobias Pfeiffer committed
37
We love [JRuby](http://jruby.org/) and [Rubinius](http://rubini.us/) but GitLab needs several Gems that have native extensions.
randx's avatar
randx committed
38

39
## Hardware requirements
40

41
### CPU
42

Sytse Sijbrandij's avatar
Sytse Sijbrandij committed
43
- 1 core works 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 committed
44 45 46
- **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
47 48 49
- 16 cores supports up to 10,000 users
- 32 cores supports up to 20,000 users
- 64 cores supports up to 40,000 users
50

51
### Memory
52

53
- 512MB is the absolute minimum but we do not recommend this amount of memory.
54 55 56 57
You will either need to configure 512MB or 1.5GB of swap space.
With 512MB of swap space you must configure only one unicorn worker.
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 use SSD storage and configure 1.5GB of swap space you can use two Unicorn workers, this will allow http access but it will still be slow.
58 59 60 61 62 63 64
- 1GB RAM + 1GB swap supports up to 100 users
- **2GB RAM** is the **recommended** memory size and supports up to 500 users
- 4GB RAM supports up to 2,000 users
- 8GB RAM supports up to 5,000 users
- 16GB RAM supports up to 10,000 users
- 32GB RAM supports up to 20,000 users
- 64GB RAM supports up to 40,000 users
65

66 67
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.

68
### Storage
69

70
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 twice as much free space as your all repos combined take up. You need twice the storage because [GitLab satellites](structure.md) contain an extra copy of each repo.
71

72 73 74
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.
75

76
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.
randx's avatar
randx committed
77

78 79
## Database

80 81 82 83 84
If you want to run the database separately, the **recommended** database size is **1 MB per user**.

## Redis and Sidekiq

Redis stores all user sessions and the background task queue.
Sytse Sijbrandij's avatar
Sytse Sijbrandij committed
85
The storage requirements for Redis are minimal, about 25kB per user.
86 87
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
88
On a very active server (10,000 active users) the Sidekiq process can use 1GB+ of memory.
89

90
## Supported web browsers
91 92

- Chrome (Latest stable version)
93
- Firefox (Latest released version and [latest ESR version](https://www.mozilla.org/en-US/firefox/organizations/)) 
Pascal Herbert's avatar
Pascal Herbert committed
94
- Safari 7+ (known problem: required fields in html5 do not work)
95
- Opera (Latest released version)
秋纫's avatar
秋纫 committed
96
- IE 10+