BigW Consortium Gitlab

postfix.md 7.98 KB
Newer Older
Douwe Maan committed
1 2 3 4
# Set up Postfix for Reply by email

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.

5
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.
Douwe Maan committed
6

7
## Configure your server firewall
Douwe Maan committed
8

9 10
1. Open up port 25 on your server so that people can send email into the server over SMTP.
2. If the mail server is different from the server running GitLab, open up port 143 on your server so that GitLab can read email from the server over IMAP.
Douwe Maan committed
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29

## Install packages

1. Install the `postfix` package if it is not installed already:

    ```sh
    sudo apt-get install postfix
    ```

    When asked about the environment, select 'Internet Site'. When asked to confirm the hostname, make sure it matches `gitlab.example.com`.

1. Install the `mailutils` package.

    ```sh
    sudo apt-get install mailutils
    ```

## Create user

Douwe Maan committed
30
1. Create a user for incoming email.
Douwe Maan committed
31 32

    ```sh
33
    sudo useradd -m -s /bin/bash incoming
Douwe Maan committed
34 35 36 37 38
    ```

1. Set a password for this user.

    ```sh
39
    sudo passwd incoming
Douwe Maan committed
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
    ```

    Be sure not to forget this, you'll need it later.

## Test the out-of-the-box setup

1. Connect to the local SMTP server:
    
    ```sh
    telnet localhost 25
    ```

    You should see a prompt like this:

    ```sh
    Trying 127.0.0.1...
    Connected to localhost.
    Escape character is '^]'.
    220 gitlab.example.com ESMTP Postfix (Ubuntu)
    ```

Douwe Maan committed
61
    If you get a `Connection refused` error instead, verify that `postfix` is running:
Douwe Maan committed
62 63 64 65 66 67 68 69 70 71 72

    ```sh
    sudo postfix status
    ```

    If it is not, start it:

    ```sh
    sudo postfix start
    ```

73
1. Send the new `incoming` user a dummy email to test SMTP, by entering the following into the SMTP prompt:
Douwe Maan committed
74 75 76 77
    
    ```
    ehlo localhost
    mail from: root@localhost
78
    rcpt to: incoming@localhost
Douwe Maan committed
79 80 81 82 83 84 85 86
    data
    Subject: Re: Some issue

    Sounds good!
    .
    quit
    ```

