Download as
Browse Code »

Commit dfc5adfc23cba5aebcd9da60c857c1cf51a1c7da

Authored by Dmitriy Zaporozhets
2 parents 12b4bb59 d8a239e4
Exists in master and in 4 other branches 6-8-stable, 7-0-stable, 7-0-stable-spb, spb-stable

Merge pull request #2188 from riyad/update-installation-docs 

Update installation docs
Showing 4 changed files with 227 additions and 211 deletions   Show diff stats
config/database.yml.example
View file @12b4bb5
... ... @@ -1,39 +0,0 @@
1   -#
2   -# PRODUCTION
3   -#
4   -production:
5   - adapter: mysql2
6   - encoding: utf8
7   - reconnect: false
8   - database: gitlabhq_production
9   - pool: 5
10   - username: root
11   - password: "secure password"
12   - # host: localhost
13   - # socket: /tmp/mysql.sock
14   -
15   -#
16   -# Development specific
17   -#
18   -development:
19   - adapter: mysql2
20   - encoding: utf8
21   - reconnect: false
22   - database: gitlabhq_development
23   - pool: 5
24   - username: root
25   - password: "secure password"
26   - # socket: /tmp/mysql.sock
27   -
28   -# Warning: The database defined as "test" will be erased and
29   -# re-generated from your development database when you run "rake".
30   -# Do not set this db to the same as development or production.
31   -test: &test
32   - adapter: mysql2
33   - encoding: utf8
34   - reconnect: false
35   - database: gitlabhq_test
36   - pool: 5
37   - username: root
38   - password: "secure password"
39   - # socket: /tmp/mysql.sock
doc/install/databases.md
  Diff comments   View file @dfc5adf
1   -# Databases:
  1 +# Setup Database
2 2  
3   -GitLab use MySQL as default database but you are free to use PostgreSQL.
  3 +GitLab supports the following databases:
  4 +
  5 +* MySQL (preferred)
  6 +* PostgreSQL
4 7  
5 8  
6 9 ## MySQL
7 10  
  11 + # Install the database packages
8 12 sudo apt-get install -y mysql-server mysql-client libmysqlclient-dev
9 13  
  14 + # Install only the necessary gems
  15 + sudo -u gitlab -H bundle install --deployment --without development test postgres
  16 +
10 17 # Login to MySQL
11 18 $ mysql -u root -p
12 19  
  20 + # Create a user for GitLab. (change $password to a real password)
  21 + mysql> CREATE USER 'gitlab'@'localhost' IDENTIFIED BY '$password';
  22 +
13 23 # Create the GitLab production database
14 24 mysql> CREATE DATABASE IF NOT EXISTS `gitlabhq_production` DEFAULT CHARACTER SET `utf8` COLLATE `utf8_unicode_ci`;
15 25  
16   - # Create the MySQL User change $password to a real password
17   - mysql> CREATE USER 'gitlab'@'localhost' IDENTIFIED BY '$password';
18   -
19   - # Grant proper permissions to the MySQL User
  26 + # Grant the GitLab user necessary permissopns on the table.
20 27 mysql> GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, INDEX, ALTER ON `gitlabhq_production`.* TO 'gitlab'@'localhost';
21 28  
  29 + # Quit the database session
  30 + mysql> \q
  31 +
  32 + # Try connecting to the new database with the new user
  33 + sudo -u gitlab -H mysql -u gitlab -p -D gitlabhq_production
22 34  
23 35 ## PostgreSQL
24 36  
25   - sudo apt-get install -y postgresql-9.1 postgresql-server-dev-9.1
  37 + # Install the database packages
  38 + sudo apt-get install -y postgresql-9.1 libpq-dev
  39 +
  40 + # Install only the necessary gems
  41 + sudo -u gitlab -H bundle install --deployment --without development test mysql
26 42  
27   - # Connect to database server
  43 + # Login to PostgreSQL
28 44 sudo -u postgres psql -d template1
29 45  
30   - # Add a user called gitlab. Change $password to a real password
  46 + # Create a user for GitLab. (change $password to a real password)
