|
1 | 1 | Configuring Mattermost Server
|
2 | 2 | =============================
|
3 | 3 |
|
4 |
| -1. Navigate to ``https://mattermost.example.com`` and create a team and user. |
| 4 | +Create the System Admin user and set up Mattermost for general use. |
5 | 5 |
|
6 |
| - The first user in the system is automatically granted the ``system_admin`` role, which gives you access to the System Console. |
| 6 | +1. Open a browser and navigate to your Mattermost instance. For example, if the IP address of the Mattermost server is ``10.10.10.2`` then go to http://10.10.10.2:8065. |
7 | 7 |
|
8 |
| -2. Open the System Console. Click your username at the top left of navigation panel. In the menu that opens, click **System Console**. |
| 8 | +2. Create the first team and user. The first user in the system has the ``system_admin`` role, which gives you access to the System Console. |
9 | 9 |
|
10 |
| -3. You must set the `Site URL <https://docs.mattermost.com/administration/config-settings.html#site-url>`_: |
11 |
| - a. In the System Console, click **General > Configuration**. |
12 |
| - b. In the **Site URL** field, set the URL that users point their browsers at. For example, ``https://example.com``. |
| 10 | +3. Open the System Console. To open the System Console, click your username at the top of the navigation panel, and in the menu that opens, click **System Console**. |
13 | 11 |
|
14 |
| -4. Setup an SMTP email service. Click **Notifications > Email** and make the following changes. The example below assumes AmazonSES. |
| 12 | +4. Set the Site URL: |
| 13 | + a. In the GENERAL section of the System Console, click **Configuration**. |
| 14 | + b. In the **Site URL** field, set the URL that users point their browsers at. For example, *https://mattermost.example.com*. If you are using HTTPS, make sure that you set up TLS, either on Mattermost Server or on a proxy. |
15 | 15 |
|
16 |
| - a. Set **Enable Email Notifications** to ``true`` |
17 |
| - b. Set **Notification Display Name** to ``No-Reply`` |
18 |
| - c. Set **Notification From Address** to ``mattermost@example.com`` |
19 |
| - d. Set **SMTP Server Username** to ``[YOUR_SMTP_USERNAME]`` |
20 |
| - e. Set **SMTP Server Password** to ``[YOUR_SMTP_PASSWORD]`` |
21 |
| - f. Set **SMTP Server** to ``email-smtp.us-east-1.amazonaws.com`` |
22 |
| - g. Set **SMTP Server Port** to ``465`` |
23 |
| - h. Set **Connection Security** to ``TLS`` |
24 |
| - i. Save the Settings |
| 16 | +5. Set up email notifications. |
25 | 17 |
|
26 |
| -5. Click **Files > Storage** and change **Local Storage Directory** from ``./data/`` to ``/opt/mattermost/data`` |
| 18 | + a. In the NOTIFICATIONS section of the System Console, click **Email** and make the following changes: |
27 | 19 |
|
28 |
| -6. Click **General > Logging** and set **Output logs to console** to ``false`` |
| 20 | + - Set **Enable Email Notifications** to *true* |
| 21 | + - Set **Notification Display Name** to *No-Reply* |
| 22 | + - Set **Notification From Address** to *{your-domain-name}* For example, *example.com* |
| 23 | + - Set **SMTP Server Username** to *{SMTP-username}* For example, *admin@example.com* |
| 24 | + - Set **SMTP Server Password** to *{SMTP-password}* |
| 25 | + - Set **SMTP Server** to *{SMTP-server}* For example, *mail.example.com* |
| 26 | + - Set **SMTP Server Port** to *465* |
| 27 | + - Set **Connection Security** to *TLS* or *STARTTLS*, depending on what the SMTP server accepts. |
| 28 | + |
| 29 | + b. Click **Test Connection**. |
| 30 | + |
| 31 | + c. After your connection is working, click **Save**. |
| 32 | + |
| 33 | +6. Set up the file and image storage location. |
| 34 | + |
| 35 | + .. note:: |
| 36 | + 1. Files and images that users attach to their messages are not stored in the database. Instead, they are stored in a location that you specify. You can store the files on the local file system or in Amazon S3. |
| 37 | + 2. Make sure that the location has enough free space. The amount of storage that's required depends on the number of users and on the number and size of files that users attach to messages. |
| 38 | + |
| 39 | + a. In the FILES section of the System Console, click **Storage**. |
| 40 | + b. If you store the files locally, set **File Storage System** to *Local File System*, and then either accept the default for the **Local Storage Directory** or enter a location. The location must be a directory that exists and has write permissions for the Mattermost server. It can be an absolute path or a relative path. Relative paths are relative to the ``mattermost`` directory. |
| 41 | + c. If you store the files on Amazon S3, set **File Storage System** to *Amazon S3* and enter the appropriate values for your Amazon account. |
| 42 | + d. Click **Save**. |
| 43 | + |
| 44 | +7. Review the other settings in the System Console to make sure everything is as you want it. |
29 | 45 |
|
30 |
| -7. Feel free to modify other settings. |
31 | 46 | 8. Restart the Mattermost Service.
|
32 | 47 |
|
33 |
| - ``sudo restart mattermost`` |
| 48 | + On Ubuntu 14.04 and RHEL 6.6: ``sudo restart mattermost`` |
| 49 | + |
| 50 | + On Ubuntu 16.04 and RHEL 7.1: ``sudo systemctl restart mattermost`` |
0 commit comments