87 88 89 90 91 92
    _**Note:** The `.` is a literal period on its own line._

    _**Note:** If you receive an error after entering `rcpt to: incoming@localhost`
    then your Postfix `my_network` configuration is not correct. The error will
    say 'Temporary lookup failure'. See
    [Configure Postfix to receive email from the Internet](#configure-postfix-to-receive-email-from-the-internet)._
Douwe Maan committed
93

94
1. Check if the `incoming` user received the email:
Douwe Maan committed
95 96
    
    ```sh
97
    su - incoming
Douwe Maan committed
98 99 100 101 102 103
    mail
    ```

    You should see output like this:

    ```
104
    "/var/mail/incoming": 1 message 1 unread
Douwe Maan committed
105 106 107 108 109 110 111 112 113
    >U   1 root@localhost                           59/2842  Re: Some issue
    ```

    Quit the mail app:

    ```sh
    q
    ```

114
1. Log out of the `incoming` account and go back to being `root`:
Douwe Maan committed
115 116 117 118 119 120 121

    ```sh
    logout
    ```

## Configure Postfix to use Maildir-style mailboxes

Douwe Maan committed
122
Courier, which we will install later to add IMAP authentication, requires mailboxes to have the Maildir format, rather than mbox.
Douwe Maan committed
123 124 125 126 127 128 129 130 131 132

1. Configure Postfix to use Maildir-style mailboxes:
    
    ```sh
    sudo postconf -e "home_mailbox = Maildir/"
    ```

1. Restart Postfix:
    
    ```sh
Douwe Maan committed
133
    sudo /etc/init.d/postfix restart
Douwe Maan committed
134 135 136 137
    ```

1. Test the new setup:
    
Douwe Maan committed
138
    1. Follow steps 1 and 2 of _[Test the out-of-the-box setup](#test-the-out-of-the-box-setup)_.
139
    1. Check if the `incoming` user received the email:
Douwe Maan committed
140 141
    
        ```sh
142 143
        su - incoming
        MAIL=/home/incoming/Maildir
Douwe Maan committed
144 145 146 147 148 149
        mail
        ```

        You should see output like this:

        ```
150
        "/home/incoming/Maildir": 1 message 1 unread
Douwe Maan committed
151 152 153 154 155 156 157 158 159
        >U   1 root@localhost                           59/2842  Re: Some issue
        ```

        Quit the mail app:

        ```sh
        q
        ```

160 161 162 163 164 165
    _**Note:** If `mail` returns an error `Maildir: Is a directory` then your
    version of `mail` doesn't support Maildir style mailboxes. Install
    `heirloom-mailx` by running `sudo apt-get install heirloom-mailx`. Then,
    try the above steps again, substituting `heirloom-mailx` for the `mail`
    command._

166
1. Log out of the `incoming` account and go back to being `root`:
Douwe Maan committed
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184

    ```sh
    logout
    ```

## Install the Courier IMAP server
    
1. Install the `courier-imap` package:

    ```sh
    sudo apt-get install courier-imap
    ```

## Configure Postfix to receive email from the internet

1. Let Postfix know about the domains that it should consider local:
    
    ```sh
185
    sudo postconf -e "mydestination = gitlab.example.com, localhost.localdomain, localhost"
Douwe Maan committed
186 187 188 189 190 191 192 193 194 195 196 197 198
    ```

1. Let Postfix know about the IPs that it should consider part of the LAN:
    
    We'll assume `192.168.1.0/24` is your local LAN. You can safely skip this step if you don't have other machines in the same local network.
    
    ```sh
    sudo postconf -e "mynetworks = 127.0.0.0/8, 192.168.1.0/24"
    ```

1. Configure Postfix to receive mail on all interfaces, which includes the internet:
    
    ```sh
Douwe Maan committed
199
    sudo postconf -e "inet_interfaces = all"
Douwe Maan committed
200 201
    ```

Douwe Maan committed
202 203 204 205 206 207 208 209 210
1. Configure Postfix to use the `+` delimiter for sub-addressing:
    
    ```sh
    sudo postconf -e "recipient_delimiter = +"
    ```

1. Restart Postfix:
    
    ```sh
211
    sudo service postfix restart
Douwe Maan committed
212 213
    ```

Douwe Maan committed
214 215 216 217 218 219 220
## Test the final setup

1. Test SMTP under the new setup:
    
    1. Connect to the SMTP server:
        
        ```sh
221
        telnet gitlab.example.com 25
Douwe Maan committed
222 223 224 225 226 227
        ```

        You should see a prompt like this:

        ```sh
        Trying 123.123.123.123...
228
        Connected to gitlab.example.com.
Douwe Maan committed
229 230 231 232 233 234
        Escape character is '^]'.
        220 gitlab.example.com ESMTP Postfix (Ubuntu)
        ```

        If you get a `Connection refused` error instead, make sure your firewall is setup to allow inbound traffic on port 25.

235
    1. Send the `incoming` user a dummy email to test SMTP, by entering the following into the SMTP prompt:
Douwe Maan committed
236 237 238 239
        
        ```
        ehlo gitlab.example.com
        mail from: root@gitlab.example.com
240
        rcpt to: incoming@gitlab.example.com
Douwe Maan committed
241 242 243 244 245 246 247 248 249 250
        data
        Subject: Re: Some issue

        Sounds good!
        .
        quit
        ```

        (Note: The `.` is a literal period on its own line)

251
    1. Check if the `incoming` user received the email:
Douwe Maan committed
252 253
    
        ```sh
254 255
        su - incoming
        MAIL=/home/incoming/Maildir
Douwe Maan committed
256 257 258 259 260 261
        mail
        ```

        You should see output like this:

        ```
262
        "/home/incoming/Maildir": 1 message 1 unread
Douwe Maan committed
263 264 265 266 267 268 269 270 271
        >U   1 root@gitlab.example.com                           59/2842  Re: Some issue
        ```

        Quit the mail app:

        ```sh
        q
        ```

272
    1. Log out of the `incoming` account and go back to being `root`:
Douwe Maan committed
273 274 275 276 277 278 279 280 281 282

        ```sh
        logout
        ```

1. Test IMAP under the new setup:
    
    1. Connect to the IMAP server:
        
        ```sh
283
        telnet gitlab.example.com 143
Douwe Maan committed
284 285 286 287 288 289 290 291 292 293 294
        ```

        You should see a prompt like this:

        ```sh
        Trying 123.123.123.123...
        Connected to mail.example.gitlab.com.
        Escape character is '^]'.
        - 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.
        ```

295
    1. Sign in as the `incoming` user to test IMAP, by entering the following into the IMAP prompt:
Douwe Maan committed
296 297

        ```
298
        a login incoming PASSWORD
Douwe Maan committed
299 300
        ```

301
        Replace PASSWORD with the password you set on the `incoming` user earlier.
Douwe Maan committed
302 303 304 305 306 307 308 309 310 311 312 313 314 315 316

        You should see output like this:

        ```
        a OK LOGIN Ok.
        ```

    1. Disconnect from the IMAP server:

        ```sh
        a logout
        ```

## Done!

317
If all the tests were successful, Postfix is all set up and ready to receive email! Continue with the [Reply by email](./README.md) guide to configure GitLab.
Douwe Maan committed
318 319 320

---------

321
_This document was adapted from https://help.ubuntu.com/community/PostfixBasicSetupHowto, by contributors to the Ubuntu documentation wiki._