Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDouwe Maan <douwe@gitlab.com>2015-09-21 10:46:47 +0300
committerDouwe Maan <douwe@gitlab.com>2015-09-21 11:35:37 +0300
commitee028d9d60522f8993a0b2429ac8a0631d59229a (patch)
tree5e028593ff4394df287de8f61824c8d004a81688 /doc
parent11bbc06b4bbcb678f3ee6b8f1d143ed86d25a76c (diff)
Rename reply_by_email to incoming_email to prepare for the future.
Diffstat (limited to 'doc')
-rw-r--r--doc/README.md2
-rw-r--r--doc/incoming_email/README.md (renamed from doc/reply_by_email/README.md)48
-rw-r--r--doc/incoming_email/postfix.md (renamed from doc/reply_by_email/postfix.md)52
3 files changed, 51 insertions, 51 deletions
diff --git a/doc/README.md b/doc/README.md
index f5f1f56b1e2..5f38086b8e3 100644
--- a/doc/README.md
+++ b/doc/README.md
@@ -46,7 +46,7 @@
- [System hooks](system_hooks/system_hooks.md) Notifications when users, projects and keys are changed.
- [Update](update/README.md) Update guides to upgrade your installation.
- [Welcome message](customization/welcome_message.md) Add a custom welcome message to the sign-in page.
-- [Reply by email](reply_by_email/README.md) Allow users to comment on issues and merge requests by replying to notification emails.
+- [Reply by email](incoming_email/README.md) Allow users to comment on issues and merge requests by replying to notification emails.
- [Migrate GitLab CI to CE/EE](migrate_ci_to_ce/README.md) Follow this guide to migrate your existing GitLab CI data to GitLab CE/EE.
### Administrator documentation
diff --git a/doc/reply_by_email/README.md b/doc/incoming_email/README.md
index e9187298d79..2a94bc07f2e 100644
--- a/doc/reply_by_email/README.md
+++ b/doc/incoming_email/README.md
@@ -12,24 +12,24 @@ 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-incoming@gmail.com`.
### Omnibus package installations
-1. Find the `reply_by_email` section in `/etc/gitlab/gitlab.rb`, enable the feature, enter the email address including a placeholder for the `reply_key` and fill in the details for your specific IMAP server and email account:
+1. Find the `incoming_email` section in `/etc/gitlab/gitlab.rb`, enable the feature, enter the email address including a placeholder for the `key` and fill in the details for your specific IMAP server and email account:
```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. Usually "inbox".
+ gitlab_rails['incoming_email_enabled'] = true
+ gitlab_rails['incoming_email_address'] = "gitlab-incoming+%{key}@gmail.com"
+ gitlab_rails['incoming_email_host'] = "imap.gmail.com" # IMAP server host
+ gitlab_rails['incoming_email_port'] = 993 # IMAP server port
+ gitlab_rails['incoming_email_ssl'] = true # Whether the IMAP server uses SSL
+ gitlab_rails['incoming_email_email'] = "gitlab-incoming@gmail.com" # Email account username. Usually the full email address.
+ gitlab_rails['incoming_email_password'] = "password" # Email account password
+ gitlab_rails['incoming_email_mailbox_name'] = "inbox" # The name of the mailbox where incoming mail will end up. Usually "inbox".
```
- As mentioned, the part after `+` in the address is ignored, and any email sent here will end up in the mailbox for `gitlab-replies@gmail.com`.
+ As mentioned, the part after `+` in the address is ignored, and any email sent here will end up in the mailbox for `gitlab-incoming@gmail.com`.
1. Reconfigure GitLab for the changes to take effect:
@@ -40,7 +40,7 @@ In this example, we'll use the Gmail address `gitlab-replies@gmail.com`.
1. Verify that everything is configured correctly:
```sh
- sudo gitlab-rake gitlab:reply_by_email:check
+ sudo gitlab-rake gitlab:incoming_email:check
```
1. Reply by email should now be working.
@@ -53,19 +53,19 @@ In this example, we'll use the Gmail address `gitlab-replies@gmail.com`.
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`:
+1. Find the `incoming_email` section in `config/gitlab.yml`, enable the feature and enter the email address including a placeholder for the `key`:
```sh
sudo editor config/gitlab.yml
```
```yaml
- reply_by_email:
+ incoming_email:
enabled: true
- address: "gitlab-replies+%{reply_key}@gmail.com"
+ address: "gitlab-incoming+%{key}@gmail.com"
```
- As mentioned, the part after `+` in the address is ignored, and any email sent here will end up in the mailbox for `gitlab-replies@gmail.com`.
+ As mentioned, the part after `+` in the address is ignored, and any email sent here will end up in the mailbox for `gitlab-incoming@gmail.com`.
2. Copy `config/mail_room.yml.example` to `config/mail_room.yml`:
@@ -89,7 +89,7 @@ In this example, we'll use the Gmail address `gitlab-replies@gmail.com`.
# Whether the IMAP server uses SSL
:ssl: true
# Email account username. Usually the full email address.
- :email: "gitlab-replies@gmail.com"
+ :email: "gitlab-incoming@gmail.com"
# Email account password
:password: "[REDACTED]"
# The name of the mailbox where incoming mail will end up. Usually "inbox".
@@ -125,7 +125,7 @@ In this example, we'll use the Gmail address `gitlab-replies@gmail.com`.
7. Verify that everything is configured correctly:
```sh
- sudo -u git -H bundle exec rake gitlab:reply_by_email:check RAILS_ENV=production
+ sudo -u git -H bundle exec rake gitlab:incoming_email:check RAILS_ENV=production
```
8. Reply by email should now be working.
@@ -134,15 +134,15 @@ In this example, we'll use the Gmail address `gitlab-replies@gmail.com`.
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`:
+1. Find the `incoming_email` section in `config/gitlab.yml`, enable the feature and enter the email address including a placeholder for the `key`:
```yaml
- reply_by_email:
+ incoming_email:
enabled: true
- address: "gitlab-replies+%{reply_key}@gmail.com"
+ address: "gitlab-incoming+%{key}@gmail.com"
```
- As mentioned, the part after `+` is ignored, and this will end up in the mailbox for `gitlab-replies@gmail.com`.
+ As mentioned, the part after `+` is ignored, and this will end up in the mailbox for `gitlab-incoming@gmail.com`.
2. Copy `config/mail_room.yml.example` to `config/mail_room.yml`:
@@ -162,7 +162,7 @@ In this example, we'll use the Gmail address `gitlab-replies@gmail.com`.
# Whether the IMAP server uses SSL
:ssl: true
# Email account username. Usually the full email address.
- :email: "gitlab-replies@gmail.com"
+ :email: "gitlab-incoming@gmail.com"
# Email account password
:password: "[REDACTED]"
# The name of the mailbox where incoming mail will end up. Usually "inbox".
@@ -197,7 +197,7 @@ In this example, we'll use the Gmail address `gitlab-replies@gmail.com`.
7. Verify that everything is configured correctly:
```sh
- bundle exec rake gitlab:reply_by_email:check RAILS_ENV=development
+ bundle exec rake gitlab:incoming_email:check RAILS_ENV=development
```
8. Reply by email should now be working.
diff --git a/doc/reply_by_email/postfix.md b/doc/incoming_email/postfix.md
index c0ac59bb922..09c5804cb77 100644
--- a/doc/reply_by_email/postfix.md
+++ b/doc/incoming_email/postfix.md
@@ -2,7 +2,7 @@
This document will take you through the steps of setting up a basic Postfix mail server with IMAP authentication on Ubuntu, to be used with Reply by email.
-The instructions make the assumption that you will be using the email address `replies@gitlab.example.com`, that is, username `replies` on host `gitlab.example.com`. Don't forget to change it to your actual host when executing the example code snippets.
+The instructions make the assumption that you will be using the email address `incoming@gitlab.example.com`, that is, username `incoming` on host `gitlab.example.com`. Don't forget to change it to your actual host when executing the example code snippets.
## Configure your server firewall
@@ -27,16 +27,16 @@ The instructions make the assumption that you will be using the email address `r
## Create user
-1. Create a user for replies.
+1. Create a user for incoming.
```sh
- sudo useradd -m -s /bin/bash replies
+ sudo useradd -m -s /bin/bash incoming
```
1. Set a password for this user.
```sh
- sudo passwd replies
+ sudo passwd incoming
```
Be sure not to forget this, you'll need it later.
@@ -70,12 +70,12 @@ The instructions make the assumption that you will be using the email address `r
sudo postfix start
```
-1. Send the new `replies` user a dummy email to test SMTP, by entering the following into the SMTP prompt:
+1. Send the new `incoming` user a dummy email to test SMTP, by entering the following into the SMTP prompt:
```
ehlo localhost
mail from: root@localhost
- rcpt to: replies@localhost
+ rcpt to: incoming@localhost
data
Subject: Re: Some issue
@@ -86,17 +86,17 @@ The instructions make the assumption that you will be using the email address `r
(Note: The `.` is a literal period on its own line)
-1. Check if the `replies` user received the email:
+1. Check if the `incoming` user received the email:
```sh
- su - replies
+ su - incoming
mail
```
You should see output like this:
```
- "/var/mail/replies": 1 message 1 unread
+ "/var/mail/incoming": 1 message 1 unread
>U 1 root@localhost 59/2842 Re: Some issue
```
@@ -106,7 +106,7 @@ The instructions make the assumption that you will be using the email address `r
q
```
-1. Log out of the `replies` account and go back to being `root`:
+1. Log out of the `incoming` account and go back to being `root`:
```sh
logout
@@ -131,18 +131,18 @@ Courier, which we will install later to add IMAP authentication, requires mailbo
1. Test the new setup:
1. Follow steps 1 and 2 of _[Test the out-of-the-box setup](#test-the-out-of-the-box-setup)_.
- 2. Check if the `replies` user received the email:
+ 2. Check if the `incoming` user received the email:
```sh
- su - replies
- MAIL=/home/replies/Maildir
+ su - incoming
+ MAIL=/home/incoming/Maildir
mail
```
You should see output like this:
```
- "/home/replies/Maildir": 1 message 1 unread
+ "/home/incoming/Maildir": 1 message 1 unread
>U 1 root@localhost 59/2842 Re: Some issue
```
@@ -152,7 +152,7 @@ Courier, which we will install later to add IMAP authentication, requires mailbo
q
```
-1. Log out of the `replies` account and go back to being `root`:
+1. Log out of the `incoming` account and go back to being `root`:
```sh
logout
@@ -221,12 +221,12 @@ Courier, which we will install later to add IMAP authentication, requires mailbo
If you get a `Connection refused` error instead, make sure your firewall is setup to allow inbound traffic on port 25.
- 1. Send the `replies` user a dummy email to test SMTP, by entering the following into the SMTP prompt:
+ 1. Send the `incoming` user a dummy email to test SMTP, by entering the following into the SMTP prompt:
```
ehlo gitlab.example.com
mail from: root@gitlab.example.com
- rcpt to: replies@gitlab.example.com
+ rcpt to: incoming@gitlab.example.com
data
Subject: Re: Some issue
@@ -237,18 +237,18 @@ Courier, which we will install later to add IMAP authentication, requires mailbo
(Note: The `.` is a literal period on its own line)
- 1. Check if the `replies` user received the email:
+ 1. Check if the `incoming` user received the email:
```sh
- su - replies
- MAIL=/home/replies/Maildir
+ su - incoming
+ MAIL=/home/incoming/Maildir
mail
```
You should see output like this:
```
- "/home/replies/Maildir": 1 message 1 unread
+ "/home/incoming/Maildir": 1 message 1 unread
>U 1 root@gitlab.example.com 59/2842 Re: Some issue
```
@@ -258,7 +258,7 @@ Courier, which we will install later to add IMAP authentication, requires mailbo
q
```
- 1. Log out of the `replies` account and go back to being `root`:
+ 1. Log out of the `incoming` account and go back to being `root`:
```sh
logout
@@ -281,13 +281,13 @@ Courier, which we will install later to add IMAP authentication, requires mailbo
- OK [CAPABILITY IMAP4rev1 UIDPLUS CHILDREN NAMESPACE THREAD=ORDEREDSUBJECT THREAD=REFERENCES SORT QUOTA IDLE ACL ACL2=UNION] Courier-IMAP ready. Copyright 1998-2011 Double Precision, Inc. See COPYING for distribution information.
```
- 1. Sign in as the `replies` user to test IMAP, by entering the following into the IMAP prompt:
+ 1. Sign in as the `incoming` user to test IMAP, by entering the following into the IMAP prompt:
```
- a login replies PASSWORD
+ a login incoming PASSWORD
```
- Replace PASSWORD with the password you set on the `replies` user earlier.
+ Replace PASSWORD with the password you set on the `incoming` user earlier.
You should see output like this:
@@ -307,4 +307,4 @@ If all the tests were successful, Postfix is all set up and ready to receive ema
---------
-_This document was adapted from https://help.ubuntu.com/community/PostfixBasicSetupHowto, by contributors to the Ubuntu documentation wiki._ \ No newline at end of file
+_This document was adapted from https://help.ubuntu.com/community/PostfixBasicSetupHowto, by contributors to the Ubuntu documentation wiki._