Download as
Browse Code »

Commit fc7ac316a084788f91710912e110f1aa70fd5a65

Authored by Robert Speicher
1 parent 12c57a70
Exists in master and in 4 other branches 6-8-stable, 7-0-stable, 7-0-stable-spb, spb-stable

Clean up doc/installation.md 

Closes #939
Showing 1 changed file with 36 additions and 30 deletions   Show diff stats
doc/installation.md
  Diff comments   View file @fc7ac31
... ... @@ -20,7 +20,7 @@ You might have some luck using these, but no guarantees:
20 20 - MacOS X
21 21 - FreeBSD
22 22  
23   -Gitlab does **not** run on Windows and we have no plans of making Gitlab compatible.
  23 +GitLab does **not** run on Windows and we have no plans of making GitLab compatible.
24 24  
25 25 ## This installation guide created for Debian/Ubuntu and properly tested.
26 26  
... ... @@ -28,21 +28,21 @@ The installation consists of 6 steps:
28 28  
29 29 1. Install packages / dependencies
30 30 2. Install ruby
31   -3. Install gitolite
32   -4. Install and configure Gitlab.
  31 +3. Install Gitolite
  32 +4. Install and configure GitLab.
33 33 5. Start the web front-end
34 34 6. Start a Resque worker (for background processing)
35 35  
36 36 ### IMPORTANT
37 37  
38   -Please make sure you have followed all the steps below before posting to the mailinglist with installation and configuration questions.
  38 +Please make sure you have followed all the steps below before posting to the mailing list with installation and configuration questions.
39 39  
40   -Only create a Github Issue if you want a specific part of this installation guide updated.
  40 +Only create a GitHub Issue if you want a specific part of this installation guide updated.
41 41  
42 42 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.
43 43  
44 44 > - - -
45   -> First 3 steps can be easily skipped with simply install script:
  45 +> The first 3 steps of this guide can be easily skipped by executing an install script:
