Commit 95af7123bbe229f0e0c713de7271d668de105bd0
1 parent
772f2f1a
Exists in
spb-stable
and in
2 other branches
Reformulate some of the https instructions.
Showing
1 changed file
with
11 additions
and
9 deletions
Show diff stats
doc/install/installation.md
| @@ -158,7 +158,7 @@ We recommend using a PostgreSQL database. For MySQL check [MySQL setup guide](da | @@ -158,7 +158,7 @@ We recommend using a PostgreSQL database. For MySQL check [MySQL setup guide](da | ||
| 158 | # Make sure to change "localhost" to the fully-qualified domain name of your | 158 | # Make sure to change "localhost" to the fully-qualified domain name of your |
| 159 | # host serving GitLab where necessary | 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. | 161 | + # If you want to use https make sure that you set `https` to `true`. See [Using HTTPS](#using-https) for all necessary details. |
| 162 | # | 162 | # |
| 163 | # If you installed Git from source, change the git bin_path to /usr/local/bin/git | 163 | # If you installed Git from source, change the git bin_path to /usr/local/bin/git |
| 164 | sudo -u git -H editor config/gitlab.yml | 164 | sudo -u git -H editor config/gitlab.yml |
| @@ -242,8 +242,11 @@ GitLab Shell is an ssh access and repository management software developed speci | @@ -242,8 +242,11 @@ GitLab Shell is an ssh access and repository management software developed speci | ||
| 242 | 242 | ||
| 243 | # By default, the gitlab-shell config is generated from your main gitlab config. | 243 | # By default, the gitlab-shell config is generated from your main gitlab config. |
| 244 | # | 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. | 245 | + # Note: When using GitLab with HTTPS please change the following: |
| 246 | + # - Provide paths to the certificates under `ca_file` and `ca_path options. | ||
| 247 | + # - The `gitlab_url` option must point to the https endpoint of GitLab. | ||
| 248 | + # - In case you are using self signed certificate set `self_signed_cert` to `true`. | ||
| 249 | + # See [Using HTTPS](#using-https) for all necessary details. | ||
| 247 | # | 250 | # |
| 248 | # You can review (and modify) the gitlab-shell config as follows: | 251 | # You can review (and modify) the gitlab-shell config as follows: |
| 249 | sudo -u git -H editor /home/git/gitlab-shell/config.yml | 252 | sudo -u git -H editor /home/git/gitlab-shell/config.yml |
| @@ -312,7 +315,7 @@ Make sure to edit the config file to match your setup: | @@ -312,7 +315,7 @@ Make sure to edit the config file to match your setup: | ||
| 312 | # domain name of your host serving GitLab. | 315 | # domain name of your host serving GitLab. |
| 313 | sudo editor /etc/nginx/sites-available/gitlab | 316 | sudo editor /etc/nginx/sites-available/gitlab |
| 314 | 317 | ||
| 315 | -**Note:** If you want to use https, replace the `gitlab` nginx config with `gitlab-ssl`. See #using-https for more details. | 318 | +**Note:** If you want to use https, replace the `gitlab` nginx config with `gitlab-ssl`. See [Using HTTPS](#using-https) for all necessary details. |
| 316 | 319 | ||
| 317 | ### Restart | 320 | ### Restart |
| 318 | 321 | ||
| @@ -343,12 +346,11 @@ Visit YOUR_SERVER in your web browser for your first GitLab login. The setup has | @@ -343,12 +346,11 @@ Visit YOUR_SERVER in your web browser for your first GitLab login. The setup has | ||
| 343 | 346 | ||
| 344 | ### Using HTTPS | 347 | ### Using HTTPS |
| 345 | 348 | ||
| 346 | -This is a retrospective of what is needed to configure in order to use GitLab with HTTPS: | 349 | +To recapitulate what is needed to use GitLab with HTTPS: |
| 347 | 350 | ||
| 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. | 351 | +1. In `gitlab.yml` set the `https` option to `true` |
| 352 | +1. In the `config.yml` of gitlab-shell set the relevant options (see the [install GitLab Shell section](#install-gitlab-shell) of this document). | ||
| 353 | +1. Use the `gitlab-ssl` nginx example config instead of the `gitlab` config. | ||
| 352 | 354 | ||
| 353 | ### Additional markup styles | 355 | ### Additional markup styles |
| 354 | 356 |