Commit 198e93ccf2b880d9dba52240dc8759b930b4ebf3
1 parent
7591718e
Exists in
master
and in
4 other branches
Update hardware and platform requirements guide
Showing
2 changed files
with
43 additions
and
14 deletions
Show diff stats
doc/install/installation.md
1 | -_This installation guide created for Debian/Ubuntu and properly tested._ | |
1 | +This installation guide was created for Debian/Ubuntu and tested on it. | |
2 | + | |
3 | +Please read doc/install/requirements.md for hardware andplatform requirements. | |
2 | 4 | |
3 | -_Checkout requirements before setup_ | |
4 | 5 | |
5 | 6 | |
6 | 7 | ### IMPORTANT | ... | ... |
doc/install/requirements.md
1 | -## Platform requirements: | |
1 | +# Hardware | |
2 | 2 | |
3 | -**The project is designed for the Linux operating system.** | |
3 | +We recommend you to run GitLab on a server with at least 1GB RAM. | |
4 | 4 | |
5 | -It may work on FreeBSD and Mac OS, but we don't test our application for these systems and can't guarantee stability and full functionality. | |
5 | +The necessary hard disk space largely depends on the size of the repos you want | |
6 | +to use GitLab with. But as a *rule of thumb* you should have at least as much | |
7 | +free space as your all repos combined take up. | |
6 | 8 | |
7 | -We officially support (recent versions of) these Linux distributions: | |
9 | + | |
10 | + | |
11 | +# Operating Systems | |
12 | + | |
13 | +## Linux | |
14 | + | |
15 | +GitLab is developed for the Linux operating system. | |
16 | + | |
17 | +GitLab officially supports (recent versions of) these Linux distributions: | |
8 | 18 | |
9 | 19 | - Ubuntu Linux |
10 | 20 | - Debian/GNU Linux |
11 | 21 | |
12 | -It should work on: | |
22 | +It should also work on (though they are not officially supported): | |
13 | 23 | |
24 | +- Arch | |
25 | +- CentOS | |
14 | 26 | - Fedora |
15 | -- CentOs | |
27 | +- Gentoo | |
16 | 28 | - RedHat |
17 | 29 | |
18 | -You might have some luck using these, but no guarantees: | |
30 | +## Other Unix Systems | |
31 | + | |
32 | +There is nothing that prevents GitLab from running on other Unix operating | |
33 | +systems. This means you may get it to work on systems running FreeBSD or OS X. | |
34 | +**If you want to try, please proceed with caution!** | |
35 | + | |
36 | +## Windows | |
37 | + | |
38 | +GitLab does **not** run on Windows and we have no plans of supporting it in the | |
39 | +near future. | |
40 | + | |
41 | + | |
42 | + | |
43 | +# Rubies | |
19 | 44 | |
20 | -- FreeBSD will likely work, see https://github.com/gitlabhq/gitlabhq/issues/796 | |
21 | -- MacOS X will likely work, see https://groups.google.com/forum/#!topic/gitlabhq/5IXHbPkjKLA | |
45 | +GitLab requires Ruby (MRI) 1.9.3 and several Gems with native components. | |
46 | +While it is generally possible to use other Rubies (like | |
47 | +[JRuby](http://jruby.org/) or [Rubinius](http://rubini.us/)) it might require | |
48 | +some work on your part. | |
22 | 49 | |
23 | -GitLab does **not** run on Windows and we have no plans of making GitLab compatible. | |
24 | 50 | |
25 | 51 | |
26 | -## Hardware: | |
52 | +# Installation troubles and reporting success or failure | |
27 | 53 | |
28 | -We recommend to use server with at least 1GB RAM for gitlab instance. | |
54 | +If you have troubles installing GitLab following the official installation guide | |
55 | +or want to share your experience installing GitLab on a not officially supported | |
56 | +platform, please follow the the contribution guide (see CONTRIBUTING.md). | ... | ... |