From 19a049ece9e350623e3adb141298c00344cab02d Mon Sep 17 00:00:00 2001 From: Douwe Maan Date: Wed, 19 Aug 2015 17:43:36 -0700 Subject: Make documentation clearer. --- doc/install/installation.md | 2 +- doc/reply_by_email/README.md | 19 ++++++++++++++++++- 2 files changed, 19 insertions(+), 2 deletions(-) (limited to 'doc') diff --git a/doc/install/installation.md b/doc/install/installation.md index 202704088a6..c75e1d87862 100644 --- a/doc/install/installation.md +++ b/doc/install/installation.md @@ -370,7 +370,7 @@ Make sure to edit the config file to match your setup: # domain name of your host serving GitLab. # If using Ubuntu default nginx install: # either remove the default_server from the listen line - # or else rm -f /etc/sites-enabled/default + # or else sudo rm -f /etc/nginx/sites-enabled/default sudo editor /etc/nginx/sites-available/gitlab **Note:** If you want to use HTTPS, replace the `gitlab` Nginx config with `gitlab-ssl`. See [Using HTTPS](#using-https) for HTTPS configuration details. diff --git a/doc/reply_by_email/README.md b/doc/reply_by_email/README.md index fffc120d2bb..e168e9a17e4 100644 --- a/doc/reply_by_email/README.md +++ b/doc/reply_by_email/README.md @@ -10,8 +10,17 @@ In this example, we'll use the Gmail address `gitlab-replies@gmail.com`. If you' ### Installations from source +1. Go to the GitLab installation directory: + + ```sh + cd /home/git/gitlab + ``` 1. Find the `reply_by_email` section in `config/gitlab.yml`, enable the feature and enter the email address including a placeholder for the `reply_key`: + + ```sh + sudo editor config/gitlab.yml + ``` ```yaml reply_by_email: @@ -24,11 +33,15 @@ In this example, we'll use the Gmail address `gitlab-replies@gmail.com`. If you' 2. Find `config/mail_room.yml.example` and copy it to `config/mail_room.yml`: ```sh - cp config/mail_room.yml.example config/mail_room.yml + sudo cp config/mail_room.yml.example config/mail_room.yml ``` 3. Uncomment the configuration options in `config/mail_room.yml` and fill in the details for your specific IMAP server and email account: + ```sh + sudo editor config/mail_room.yml + ``` + ```yaml :mailboxes: - @@ -66,6 +79,10 @@ In this example, we'll use the Gmail address `gitlab-replies@gmail.com`. If you' 5. Edit `/etc/default/gitlab` to enable `mail_room`: + ```sh + sudo editor /etc/default/gitlab + ``` + ```sh mail_room_enabled=true ``` -- cgit v1.2.3