46 46 >
47 47 > # Install curl and sudo
48 48 > apt-get install curl sudo
... ... @@ -50,9 +50,9 @@ Also read the [Read this before you submit an issue](https://github.com/gitlabhq
50 50 > # 3 steps in 1 command :)
51 51 > curl https://raw.github.com/gitlabhq/gitlabhq/master/doc/debian_ubuntu.sh | sh
52 52 >
53   -> Now you can go to step 4"
  53 +> Now you can go to [Step 4](#4-install-gitlab-and-configuration-check-status-configuration)
54 54 >
55   -> Or if you are installing on Amazon Web Services using Ubuntu 12.04 you can do all steps (1 to 6) at once with:
  55 +> Or if you are installing on Amazon Web Services using Ubuntu 12.04 you can do all steps (1 to 6) at once with:
56 56 >
57 57 > curl https://raw.github.com/gitlabhq/gitlabhq/master/lib/support/aws/debian_ubuntu_aws.sh | sh
58 58 >
... ... @@ -61,7 +61,11 @@ Also read the [Read this before you submit an issue](https://github.com/gitlabhq
61 61  
62 62 # 1. Install packages
63 63  
64   -*Keep in mind that `sudo` is not installed for debian by default. You should install it with as root:* **apt-get update && apt-get upgrade && apt-get install sudo**
  64 +*Keep in mind that `sudo` is not installed on Debian by default. You should install it as root:*
  65 +
  66 + apt-get update && apt-get upgrade && apt-get install sudo
  67 +
  68 +Now install the required packages:
65 69  
66 70 sudo apt-get update
67 71 sudo apt-get upgrade
... ... @@ -71,7 +75,7 @@ Also read the [Read this before you submit an issue](https://github.com/gitlabhq
71 75 # If you want to use MySQL:
72 76 sudo apt-get install -y mysql-server mysql-client libmysqlclient-dev
73 77  
74   -# 2. Install ruby
  78 +# 2. Install Ruby
75 79  
76 80 wget http://ftp.ruby-lang.org/pub/ruby/1.9/ruby-1.9.2-p290.tar.gz
77 81 tar xzfv ruby-1.9.2-p290.tar.gz
... ... @@ -80,7 +84,7 @@ Also read the [Read this before you submit an issue](https://github.com/gitlabhq
80 84 make
81 85 sudo make install
82 86  
83   -# 3. Install gitolite
  87 +# 3. Install Gitolite
84 88  
85 89 Create user for git:
86 90  
... ... @@ -93,12 +97,12 @@ Create user for git:
93 97 --home /home/git \
94 98 git
95 99  
96   -Create user for gitlab:
  100 +Create user for GitLab:
97 101  
98 102 # ubuntu/debian
99 103 sudo adduser --disabled-login --gecos 'gitlab system' gitlab
100 104  
101   -Add your user to git group:
  105 +Add your user to the `git` group:
102 106  
103 107 sudo usermod -a -G git gitlab
104 108  
... ... @@ -106,10 +110,10 @@ Generate key:
106 110  
107 111 sudo -H -u gitlab ssh-keygen -q -N '' -t rsa -f /home/gitlab/.ssh/id_rsa
108 112  
109   -Get gitolite source code:
  113 +Clone GitLab's fork of the Gitolite source code:
110 114  
111 115 cd /home/git
112   - sudo -H -u git git clone git://github.com/gitlabhq/gitolite /home/git/gitolite
  116 + sudo -H -u git git clone https://github.com/gitlabhq/gitolite.git /home/git/gitolite
113 117  
114 118 Setup:
115 119  
... ... @@ -135,23 +139,23 @@ Permissions:
135 139 # if succeed you can remove it
136 140 sudo rm -rf /tmp/gitolite-admin
137 141  
138   -**IMPORTANT! If you cant clone `gitolite-admin` repository - DONT PROCEED INSTALLATION**
  142 +**IMPORTANT! If you can't clone `gitolite-admin` repository - DO NOT PROCEED WITH INSTALLATION**
  143 +Check the [Trouble Shooting Guide](https://github.com/gitlabhq/gitlab-public-wiki/wiki/Trouble-Shooting-Guide)
  144 +and ensure you have followed all of the above steps carefully.
139 145  
140   -# 4. Install gitlab and configuration. Check status configuration.
  146 +# 4. Clone GitLab source and install prerequisites
141 147  
142 148 sudo gem install charlock_holmes --version '0.6.8'
143 149 sudo pip install pygments
144 150 sudo gem install bundler
145 151 cd /home/gitlab
146   - sudo -H -u gitlab git clone -b stable git://github.com/gitlabhq/gitlabhq.git gitlab
  152 + sudo -H -u gitlab git clone -b stable https://github.com/gitlabhq/gitlabhq.git gitlab
147 153 cd gitlab
148 154  
149   - sudo -u gitlab mkdir tmp
150   -
151 155 # Rename config files
152 156 sudo -u gitlab cp config/gitlab.yml.example config/gitlab.yml
153 157  
154   -#### Select db you want to use
  158 +#### Select the database you want to use
155 159  
156 160 # SQLite
157 161 sudo -u gitlab cp config/database.yml.sqlite config/database.yml
... ... @@ -179,15 +183,17 @@ Permissions:
179 183  
180 184 sudo -u gitlab -H bundle install --without development test --deployment
181 185  
182   -#### Setup DB
  186 +#### Setup database
183 187  
184 188 sudo -u gitlab bundle exec rake gitlab:app:setup RAILS_ENV=production
185 189  
186   -#### Setup gitlab hooks
  190 +#### Setup GitLab hooks
187 191  
188 192 sudo cp ./lib/hooks/post-receive /home/git/share/gitolite/hooks/common/post-receive
189 193 sudo chown git:git /home/git/share/gitolite/hooks/common/post-receive
190 194  
  195 +#### Check application status
  196 +
191 197 Checking status:
192 198  
193 199 sudo -u gitlab bundle exec rake gitlab:app:status RAILS_ENV=production
... ... @@ -208,9 +214,9 @@ Checking status:
208 214 UMASK for .gitolite.rc is 0007? ............YES
209 215 /home/git/share/gitolite/hooks/common/post-receive exists? ............YES
210 216  
211   -If you got all YES - congrats! You can go to next step.
  217 +If you got all YES - congratulations! You can go to the next step.
212 218  
213   -# 5. Server up
  219 +# 5. Start the web server
214 220  
215 221 Application can be started with next command:
216 222  
... ... @@ -225,12 +231,12 @@ You can login via web using admin generated with setup:
225 231 admin@local.host
226 232 5iveL!fe
227 233  
228   -# 6. Run resque process (for processing queue).
  234 +# 6. Run Resque process (for processing job queue).
229 235  
230 236 # Manually
231 237 sudo -u gitlab bundle exec rake environment resque:work QUEUE=* RAILS_ENV=production BACKGROUND=yes
232 238  
233   - # Gitlab start script
  239 + # GitLab start script
234 240 sudo -u gitlab ./resque.sh
235 241 # if you run this as root /home/gitlab/gitlab/tmp/pids/resque_worker.pid will be owned by root
236 242 # causing the resque worker not to start via init script on next boot/service restart
... ... @@ -250,7 +256,7 @@ You can login via web using admin generated with setup:
250 256 sudo -u gitlab cp config/unicorn.rb.orig config/unicorn.rb
251 257 sudo -u gitlab bundle exec unicorn_rails -c config/unicorn.rb -E production -D
252 258  
253   -Add gitlab to nginx sites & change with your host specific settings
  259 +Add GitLab to nginx sites & change with your host specific settings
254 260  
255 261 sudo cp /home/gitlab/gitlab/lib/support/nginx-gitlab /etc/nginx/sites-available/gitlab
256 262 sudo ln -s /etc/nginx/sites-available/gitlab /etc/nginx/sites-enabled/gitlab
... ... @@ -272,10 +278,10 @@ Adding permission:
272 278  
273 279 sudo chmod +x /etc/init.d/gitlab
274 280  
275   -Gitlab autostart:
  281 +GitLab autostart:
276 282  
277 283 sudo update-rc.d gitlab defaults
278 284  
279   -Now you can start/restart/stop gitlab like:
  285 +Now you can start/restart/stop GitLab like:
280 286  
281 287 sudo /etc/init.d/gitlab restart
... ...