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

## Operating Systems
4

5
GitLab is developed for the Linux operating system. For the installations options and instructions please see [the installation section of the readme](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/README.md#installation).
6

7
### Supported Linux distributions
randx's avatar
randx committed
8

9 10
- Ubuntu
- Debian
11
- CentOS
12 13
- RedHat Enterprise Linux
- Scientific Linux
14 15
- Oracle Linux

16
### Unsupported Linux distributions
17 18

- Arch Linux
randx's avatar
randx committed
19
- Fedora
20
- Gentoo
randx's avatar
randx committed
21

22
But on the above unsupported distributions is still possible to install GitLab yourself with the [manual installation guide](https://github.com/gitlabhq/gitlabhq/blob/master/doc/install/installation.md).
23

24
### Unsupported Unix operating systems
25

26
There is nothing that prevents GitLab from running on other Unix operating systems.
27

28
This means you may get it to work on systems running FreeBSD or OS X.
29

30
If you want to do this, please be aware it could be a lot of work.
31

32
Please consider using a virtual machine to run GitLab.
33

34
### Other operating systems such as Windows
35

36
GitLab does **not** run on Windows and we have no plans of supporting it in the near future.
37

38
Please consider using a virtual machine to run GitLab.
39

40
## Ruby versions
randx's avatar
randx committed
41

42
GitLab requires Ruby (MRI) 2.0+.
43 44

>>>>>>> Update docs to markdown style guide.
dosire's avatar
dosire committed
45
You will have to use the standard MRI implementation of Ruby.
randx's avatar
randx committed
46

47
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
48

49
## Hardware requirements
50

51
### CPU
52

dosire's avatar
dosire committed
53 54 55 56
- 1 core works supports up to 100 users but the application will not be responsive
- **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
57 58 59
- 16 cores supports up to 10,000 users
- 32 cores supports up to 20,000 users
- 64 cores supports up to 40,000 users
60

61
### Memory
62

秋纫's avatar
秋纫 committed
63
- 512MB is the absolute minimum, you need 256MB of swap, you can configure only one slow unicorn worker, only ssh access will work, we do not recommend this
64
- 1GB supports up to 100 users (with individual repositories under 250MB, otherwise git memory usage necessitates using swap space)
dosire's avatar
dosire committed
65 66 67 68 69 70
- **2GB** is the **recommended** memory size and supports up to 500 users
- 4GB supports up to 2,000 users
- 8GB supports up to 5,000 users
- 16GB supports up to 10,000 users
- 32GB supports up to 20,000 users
- 64GB supports up to 40,000 users
71

72
### Storage
73

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

76 77 78
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.
79

80
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
81

82 83 84
## Database

If you want to run the database separately, the **recommended** database size is **1 MB per user**
85

86
## Supported webbrowsers
87 88 89

- Chrome (Latest stable version)
- Firefox (Latest released version) 
Pascal Herbert's avatar
Pascal Herbert committed
90
- Safari 7+ (known problem: required fields in html5 do not work)
91
- Opera (Latest released version)
秋纫's avatar
秋纫 committed
92
- IE 10+