OSDN Git Service

Include gitlab-shell in patch update doc
[wvm/gitlab.git] / doc / install / requirements.md
1 # Operating Systems
2
3 ## Linux
4
5 GitLab is developed for the Linux operating system.
6
7 GitLab officially supports (recent versions of) these Linux distributions:
8
9 - Ubuntu Linux
10 - Debian/GNU Linux
11
12 It should also work on (though they are not officially supported):
13
14 - Arch
15 - CentOS
16 - Fedora
17 - Gentoo
18 - RedHat
19
20 ## Other Unix Systems
21
22 There is nothing that prevents GitLab from running on other Unix operating
23 systems. This means you may get it to work on systems running FreeBSD or OS X.
24 **If you want to try, please proceed with caution!**
25
26 ## Windows
27
28 GitLab does **not** run on Windows and we have no plans of supporting it in the
29 near future. Please consider using a virtual machine to run GitLab.
30
31
32 # Rubies
33
34 GitLab requires Ruby (MRI) 1.9.3 and several Gems with native components.
35 While it is generally possible to use other Rubies (like
36 [JRuby](http://jruby.org/) or [Rubinius](http://rubini.us/)) it might require
37 some work on your part.
38
39
40 # Hardware requirements
41
42 ## CPU
43
44 - 1 core works for under 100 users but the responsiveness might suffer
45 - **2 cores** is the **recommended** number of cores and supports up to 100 users
46 - 4 cores supports about 1,000 users
47 - 8 cores supports up to 10,000 users
48
49 ## Memory
50
51 - 512MB is too little memory, GitLab will be very slow and you will need 250MB of swap
52 - 768MB is the minimal memory size but we advise against this
53 - 1GB supports up to 100 users if you do not have individual repo's over 250MB
54 - **2GB** is the **recommended** memory size and supports up to 1,000 users
55 - 4GB supports up to 10,000 users
56
57 ## Storage
58
59 The necessary hard drive space largely depends on the size of the repos you want
60 to store in GitLab. But as a *rule of thumb* you should have at least twice as much
61 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.
62
63 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.
64
65 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.
66
67 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.
68
69 # Installation troubles and reporting success or failure
70
71 If you have troubles installing GitLab following the [official installation guide](installation.md)
72 or want to share your experience installing GitLab on a not officially supported
73 platform, please follow the the [contribution guide](/CONTRIBUTING.md).