diff options
Diffstat (limited to 'doc/install/SMTP-Email-Setup.md')
| -rw-r--r-- | doc/install/SMTP-Email-Setup.md | 81 |
1 files changed, 36 insertions, 45 deletions
diff --git a/doc/install/SMTP-Email-Setup.md b/doc/install/SMTP-Email-Setup.md index 8bf094714..4e06d2f99 100644 --- a/doc/install/SMTP-Email-Setup.md +++ b/doc/install/SMTP-Email-Setup.md @@ -1,55 +1,46 @@ ## SMTP Email Setup -In some product evaluation setups, email is intentionally bypassed by setting `SendEmailNotifications=false`. This option allows account creation and system operation without having to set up an email service (e.g. no email verification is required for account creation). This also means neither email notifications nor password reset by email are available. - -To enable email, turn this option on by setting `SendEmailNotifications=true` and configuring an SMTP email service as follows: - -1. **Set up an SMTP email sending service.** (If you already have credentials for a SMTP server you can skip this step.) - 1. [Setup Amazon Simple Email Service](https://console.aws.amazon.com/ses) - 2. From the `SMTP Settings` menu click `Create My SMTP Credentials` - 3. Copy the `Server Name`, `Port`, `SMTP Username`, and `SMTP Password` - 4. From the `Domains` menu setup and verify a new domain. It it also a good practice to enable `Generate DKIM Settings` for this domain. - 5. Choose an email address like `mattermost@example.com` for Mattermost to send emails from. - 6. Test sending an email from `mattermost@example.com` by clicking the `Send a Test Email` button and verify everything appears to be working correctly. -2. **Modify the Mattermost configuration file config.json or config_docker.json with the SMTP information.** - 1. If you're running Mattermost on Amazon Beanstalk you can shell into the instance with the following commands - 2. `ssh ec2-user@[domain for the docker instance]` - 3. `sudo gpasswd -a ec2-user docker` - 4. Retrieve the name of the container with `sudo docker ps` - 5. `sudo docker exec -ti container_name /bin/bash` -3. **Edit the config file `vi /config_docker.json` with the settings you captured from the step above.** - 1. See an example below and notice `SendEmailNotifications` has been set to `true` - ``` - "EmailSettings": { - "EnableSignUpWithEmail": true, - "SendEmailNotifications": true, - "RequireEmailVerification": true, - "FeedbackName": "No-Reply", - "FeedbackEmail": "mattermost@example.com", - "SMTPUsername": "AFIADTOVDKDLGERR", - "SMTPPassword": "DFKJoiweklsjdflkjOIGHLSDFJewiskdjf", - "SMTPServer": "email-smtp.us-east-1.amazonaws.com", - "SMTPPort": "465", - "ConnectionSecurity": "TLS", - "InviteSalt": "bjlSR4QqkXFBr7TP4oDzlfZmcNuH9YoS", - "PasswordResetSalt": "vZ4DcKyVVRlKHHJpexcuXzojkE5PZ5eL", - "ApplePushServer": "", - "ApplePushCertPublic": "", - "ApplePushCertPrivate": "" - }, - ``` -4. **Restart Mattermost** - 1. Find the process id with `ps -A` and look for the process named `platform` - 2. Kill the process `kill pid` - 3. The service should restart automatically. Verify the Mattermost service is running with `ps -A` - 4. Current logged in users will not be affected, but upon logging out or session expiration users will be required to verify their email address. +In product evaluation setups with single-container Docker instances, email is intentionally disabled. This allows account creation and system operation without having to set up email, but it also means email notification and password reset functionality aren't available. + +### How to enable email + +To enable email, configure an SMTP email service as follows: + +1. **Set up an SMTP email sending service** (if you don't yet have an SMTP service with credentials) + 1. Any SMTP email service can be used, you just need the following information: `Server Name`, `Port`, `SMTP Username`, and `SMTP Password`. + 2. If you don't have an SMTP service, here are simple instructions to set one up with [Amazon Simple Email Service (SES)](https://aws.amazon.com/ses/): + 2. Go to [Amazon SES console](https://console.aws.amazon.com/ses) then `SMTP Settings > Create My SMTP Credentials` + 3. Copy the `Server Name`, `Port`, `SMTP Username`, and `SMTP Password` for Step 2 below. + 4. From the `Domains` menu set up and verify a new domain, then enable `Generate DKIM Settings` for the domain. + 5. Choose an sender address like `mattermost@example.com` and click `Send a Test Email` to verify setup is working correctly. +2. **Configure SMTP settings** + 1. Open the **System Console** by logging into an existing team and accessing "System Console" from the main menu. + 1. Alternatively, if a team doesn't yet exist, go to `http://dockerhost:8065/` in your browser, create a team, then from the main menu click **System Console** + 2. Go to the **Email Settings** tab and configure the following: + 1. **Allow Sign Up With Email:** `true` + 2. **Send Email Notifications:** `true` + 3. **Require Email Verification:** `true` + 4. **Notification Display Name:** Display name on email account sending notifications + 5. **Notification Email Address:** Email address displayed on email account used to send notifications + 6. **SMTP Username**: `SMTP Username` from Step 1 + 7. **SMTP Password**: `SMTP Password` from Step 1 + 8. **SMTP Server**: `SMTP Server` from Step 1 + 9. **SMTP Port**: `SMTP Port` from Step 1 + 10. **Connection Security**: `TLS (Recommended)` + 11. Then click **Save** + +3. **Restart Mattermost** + 1. Use `ps -A` to find the process ID ("pid") for service named `platform` and stop it using `kill [pid]` + 2. The service should restart automatically. Run `ps -A` to verify the `platform` is running again + 3. Use the reset password page (E.g. _example.com/teamname/reset_password_) to test that email is now working by entering your email and clicking **Reset my password**. + 4. Note: The next time users log out, or when their session tokens expire, each will be required to verify their email address. ### Troubleshooting SMTP -If you have issues with your SMTP install, from your Mattermost team site go to the main menu and open `System Console > Logs` to look for error messages related to your setup. You can do a search for the error code to narrow down the issue. Sometimes ISPs require nuanced setups for SMTP and error codes can hint at how to make the proper adjustments. +If you have issues with your SMTP install, from your Mattermost team site go to the main menu and open **System Console -> Logs** to look for error messages related to your setup. You can do a search for the error code to narrow down the issue. Sometimes ISPs require nuanced setups for SMTP and error codes can hint at how to make the proper adjustments. -For example, if `System Console > Logs` has an error code reading: +For example, if **System Console -> Logs** has an error code reading: ``` Connection unsuccessful: Failed to add to email address - 554 5.7.1 <unknown[IP-ADDRESS]>: Client host rejected: Access denied |