summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarin Jankovski <maxlazio@gmail.com>2015-08-27 10:45:03 +0200
committerMarin Jankovski <maxlazio@gmail.com>2015-08-27 10:45:03 +0200
commit232422f828116d8b2551d63fbd511abc5148ec2e (patch)
treecf15e55629398edec118a8e493bc8eaf497ea719
parentf197785495e83c996150b05d9bc3ce1effcc5a68 (diff)
downloadgitlab-ce-232422f828116d8b2551d63fbd511abc5148ec2e.tar.gz
Add omnibus-gitlab configuration example.
-rw-r--r--doc/reply_by_email/README.md39
1 files changed, 31 insertions, 8 deletions
diff --git a/doc/reply_by_email/README.md b/doc/reply_by_email/README.md
index b33303c7be8..f1dcef5de2d 100644
--- a/doc/reply_by_email/README.md
+++ b/doc/reply_by_email/README.md
@@ -12,7 +12,7 @@ To set up a basic Postfix mail server with IMAP access on Ubuntu, follow [these
## Set it up
-In this example, we'll use the Gmail address `gitlab-replies@gmail.com`.
+In this example, we'll use the Gmail address `gitlab-replies@gmail.com`.
### Installations from source
@@ -27,7 +27,7 @@ In this example, we'll use the Gmail address `gitlab-replies@gmail.com`.
```sh
sudo editor config/gitlab.yml
```
-
+
```yaml
reply_by_email:
enabled: true
@@ -37,7 +37,7 @@ In this example, we'll use the Gmail address `gitlab-replies@gmail.com`.
As mentioned, the part after `+` is ignored, and this will end up in the mailbox for `gitlab-replies@gmail.com`.
2. Copy `config/mail_room.yml.example` to `config/mail_room.yml`:
-
+
```sh
sudo cp config/mail_room.yml.example config/mail_room.yml
```
@@ -84,7 +84,7 @@ In this example, we'll use the Gmail address `gitlab-replies@gmail.com`.
```
6. Restart GitLab:
-
+
```sh
sudo service gitlab restart
```
@@ -99,14 +99,37 @@ In this example, we'll use the Gmail address `gitlab-replies@gmail.com`.
### Omnibus package installations
-TODO
+In `/etc/gitlab/gitlab.rb`:
+
+```ruby
+
+gitlab_rails['reply_by_email_enabled'] = true
+gitlab_rails['reply_by_email_address'] = "gitlab-replies+%{reply_key}@gmail.com"
+gitlab_rails['reply_by_email_host'] = "imap.gmail.com" # IMAP server host
+gitlab_rails['reply_by_email_port'] = 993 # IMAP server port
+gitlab_rails['reply_by_email_ssl'] = true # Whether the IMAP server uses SSL
+gitlab_rails['reply_by_email_email'] = "gitlab-replies@gmail.com" # Email account username. Usually the full email address.
+gitlab_rails['reply_by_email_password'] = "password" # Email account password
+gitlab_rails['reply_by_email_mailbox_name'] = "inbox" # The name of the mailbox where incoming mail will end up.
+```
+
+and run `sudo gitlab-ctl reconfigure` for changes to take effect.
+
+After reconfigure run has been successfully completed you will have the following commands available:
+
+```bash
+sudo gitlab-ctl status mailroom
+sudo gitlab-ctl stop mailroom
+sudo gitlab-ctl start mailroom
+sudo gitlab-ctl restart mailroom
+```
### Development
1. Go to the GitLab installation directory.
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`:
-
+
```yaml
reply_by_email:
enabled: true
@@ -116,7 +139,7 @@ TODO
As mentioned, the part after `+` is ignored, and this will end up in the mailbox for `gitlab-replies@gmail.com`.
2. Copy `config/mail_room.yml.example` to `config/mail_room.yml`:
-
+
```sh
sudo cp config/mail_room.yml.example config/mail_room.yml
```
@@ -158,7 +181,7 @@ TODO
```
6. Restart GitLab:
-
+
```sh
bundle exec foreman start
```