Commit 772f2f1ac8aab40a2cd62f285af131eb61ad12bb
Exists in
spb-stable
and in
2 other branches
Merge branch 'https_documentation' into 'master'
Https in installation document
Showing
1 changed file
with
18 additions
and
2 deletions
Show diff stats
doc/install/installation.md
| ... | ... | @@ -158,6 +158,8 @@ We recommend using a PostgreSQL database. For MySQL check [MySQL setup guide](da |
| 158 | 158 | # Make sure to change "localhost" to the fully-qualified domain name of your |
| 159 | 159 | # host serving GitLab where necessary |
| 160 | 160 | # |
| 161 | + # If you want to use https make sure that you set `https` to `true`. See #using-https for more details. | |
| 162 | + # | |
| 161 | 163 | # If you installed Git from source, change the git bin_path to /usr/local/bin/git |
| 162 | 164 | sudo -u git -H editor config/gitlab.yml |
| 163 | 165 | |
| ... | ... | @@ -238,7 +240,12 @@ GitLab Shell is an ssh access and repository management software developed speci |
| 238 | 240 | # Run the installation task for gitlab-shell (replace `REDIS_URL` if needed): |
| 239 | 241 | sudo -u git -H bundle exec rake gitlab:shell:install[v1.9.5] REDIS_URL=redis://localhost:6379 RAILS_ENV=production |
| 240 | 242 | |
| 241 | - # By default, the gitlab-shell config is generated from your main gitlab config. You can review (and modify) it as follows: | |
| 243 | + # By default, the gitlab-shell config is generated from your main gitlab config. | |
| 244 | + # | |
| 245 | + # Note: When using GitLab with HTTPS, provide paths to the certificates under `ca_file` and `ca_path options. | |
| 246 | + # In case you are using self signed certificate set `self_signed_cert` to `true`. `gitlab_url` must point to the https host. | |
| 247 | + # | |
| 248 | + # You can review (and modify) the gitlab-shell config as follows: | |
| 242 | 249 | sudo -u git -H editor /home/git/gitlab-shell/config.yml |
| 243 | 250 | |
| 244 | 251 | ### Initialize Database and Activate Advanced Features |
| ... | ... | @@ -305,7 +312,7 @@ Make sure to edit the config file to match your setup: |
| 305 | 312 | # domain name of your host serving GitLab. |
| 306 | 313 | sudo editor /etc/nginx/sites-available/gitlab |
| 307 | 314 | |
| 308 | -**Note:** If you want to use https, replace the `gitlab` nginx config with `gitlab-ssl`. | |
| 315 | +**Note:** If you want to use https, replace the `gitlab` nginx config with `gitlab-ssl`. See #using-https for more details. | |
| 309 | 316 | |
| 310 | 317 | ### Restart |
| 311 | 318 | |
| ... | ... | @@ -334,6 +341,15 @@ Visit YOUR_SERVER in your web browser for your first GitLab login. The setup has |
| 334 | 341 | |
| 335 | 342 | ## Advanced Setup Tips |
| 336 | 343 | |
| 344 | +### Using HTTPS | |
| 345 | + | |
| 346 | +This is a retrospective of what is needed to configure in order to use GitLab with HTTPS: | |
| 347 | + | |
| 348 | +1. In `gitlab.yml` enable https by setting `https` option to `true` | |
| 349 | +1. In gitlab-shell `config.yml` check if certificate options `ca_file`, `ca_path options` or `self_signed_cert` are set. | |
| 350 | +`gitlab_url` must point to the https host. | |
| 351 | +1. Use the `gitlab-ssl` nginx config. | |
| 352 | + | |
| 337 | 353 | ### Additional markup styles |
| 338 | 354 | |
| 339 | 355 | Apart from the always supported markdown style there are other rich text files that GitLab can display. But you might have to install a dependency to do so. Please see the [github-markup gem readme](https://github.com/gitlabhq/markup#markups) for more information. | ... | ... |