From b980ab407e6194723546125c80a0911b5e557215 Mon Sep 17 00:00:00 2001 From: Marin Jankovski Date: Tue, 10 Jun 2014 11:58:11 +0200 Subject: Update installation doc to mention using https. --- doc/install/installation.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/doc/install/installation.md b/doc/install/installation.md index 7840cef8900..eebc1a3e32e 100644 --- a/doc/install/installation.md +++ b/doc/install/installation.md @@ -158,6 +158,8 @@ We recommend using a PostgreSQL database. For MySQL check [MySQL setup guide](da # Make sure to change "localhost" to the fully-qualified domain name of your # host serving GitLab where necessary # + # If you want to use https make sure that you set `https` to `true`. See #using-https for more details. + # # If you installed Git from source, change the git bin_path to /usr/local/bin/git sudo -u git -H editor config/gitlab.yml @@ -305,7 +307,7 @@ Make sure to edit the config file to match your setup: # domain name of your host serving GitLab. sudo editor /etc/nginx/sites-available/gitlab -**Note:** If you want to use https, replace the `gitlab` nginx config with `gitlab-ssl`. +**Note:** If you want to use https, replace the `gitlab` nginx config with `gitlab-ssl`. See #using-https for more details. ### Restart @@ -334,6 +336,15 @@ Visit YOUR_SERVER in your web browser for your first GitLab login. The setup has ## Advanced Setup Tips +### Using HTTPS + +This is a retrospective of what is needed to configure in order to use GitLab with HTTPS: + +1. In `gitlab.yml` enable https by setting `https` option to `true` +1. In gitlab-shell `config.yml` provide paths to the certificates under `ca_file` and `ca_path options. +In case you are using self signed certificate set `self_signed_cert` to `true`. `gitlab_url` must point to the https host. +1. Use `gitlab-ssl` nginx config + ### Additional markup styles 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. For example, reStructuredText markup language support requires python-docutils: -- cgit v1.2.1 From fa9c39591c074d4766593f7ef93b91cbceb22c43 Mon Sep 17 00:00:00 2001 From: Marin Jankovski Date: Tue, 10 Jun 2014 12:57:50 +0200 Subject: Extract gitlab-shell configuration note to gitlab-shell section. --- doc/install/installation.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/doc/install/installation.md b/doc/install/installation.md index eebc1a3e32e..5ce801dc399 100644 --- a/doc/install/installation.md +++ b/doc/install/installation.md @@ -240,7 +240,12 @@ GitLab Shell is an ssh access and repository management software developed speci # Run the installation task for gitlab-shell (replace `REDIS_URL` if needed): sudo -u git -H bundle exec rake gitlab:shell:install[v1.9.5] REDIS_URL=redis://localhost:6379 RAILS_ENV=production - # By default, the gitlab-shell config is generated from your main gitlab config. You can review (and modify) it as follows: + # By default, the gitlab-shell config is generated from your main gitlab config. + # + # Note: When using GitLab with HTTPS, provide paths to the certificates under `ca_file` and `ca_path options. + # In case you are using self signed certificate set `self_signed_cert` to `true`. `gitlab_url` must point to the https host. + # + # You can review (and modify) the gitlab-shell config as follows: sudo -u git -H editor /home/git/gitlab-shell/config.yml ### Initialize Database and Activate Advanced Features @@ -341,9 +346,9 @@ Visit YOUR_SERVER in your web browser for your first GitLab login. The setup has This is a retrospective of what is needed to configure in order to use GitLab with HTTPS: 1. In `gitlab.yml` enable https by setting `https` option to `true` -1. In gitlab-shell `config.yml` provide paths to the certificates under `ca_file` and `ca_path options. -In case you are using self signed certificate set `self_signed_cert` to `true`. `gitlab_url` must point to the https host. -1. Use `gitlab-ssl` nginx config +1. In gitlab-shell `config.yml` check if certificate options `ca_file`, `ca_path options` or `self_signed_cert` are set. +`gitlab_url` must point to the https host. +1. Use the `gitlab-ssl` nginx config. ### Additional markup styles -- cgit v1.2.1