31 47 template1=# CREATE USER gitlab WITH PASSWORD '$password';
32 48  
33 49 # Create the GitLab production database & grant all privileges on database
34 50 template1=# CREATE DATABASE gitlabhq_production OWNER gitlab;
35 51  
36   - # Quit from PostgreSQL server
  52 + # Quit the database session
37 53 template1=# \q
38 54  
39   - # Try connect to new database
40   - sudo -u gitlab psql -d gitlabhq_production
  55 + # Try connecting to the new database with the new user
  56 + sudo -u gitlab -H psql -d gitlabhq_production
41 57  
42 58  
43 59  
44   -#### Select the database you want to use
  60 +# Configure GitLab
45 61  
46 62 # Mysql
47 63 sudo -u gitlab cp config/database.yml.mysql config/database.yml
... ... @@ -49,12 +65,4 @@ GitLab use MySQL as default database but you are free to use PostgreSQL.
49 65 # PostgreSQL
50 66 sudo -u gitlab cp config/database.yml.postgresql config/database.yml
51 67  
52   - # make sure to update username/password in config/database.yml
53   -
54   -#### Install gems
55   -
56   - # mysql
57   - sudo -u gitlab -H bundle install --without development test postgres --deployment
58   -
59   - # or postgres
60   - sudo -u gitlab -H bundle install --without development test mysql --deployment
  68 +Make sure to update username/password in config/database.yml.
... ...
doc/install/installation.md
  Diff comments   View file @dfc5adf
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 2  
3   -_Checkout requirements before setup_
  3 +Please read doc/install/requirements.md for hardware andplatform requirements.
