summaryrefslogtreecommitdiffstats
path: root/doc/install/Troubleshooting-Email.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/install/Troubleshooting-Email.md')
-rw-r--r--doc/install/Troubleshooting-Email.md44
1 files changed, 36 insertions, 8 deletions
diff --git a/doc/install/Troubleshooting-Email.md b/doc/install/Troubleshooting-Email.md
index 0ddc807bb..b8e34de25 100644
--- a/doc/install/Troubleshooting-Email.md
+++ b/doc/install/Troubleshooting-Email.md
@@ -1,14 +1,42 @@
+### Mattermost Email Troubleshooting
-change settings via system console
+#### Update Email Settings in System Console
+* Login to Mattermost with an account that has the `system admin` role
+* Open the System Console by clicking on **...** > **System Console** > **Email Settings*
+ * Change **Send Email Notifications** to **true**
+ * Change **Require Email Verification** to **true**
+* Set **Notification Email Address** must be set and must be a valid email allowed as the **FROM** field on the email server. Some email servers will only allow certian accounts to send emails.
+* Set the **SMTP** fields based on your email service. Some known good samples are listed below.
+* If you fill in **SMTP Username** and **SMTP Password** then you must set **Connection Security** to **TLS** or to **STARTTLS**
+* Once you've filled in all the information please make sure to **Test Connection**
+* If the test failed please look in **OTHER** > **Logs** for any errors that look like `[EROR] /api/v1/admin/test_email ...`
-known good settings for providers:
-amazon ses
-postfix
-gmail
-hotmail
-sendgrid
+#### Known Good Sample Settings
+
+##### Amazon SES
+* Set **SMTP Username** to **AKIASKLDSKDIWEOWE**
+* Set **SMTP Password** to **AdskfjAKLSDJShflsdfjkakldADkjkjdfKAJDSlkjweiqQIWEOU**
+* Set **SMTP Server** to **email-smtp.us-east-1.amazonaws.com**
+* Set **SMTP Port** to **465**
+* Set **Connection Security** to **TLS**
+
+##### Postfix
+* Make sure Postfix is installed on the machine where Mattermost is installed
+* Set **SMTP Username** to **<empty>**
+* Set **SMTP Password** to **<empty>**
+* Set **SMTP Server** to **localhost**
+* Set **SMTP Port** to **25**
+* Set **Connection Security** to **<empty>**
+
+##### Gmail
+* Information needed
+
+##### Office 365
+* Information needed
+
+##### Hotmail
+* Information needed
-if you fill in a username/password you must use a secure connection like TLS or STARTTLS
test connection
check error logs