github-mirror/discourse
2
0
Fork 0
mirror of https://github.com/discourse/discourse.git synced 2024-11-23 06:04:11 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Update INSTALL-email.md

Browse Source
This commit is contained in:
Jeff Atwood 2016-04-29 03:17:48 -07:00
parent a544990f81
commit b18876265d
1 changed files with 13 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
docs/INSTALL-email.md
View File

@ -4,39 +4,29 @@ We strongly recommend using a dedicated email service. Email server setup and ma
The following are template configurations for email service providers who offer generous free plans that work for most communities. The following are template configurations for email service providers who offer generous free plans that work for most communities.
Use these values when you [edit your Discourse `app.yml` configuration file](https://github.com/discourse/discourse/blob/master/docs/INSTALL-cloud.md#edit-discourse-configuration): **Please note that in any email provider, you _must_ verify and use the subdomain, e.g. `discourse.example.com`. If you verify the domain only, e.g. `example.com`, mail will not be configured correctly.**
Enter these values when prompted by `./discourse-setup` per the [install guide](https://github.com/discourse/discourse/blob/master/docs/INSTALL-cloud.md#edit-discourse-configuration):
#### [SparkPost][sp] (100k emails/month) #### [SparkPost][sp] (100k emails/month)
```yml SMTP server address? smtp.sparkpostmail.com
DISCOURSE_SMTP_ADDRESS: smtp.sparkpostmail.com SMTP user name? SMTP_Injection
DISCOURSE_SMTP_USER_NAME: SMTP_Injection SMTP password? [Any API key with Send via SMTP permission]
DISCOURSE_SMTP_PASSWORD: [Any API key with Send via SMTP permission]
```
If not using **the exact** domain you verified (e.g. you're using a subdomain of it), you must change the default `from` email to match the sending domain. Uncomment (and update with your sending domain) this line in `app.yml`:
```yml
- exec: rails r "SiteSetting.notification_email='info@unconfigured.discourse.org'"
```
#### [SendGrid][sg] (12k emails/month) #### [SendGrid][sg] (12k emails/month)
```yml SMTP server address? smtp.sendgrid.net
DISCOURSE_SMTP_ADDRESS: smtp.sendgrid.net SMTP user name? apikey
DISCOURSE_SMTP_USER_NAME: apikey SMTP password? [SendGrid API Key]
DISCOURSE_SMTP_PASSWORD: [SendGrid API Key]
```
We recommend creating an [API Key][sg2] instead of using your SendGrid username and password. We recommend creating an [API Key][sg2] instead of using your SendGrid username and password.
#### [Mailgun][gun] (10k emails/month) #### [Mailgun][gun] (10k emails/month)
SMTP server address? smtp.mailgun.org
```yml SMTP user name? [SMTP credentials for your domain under domains tab]
DISCOURSE_SMTP_ADDRESS: smtp.mailgun.org SMTP password? [SMTP credentials for your domain under domains tab]
DISCOURSE_SMTP_USER_NAME: [SMTP credentials for your domain under Mailgun domains tab]
DISCOURSE_SMTP_PASSWORD: [SMTP credentials for your domain under Mailgun domains tab]
```
#### [Mailjet][jet] (6k emails/month) #### [Mailjet][jet] (6k emails/month)