Commit 655e68a0adc391013bea1dd4ef3838edde7c3f97
Exists in
master
and in
4 other branches
Merge pull request #2998 from axilleas/master
Minor changes to installation and databases docs.
Showing
2 changed files
with
29 additions
and
26 deletions
Show diff stats
doc/install/databases.md
| ... | ... | @@ -27,7 +27,7 @@ GitLab supports the following databases: |
| 27 | 27 | mysql> \q |
| 28 | 28 | |
| 29 | 29 | # Try connecting to the new database with the new user |
| 30 | - sudo -u gitlab -H mysql -u gitlab -p -D gitlabhq_production | |
| 30 | + sudo -u git -H mysql -u gitlab -p -D gitlabhq_production | |
| 31 | 31 | |
| 32 | 32 | ## PostgreSQL |
| 33 | 33 | |
| ... | ... | @@ -47,5 +47,5 @@ GitLab supports the following databases: |
| 47 | 47 | template1=# \q |
| 48 | 48 | |
| 49 | 49 | # Try connecting to the new database with the new user |
| 50 | - sudo -u gitlab -H psql -d gitlabhq_production | |
| 50 | + sudo -u git -H psql -d gitlabhq_production | |
| 51 | 51 | ... | ... |
doc/install/installation.md
| 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 and platform requirements. | |
| 3 | +Please read [`doc/install/requirements.md`](./requirements.md) for hardware and platform requirements. | |
| 4 | 4 | |
| 5 | 5 | |
| 6 | 6 | **Important Note:** |
| ... | ... | @@ -8,12 +8,13 @@ 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 | 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. | |
| 11 | +alternative web server have a look at the [`Advanced Setup | |
| 12 | +Tips`](./installation.md#advanced-setup-tips) section. | |
| 12 | 13 | |
| 13 | 14 | |
| 14 | 15 | **Important Note:** |
| 15 | 16 | If you find a bug/error in this guide please submit an issue or pull request |
| 16 | -following the contribution guide (see `CONTRIBUTING.md`). | |
| 17 | +following the [`contribution guide`](../../CONTRIBUTING.md). | |
| 17 | 18 | |
| 18 | 19 | - - - |
| 19 | 20 | |
| ... | ... | @@ -32,16 +33,13 @@ The GitLab installation consists of setting up the following components: |
| 32 | 33 | |
| 33 | 34 | # 1. Packages / Dependencies |
| 34 | 35 | |
| 35 | -`sudo` is not installed on Debian by default. If you don't have it you'll need | |
| 36 | -to install it first. | |
| 36 | +`sudo` is not installed on Debian by default. Make sure your system is | |
| 37 | +up-to-date and install it. | |
| 37 | 38 | |
| 38 | 39 | # run as root |
| 39 | - apt-get update && apt-get upgrade && apt-get install sudo | |
| 40 | - | |
| 41 | -Make sure your system is up-to-date: | |
| 42 | - | |
| 43 | - sudo apt-get update | |
| 44 | - sudo apt-get upgrade | |
| 40 | + apt-get update | |
| 41 | + apt-get upgrade | |
| 42 | + apt-get install sudo | |
| 45 | 43 | |
| 46 | 44 | **Note:** |
| 47 | 45 | Vim is an editor that is used here whenever there are files that need to be |
| ... | ... | @@ -96,25 +94,24 @@ Create a `git` user for Gitlab: |
| 96 | 94 | |
| 97 | 95 | # 4. GitLab shell |
| 98 | 96 | |
| 99 | - # login as git | |
| 97 | + # Login as git | |
| 100 | 98 | sudo su git |
| 101 | 99 | |
| 102 | - # go to home directory | |
| 100 | + # Go to home directory | |
| 103 | 101 | cd /home/git |
| 104 | 102 | |
| 105 | - # clone gitlab shell | |
| 103 | + # Clone gitlab shell | |
| 106 | 104 | git clone https://github.com/gitlabhq/gitlab-shell.git |
| 107 | 105 | |
| 108 | - # setup | |
| 106 | + # Setup | |
| 109 | 107 | cd gitlab-shell |
| 110 | 108 | cp config.yml.example config.yml |
| 111 | 109 | ./bin/install |
| 112 | 110 | |
| 113 | 111 | |
| 114 | - | |
| 115 | 112 | # 5. Database |
| 116 | 113 | |
| 117 | -To setup the MySQL/PostgreSQL database and dependencies please see [`doc/install/databases.md`](./databases.md) . | |
| 114 | +To setup the MySQL/PostgreSQL database and dependencies please see [`doc/install/databases.md`](./databases.md). | |
| 118 | 115 | |
| 119 | 116 | |
| 120 | 117 | # 6. GitLab |
| ... | ... | @@ -154,9 +151,13 @@ do so with caution! |
| 154 | 151 | sudo chmod -R u+rwX log/ |
| 155 | 152 | sudo chmod -R u+rwX tmp/ |
| 156 | 153 | |
| 157 | - # Make directory for satellites | |
| 154 | + # Create directory for satellites | |
| 158 | 155 | sudo -u git -H mkdir /home/git/gitlab-satellites |
| 159 | 156 | |
| 157 | + # Create directory for pids and make sure GitLab can write to it | |
| 158 | + sudo -u git -H mkdir tmp/pids/ | |
| 159 | + sudo chmod -R u+rwX tmp/pids/ | |
| 160 | + | |
| 160 | 161 | # Copy the example Unicorn config |
| 161 | 162 | sudo -u git -H cp config/unicorn.rb.example config/unicorn.rb |
| 162 | 163 | |
| ... | ... | @@ -187,7 +188,9 @@ Make sure to update username/password in config/database.yml. |
| 187 | 188 | |
| 188 | 189 | |
| 189 | 190 | ## Initialise Database and Activate Advanced Features |
| 190 | - | |
| 191 | + | |
| 192 | + sudo -u git -H bundle exec rake db:setup RAILS_ENV=production | |
| 193 | + sudo -u git -H bundle exec rake db:seed_fu RAILS_ENV=production | |
| 191 | 194 | sudo -u git -H bundle exec rake gitlab:setup RAILS_ENV=production |
| 192 | 195 | |
| 193 | 196 | |
| ... | ... | @@ -205,7 +208,7 @@ Make GitLab start on boot: |
| 205 | 208 | |
| 206 | 209 | ## Check Application Status |
| 207 | 210 | |
| 208 | -Check if GitLab and its environment is configured correctly: | |
| 211 | +Check if GitLab and its environment are configured correctly: | |
| 209 | 212 | |
| 210 | 213 | sudo -u git -H bundle exec rake gitlab:env:info RAILS_ENV=production |
| 211 | 214 | |
| ... | ... | @@ -227,7 +230,7 @@ However there are still a few steps left. |
| 227 | 230 | |
| 228 | 231 | **Note:** |
| 229 | 232 | If you can't or don't want to use Nginx as your web server, have a look at the |
| 230 | -"Advanced Setup Tips" section. | |
| 233 | +[`Advanced Setup Tips`](./installation.md#advanced-setup-tips) section. | |
| 231 | 234 | |
| 232 | 235 | ## Installation |
| 233 | 236 | sudo apt-get install nginx |
| ... | ... | @@ -244,11 +247,11 @@ Make sure to edit the config file to match your setup: |
| 244 | 247 | # Change **YOUR_SERVER_IP** and **YOUR_SERVER_FQDN** |
| 245 | 248 | # to the IP address and fully-qualified domain name |
| 246 | 249 | # of your host serving GitLab |
| 247 | - sudo vim /etc/nginx/sites-enabled/gitlab | |
| 250 | + sudo vim /etc/nginx/sites-available/gitlab | |
| 248 | 251 | |
| 249 | 252 | ## Restart |
| 250 | 253 | |
| 251 | - sudo /etc/init.d/nginx restart | |
| 254 | + sudo service nginx restart | |
| 252 | 255 | |
| 253 | 256 | |
| 254 | 257 | # Done! |
| ... | ... | @@ -282,7 +285,7 @@ a different host, you can configure its connection string via the |
| 282 | 285 | |
| 283 | 286 | ## Custom SSH Connection |
| 284 | 287 | |
| 285 | -If you are running SSH on a non-standard port, you must change the gitlab user'S SSH config. | |
| 288 | +If you are running SSH on a non-standard port, you must change the gitlab user's SSH config. | |
| 286 | 289 | |
| 287 | 290 | # Add to /home/git/.ssh/config |
| 288 | 291 | host localhost # Give your setup a name (here: override localhost) | ... | ... |