Download as
Browse Code »

Commit 2b79706d6d3c4f39f3eb11508ca59c5f6f1caa4f

Authored by Riyad Preukschas
1 parent a76a34dd
Exists in master and in 4 other branches 6-8-stable, 7-0-stable, 7-0-stable-spb, spb-stable

Fix spelling and wording in installation.md

Showing 1 changed file with 35 additions and 37 deletions   Show diff stats
doc/install/installation.md
  Diff comments   View file @2b79706
1 1 This installation guide was created for Debian/Ubuntu and tested on it.
2 2  
3   -Please read doc/install/requirements.md for hardware andplatform requirements.
  3 +Please read `doc/install/requirements.md` for hardware and platform requirements.
4 4  
5 5  
6   -**Important Note**
  6 +**Important Note:**
7 7 The following steps have been known to work.
8 8 If you deviate from this guide, do it with caution and make sure you don't
9 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).
  10 +For things like AWS installation scripts, init scripts or config files for
  11 +alternative web server have a look at the "Advanced Setup Tips" section.
  12 +
  13 +
  14 +**Important Note:**
  15 +If you find a bug/error in this guide please submit an issue or pull request
  16 +following the contribution guide (see `CONTRIBUTING.md`).
12 17  
13 18 - - -
14 19  
... ... @@ -51,7 +56,7 @@ Make sure you have the right version of Python installed.
51 56 # If it's Python 3 you might need to install Python 2 separately
52 57 sudo apt-get install python2.7
53 58  
54   - # Make sure you can access Python via `python2`
  59 + # Make sure you can access Python via python2
55 60 python2 --version
56 61  
57 62 # If you get a "command not found" error create a link to the python binary
... ... @@ -100,7 +105,7 @@ Clone GitLab's fork of the Gitolite source code:
100 105  
101 106 Setup Gitolite with GitLab as its admin:
102 107  
103   -**Important Note**
  108 +**Important Note:**
104 109 GitLab assumes *full and unshared* control over this Gitolite installation.
105 110  
106 111 # Add Gitolite scripts to $PATH
... ... @@ -131,20 +136,20 @@ Fix the directory permissions for the repository:
131 136 # If it succeeded without errors you can remove the cloned repo
132 137 sudo rm -rf /tmp/gitolite-admin
133 138  
134   -**Impornant Note**
135   -If you can't clone the `gitolite-admin` repository: **DO NOT PROCEED WITH INSTALLATION**
  139 +**Important Note:**
  140 +If you can't clone the `gitolite-admin` repository: **DO NOT PROCEED WITH INSTALLATION**!
136 141 Check the [Trouble Shooting Guide](https://github.com/gitlabhq/gitlab-public-wiki/wiki/Trouble-Shooting-Guide)
137 142 and make sure you have followed all of the above steps carefully.
138 143  
139 144  
140 145 # 5. Database
141 146  
142   -See doc/install/databases.md
  147 +See `doc/install/databases.md`
143 148  
144 149  
145 150 # 6. GitLab
146 151  
147   - We'll install GitLab into the gitlab user's home directory
  152 + # We'll install GitLab into home directory of the user "gitlab"
148 153 cd /home/gitlab
149 154  
150 155 ## Clone the Source
... ... @@ -152,7 +157,7 @@ See doc/install/databases.md
152 157 # Clone the latest stable release
153 158 sudo -u gitlab -H git clone -b stable https://github.com/gitlabhq/gitlabhq.git gitlab
154 159  
155   -**Note***
  160 +**Note:**
156 161 You can change `stable` to `master` if you want the *bleeding edge* version, but
157 162 do so with caution!
158 163  
... ... @@ -170,7 +175,7 @@ do so with caution!
170 175 # Copy the example Unicorn config
171 176 sudo -u gitlab -H cp config/unicorn.rb.example config/unicorn.rb
172 177  
173   -**Important Note**
  178 +**Important Note:**
174 179 Make sure to edit both files to match your setup.
175 180  
176 181 ## Install Gems
... ... @@ -184,8 +189,8 @@ Make sure to edit both files to match your setup.
184 189 ## Configure Git
185 190  
186 191 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)
  192 +that Git requires a username and email. (We recommend using the same address
  193 +used for the `email.from` setting in `config/gitlab.yml`)
189 194  
190 195 sudo -u gitlab -H git config --global user.name "GitLab"
191 196 sudo -u gitlab -H git config --global user.email "gitlab@localhost"
... ... @@ -202,7 +207,7 @@ for the email)
202 207  
203 208 ## Check Application Status
204 209  
205   -Check if GitLab and its environment is configured correctly:
  210 +Check if GitLab and its environment is configured correctly:
206 211  
207 212 sudo -u gitlab -H bundle exec rake gitlab:env:info RAILS_ENV=production
208 213  
... ... @@ -210,25 +215,8 @@ To make sure you didn't miss anything run a more thorough check with:
210 215  
211 216 sudo -u gitlab -H bundle exec rake gitlab:app:status RAILS_ENV=production
212 217  
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   -```
229   -
230   -If you are all green - congratulations! You run a GitLab now.
231   -But there are still a few steps to go.
  218 +If you are all green: congratulations, you successfully installed GitLab!
  219 +Although this is the case, there are still a few steps to go.
232 220  
233 221  
234 222 ## Install Init Script
... ... @@ -250,6 +238,10 @@ Start your GitLab instance:
250 238  
251 239 # 7. Nginx
252 240  
  241 +**Note:**
  242 +If you can't or don't want to use Nginx as your web server, have a look at the
  243 +"Advanced Setup Tips" section.
  244 +
253 245 ## Installation
254 246 sudo apt-get install nginx
255 247  
... ... @@ -280,7 +272,7 @@ The setup has created an admin account for you. You can use it to log in:
280 272 admin@local.host
281 273 5iveL!fe
282 274  
283   -**Important Note**
  275 +**Important Note:**
284 276 Please go over to your profile page and immediately chage the password, so
285 277 nobody can access your GitLab by using this login information later on.
286 278  
... ... @@ -290,9 +282,9 @@ nobody can access your GitLab by using this login information later on.
290 282 - - -
291 283  
292 284  
293   -# Advanced setup tips:
  285 +# Advanced Setup Tips
294 286  
295   -## Custom Redis connections
  287 +## Custom Redis Connection
296 288  
297 289 If you'd like Resque to connect to a Redis server on a non-standard port or on
298 290 a different host, you can configure its connection string via the
... ... @@ -300,3 +292,9 @@ a different host, you can configure its connection string via the
300 292  
301 293 # example
302 294 production: redis.example.tld:6379
  295 +
  296 +
  297 +## User-contributed Configurations
  298 +
  299 +You can find things like AWS installation scripts, init scripts or config files
  300 +for alternative web server in our [recipes collection](https://github.com/gitlabhq/gitlab-recipes/).
... ...