4 4  
5 5  
6   -### IMPORTANT
7   -
8   -Please make sure you have followed all the steps below before posting to the mailing list with installation and configuration questions.
9   -
10   -Only create a GitHub Issue if you want a specific part of this installation guide updated.
11   -
12   -Also read the [Read this before you submit an issue](https://github.com/gitlabhq/gitlabhq/wiki/Read-this-before-you-submit-an-issue) wiki page.
  6 +**Important Note**
  7 +The following steps have been known to work.
  8 +If you deviate from this guide, do it with caution and make sure you don't
  9 +violate any assumptions GitLab makes about its environment.
  10 +If you find a bug/error in this guide please an issue or pull request following
  11 +the contribution guide (see CONTRIBUTING.md).
13 12  
14 13 - - -
15 14  
16   -# Basic setup
17   -
18   -The basic installation will provide you a GitLab setup with options:
19   -
20   -1. ruby 1.9.3
21   -2. mysql as main db
22   -3. gitolite v3 fork by gitlab
23   -4. nginx + unicorn
  15 +# Overview
24 16  
25   -The installation consists of next steps:
  17 +The GitLab installation consists of setting up th following components:
26 18  
27   -1. Packages / dependencies
  19 +1. Packages / Dependencies
28 20 2. Ruby
29   -3. Users
  21 +3. System Users
30 22 4. Gitolite
31   -5. Mysql
32   -6. GitLab.
33   -7. Nginx
  23 +5. Database
  24 +6. GitLab
  25 +7. Nginx
34 26  
35 27  
36   -# 1. Packages / dependencies
  28 +# 1. Packages / Dependencies
37 29  
38 30 *Keep in mind that `sudo` is not installed on Debian by default. You should install it as root:*
39 31  
40 32 apt-get update && apt-get upgrade && apt-get install sudo
41 33  
42   -Now install the required packages:
  34 +Make sure your system is up-to-date:
43 35  
44 36 sudo apt-get update
45 37 sudo apt-get upgrade
46 38  
47   - sudo apt-get install -y wget curl gcc checkinstall libxml2-dev libxslt-dev libcurl4-openssl-dev libreadline6-dev libc6-dev libssl-dev libmysql++-dev make build-essential zlib1g-dev libicu-dev redis-server openssh-server git-core python-dev python-pip libyaml-dev postfix libpq-dev
  39 +Install the required packages:
  40 +
  41 + sudo apt-get install -y wget curl build-essential checkinstall libxml2-dev libxslt-dev libcurl4-openssl-dev libreadline6-dev libc6-dev libssl-dev zlib1g-dev libicu-dev redis-server openssh-server git-core libyaml-dev postfix
  42 +
  43 +Make sure you have the right version of Python installed.
  44 +
  45 + # Install Python
  46 + sudo apt-get install python
  47 +
  48 + # Make sure that Python is 2.x (3.x is not supported at the moment)
  49 + python --version
48 50  
49   - sudo pip install pygments
  51 + # If it's Python 3 you might need to install Python 2 separately
  52 + sudo apt-get install python2.7
50 53  
  54 + # Make sure you can access Python via `python2`
  55 + python2 --version
51 56  
52   -# 2. Install Ruby
  57 + # If you get a "command not found" error create a link to the python binary
  58 + sudo ln -s /usr/bin/python /usr/bin/python2
53 59  
54   - wget http://ftp.ruby-lang.org/pub/ruby/1.9/ruby-1.9.3-p194.tar.gz
55   - tar xfvz ruby-1.9.3-p194.tar.gz
56   - cd ruby-1.9.3-p194
  60 +
  61 +# 2. Ruby
  62 +
  63 + wget http://ftp.ruby-lang.org/pub/ruby/1.9/ruby-1.9.3-p327.tar.gz
  64 + tar xfvz ruby-1.9.3-p327.tar.gz
  65 + cd ruby-1.9.3-p327
57 66 ./configure
58 67 make
59 68 sudo make install
60 69  
61   -# 3. Users
62 70  
63   -Create user for git:
  71 +# 3. System Users
  72 +
  73 +Create a user for Git and Gitolite:
64 74  
65 75 sudo adduser \
66 76 --system \
67 77 --shell /bin/sh \
68   - --gecos 'git version control' \
  78 + --gecos 'Git Version Control' \
69 79 --group \
70 80 --disabled-password \
71 81 --home /home/git \
72 82 git
73 83  
74   -Create user for GitLab:
75   -
76   - # ubuntu/debian
77   - sudo adduser --disabled-login --gecos 'gitlab system' gitlab
78   -
79   -Add your users to groups:
  84 +Create a user for GitLab:
80 85  
81   - sudo usermod -a -G git gitlab
82   - sudo usermod -a -G gitlab git
  86 + sudo adduser --disabled-login --gecos 'GitLab' gitlab
83 87  
84   -Generate key:
  88 + # Add it to the git group
  89 + sudo addmod -a -G git gitlab
85 90  
86   - sudo -H -u gitlab ssh-keygen -q -N '' -t rsa -f /home/gitlab/.ssh/id_rsa
  91 + # Generate the SSH key
  92 + sudo -u gitlab -H ssh-keygen -q -N '' -t rsa -f /home/gitlab/.ssh/id_rsa
87 93  
88 94  
89 95 # 4. Gitolite
90 96  
91 97 Clone GitLab's fork of the Gitolite source code:
92 98  
93   - sudo -H -u git git clone -b gl-v304 https://github.com/gitlabhq/gitolite.git /home/git/gitolite
  99 + sudo -u git -H git clone -b gl-v304 https://github.com/gitlabhq/gitolite.git /home/git/gitolite
94 100  
95   -Setup:
  101 +Setup Gitolite with GitLab as its admin:
96 102  
  103 +**Important Note**
  104 +GitLab assumes *full and unshared* control over this Gitolite installation.
  105 +
  106 + # Add Gitolite scripts to $PATH
97 107 cd /home/git
98 108 sudo -u git -H mkdir bin
99   - sudo -u git sh -c 'echo -e "PATH=\$PATH:/home/git/bin\nexport PATH" >> /home/git/.profile'
100   - sudo -u git sh -c 'gitolite/install -ln /home/git/bin'
  109 + sudo -u git -H sh -c 'echo -e "PATH=\$PATH:/home/git/bin\nexport PATH" >> /home/git/.profile'
  110 + sudo -u git -H sh -c 'gitolite/install -ln /home/git/bin'
101 111  
  112 + # Copy the gitlab user's (public) SSH key ...
102 113 sudo cp /home/gitlab/.ssh/id_rsa.pub /home/git/gitlab.pub
103 114 sudo chmod 0444 /home/git/gitlab.pub
104 115  
  116 + # ... and use it as the Gitolite admin key for setup
105 117 sudo -u git -H sh -c "PATH=/home/git/bin:$PATH; gitolite setup -pk /home/git/gitlab.pub"
106   -
107 118  
108   -Permissions:
  119 +Fix the directory permissions for the repository:
109 120  
110   - sudo chmod -R g+rwX /home/git/repositories/
  121 + # Make sure the repositories dir is owned by git and it stays that way
  122 + sudo chmod -R ug+rwXs /home/git/repositories/
111 123 sudo chown -R git:git /home/git/repositories/
112 124  
113   - # clone admin repo to add localhost to known_hosts
114   - # & be sure your user has access to gitolite
  125 +## Test if everything works so far
  126 +
  127 + # Clone the admin repo so SSH adds localhost to known_hosts ...
  128 + # ... and to be sure your users have access to Gitolite
115 129 sudo -u gitlab -H git clone git@localhost:gitolite-admin.git /tmp/gitolite-admin
116 130  
117   - # if succeed you can remove it
  131 + # If it succeeded without errors you can remove the cloned repo
118 132 sudo rm -rf /tmp/gitolite-admin
119 133  
120   -**IMPORTANT! If you can't clone `gitolite-admin` repository - DO NOT PROCEED WITH INSTALLATION**
  134 +**Impornant Note**
  135 +If you can't clone the `gitolite-admin` repository: **DO NOT PROCEED WITH INSTALLATION**
121 136 Check the [Trouble Shooting Guide](https://github.com/gitlabhq/gitlab-public-wiki/wiki/Trouble-Shooting-Guide)
122   -and ensure you have followed all of the above steps carefully.
123   -
124   -
125   -# 5. Mysql database
  137 +and make sure you have followed all of the above steps carefully.
126 138  
127   - sudo apt-get install -y mysql-server mysql-client libmysqlclient-dev
128 139  
129   - # Login to MySQL
130   - $ mysql -u root -p
  140 +# 5. Database
131 141  
132   - # Create the GitLab production database
133   - mysql> CREATE DATABASE IF NOT EXISTS `gitlabhq_production` DEFAULT CHARACTER SET `utf8` COLLATE `utf8_unicode_ci`;
134   -
135   - # Create the MySQL User change $password to a real password
136   - mysql> CREATE USER 'gitlab'@'localhost' IDENTIFIED BY '$password';
137   -
138   - # Grant proper permissions to the MySQL User
139   - mysql> GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, INDEX, ALTER ON `gitlabhq_production`.* TO 'gitlab'@'localhost';
  142 +See doc/install/databases.md
140 143  
141 144  
142 145 # 6. GitLab
143 146  
  147 + We'll install GitLab into the gitlab user's home directory
144 148 cd /home/gitlab
145 149  
  150 +## Clone the Source
146 151  
147   -#### Get source code
  152 + # Clone the latest stable release
  153 + sudo -u gitlab -H git clone -b stable https://github.com/gitlabhq/gitlabhq.git gitlab
148 154  
149   - # Get gitlab code. Use this for stable setup
150   - sudo -H -u gitlab git clone -b stable https://github.com/gitlabhq/gitlabhq.git gitlab
  155 +**Note***
  156 +You can change `stable` to `master` if you want the *bleeding edge* version, but
  157 +do so with caution!
151 158  
152   - # Skip this for stable setup.
153   - # Master branch (recent changes, less stable)
154   - sudo -H -u gitlab git clone -b master https://github.com/gitlabhq/gitlabhq.git gitlab
  159 +## Configure it
155 160  
  161 + cd /home/gitlab/gitlab
156 162  
157   -#### Copy configs
158   -
159   - cd gitlab
  163 + # Copy the example GitLab config
  164 + sudo -u gitlab -H cp config/gitlab.yml.example config/gitlab.yml
160 165  
161   - # Rename config files
162   - #
163   - sudo -u gitlab cp config/gitlab.yml.example config/gitlab.yml
  166 + # Make sure to change "localhost" to the fully-qualified domain name of your
  167 + # host serving GitLab where necessary
  168 + sudo -u gitlab -H vim config/gitlab.yml
164 169  
165   - # Copy mysql db config
166   - #
167   - # make sure to update username/password in config/database.yml
168   - #
169   - sudo -u gitlab cp config/database.yml.mysql config/database.yml
  170 + # Copy the example Unicorn config
  171 + sudo -u gitlab -H cp config/unicorn.rb.example config/unicorn.rb
170 172  
171   - # Copy unicorn config
172   - #
173   - sudo -u gitlab cp config/unicorn.rb.example config/unicorn.rb
  173 +**Important Note**
  174 +Make sure to edit both files to match your setup.
174 175  
175   -#### Install gems
  176 +## Install Gems
176 177  
177 178 cd /home/gitlab/gitlab
178 179  
179 180 sudo gem install charlock_holmes --version '0.6.9'
180 181 sudo gem install bundler
181   - sudo -u gitlab -H bundle install --without development test postgres --deployment
  182 + sudo -u gitlab -H bundle install --deployment --without development test
182 183  
183   -#### Configure git client
  184 +## Configure Git
184 185  
185   -Gitlab needs to be able to commit and push changes to gitolite.
186   -Git requires a username and email in order to be able to do that.
  186 +GitLab needs to be able to commit and push changes to Gitolite. In order to do
  187 +that Git requires a username and email. (Please use the `email.from` address
  188 +for the email)
187 189  
  190 + sudo -u gitlab -H git config --global user.name "GitLab"
188 191 sudo -u gitlab -H git config --global user.email "gitlab@localhost"
189   - sudo -u gitlab -H git config --global user.name "Gitlab"
190 192  
191   -#### Setup application
  193 +## Setup GitLab hooks
192 194  
193   - sudo -u gitlab bundle exec rake gitlab:app:setup RAILS_ENV=production
  195 + sudo cp ./lib/hooks/post-receive /home/git/.gitolite/hooks/common/post-receive
  196 + sudo chown git:git /home/git/.gitolite/hooks/common/post-receive
194 197  
  198 +## Initialise Database and Activate Advanced Features
195 199  
196   -#### Setup GitLab hooks
  200 + sudo -u gitlab -H bundle exec rake gitlab:app:setup RAILS_ENV=production
197 201  
198   - sudo cp ./lib/hooks/post-receive /home/git/.gitolite/hooks/common/post-receive
199   - sudo chown git:git /home/git/.gitolite/hooks/common/post-receive
200 202  
201   -#### Check application status
  203 +## Check Application Status
  204 +
  205 +Check if GitLab and its environment is configured correctly:
  206 +
  207 + sudo -u gitlab -H bundle exec rake gitlab:env:info RAILS_ENV=production
202 208  
203   -Checking status:
  209 +To make sure you didn't miss anything run a more thorough check with:
204 210  
205   - sudo -u gitlab bundle exec rake gitlab:app:status RAILS_ENV=production
  211 + sudo -u gitlab -H bundle exec rake gitlab:app:status RAILS_ENV=production
206 212  
  213 +```
  214 +# OUTPUT EXAMPLE
  215 +Starting diagnostic
  216 +config/database.yml............exists
  217 +config/gitlab.yml............exists
  218 +/home/git/repositories/............exists
  219 +/home/git/repositories/ is writable?............YES
  220 +remote: Counting objects: 603, done.
  221 +remote: Compressing objects: 100% (466/466), done.
  222 +remote: Total 603 (delta 174), reused 0 (delta 0)
  223 +Receiving objects: 100% (603/603), 53.29 KiB, done.
  224 +Resolving deltas: 100% (174/174), done.
  225 +Can clone gitolite-admin?............YES
  226 +UMASK for .gitolite.rc is 0007? ............YES
  227 +/home/git/share/gitolite/hooks/common/post-receive exists? ............YES
  228 +```
207 229  
208   - # OUTPUT EXAMPLE
209   - Starting diagnostic
210   - config/database.yml............exists
211   - config/gitlab.yml............exists
212   - /home/git/repositories/............exists
213   - /home/git/repositories/ is writable?............YES
214   - remote: Counting objects: 603, done.
215   - remote: Compressing objects: 100% (466/466), done.
216   - remote: Total 603 (delta 174), reused 0 (delta 0)
217   - Receiving objects: 100% (603/603), 53.29 KiB, done.
218   - Resolving deltas: 100% (174/174), done.
219   - Can clone gitolite-admin?............YES
220   - UMASK for .gitolite.rc is 0007? ............YES
221   - /home/git/share/gitolite/hooks/common/post-receive exists? ............YES
  230 +If you are all green - congratulations! You run a GitLab now.
  231 +But there are still a few steps to go.
222 232  
223   -If you got all YES - congratulations! You can run a GitLab app.
224 233  
225   -#### init script
  234 +## Install Init Script
226 235  
227   -Create init script in /etc/init.d/gitlab:
  236 +Download the init script (will be /etc/init.d/gitlab):
228 237  
229 238 sudo wget https://raw.github.com/gitlabhq/gitlab-recipes/master/init.d/gitlab -P /etc/init.d/
230 239 sudo chmod +x /etc/init.d/gitlab
231 240  
232   -GitLab autostart:
  241 +Make GitLab start on boot:
233 242  
234 243 sudo update-rc.d gitlab defaults 21
235 244  
236   -#### Now you should start GitLab application:
  245 +
  246 +Start your GitLab instance:
237 247  
238 248 sudo service gitlab start
239 249  
240 250  
241 251 # 7. Nginx
242 252  
243   - # Install first
  253 +## Installation
244 254 sudo apt-get install nginx
245 255  
246   - # Add GitLab to nginx sites & change with your host specific settings
  256 +## Site Configuration
  257 +
  258 +Download an example site config:
  259 +
247 260 sudo wget https://raw.github.com/gitlabhq/gitlab-recipes/master/nginx/gitlab -P /etc/nginx/sites-available/
248 261 sudo ln -s /etc/nginx/sites-available/gitlab /etc/nginx/sites-enabled/gitlab
249 262  
  263 +Make sure to edit the config file to match your setup:
  264 +
250 265 # Change **YOUR_SERVER_IP** and **YOUR_SERVER_FQDN**
251 266 # to the IP address and fully-qualified domain name
252   - # of the host serving GitLab.
  267 + # of your host serving GitLab
253 268 sudo vim /etc/nginx/sites-enabled/gitlab
254 269  
255   - # Restart nginx:
  270 +## Restart
  271 +
256 272 sudo /etc/init.d/nginx restart
257 273  
258 274  
259   -# Done! Visit YOUR_SERVER for gitlab instance
  275 +# Done!
260 276  
261   -You can login via web using admin generated with setup:
  277 +Visit YOUR_SERVER for your first GitLab login.
  278 +The setup has created an admin account for you. You can use it to log in:
262 279  
263 280 admin@local.host
264 281 5iveL!fe
265 282  
  283 +**Important Note**
  284 +Please go over to your profile page and immediately chage the password, so
  285 +nobody can access your GitLab by using this login information later on.
  286 +
  287 +**Enjoy!**
  288 +
266 289  
267 290 - - -
268 291  
269 292  
270 293 # Advanced setup tips:
271 294  
272   -_Checkout databases.md for PostgreSQL_
273   -
274   -## Customizing Resque's Redis connection
  295 +## Custom Redis connections
275 296  
276 297 If you'd like Resque to connect to a Redis server on a non-standard port or on
277   -a different host, you can configure its connection string in the
278   -**config/resque.yml** file:
279   -
280   - production: redis.example.com:6379
  298 +a different host, you can configure its connection string via the
  299 +`config/resque.yml` file.
281 300  
282   -**Ok - we have a working application now. **
283   -**But keep going - there are some things that should be done **
  301 + # example
  302 + production: redis.example.tld:6379
... ...
doc/install/requirements.md
  Diff comments   View file @dfc5adf
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).
... ...