Skip to content

Commit c342c7d

Browse files
authored
Merge pull request #58 from writefreely/smtp
Include config instructions on SMTP email provider
2 parents 992142e + 0df7185 commit c342c7d

File tree

1 file changed

+32
-8
lines changed

1 file changed

+32
-8
lines changed

admin/config.md

Lines changed: 32 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -89,17 +89,41 @@ These fields are experimental and subject to change with little notice. _Using t
8989

9090
## Email
9191

92-
Configure the `[email]` section to enable password resets and other email-based functionality. Today, WriteFreely only supports [Mailgun](https://mailgun.com) as a sending provider.
92+
Configure the `[email]` section to enable password resets and other email-based functionality. With a provider fully configured, your instance will have the following email-based functionality automatically enabled:
9393

94-
| Field | Description | Example value |
95-
|-------------------|----------------------------|--------------------|
96-
| `domain` | Domain to send emails from | writeasletters.com |
97-
| `mailgun_private` | Mailgun private key | _key-..._ |
94+
* **Forgot Password functionality**. Users will find a link on the _login_ page that allows them to reset their password via email.
95+
* **Email subscriptions / newsletters**. Blog authors can let readers subscribe to their blog posts via email, and optionally supply an email address where readers can privately reply. Authors will also have access to their subscribers list.
9896

99-
With both configuration values set, your instance will have the following email-based functionality automatically enabled:
97+
WriteFreely supports configuring either a generic bulk email sender via SMTP, or [Mailgun](https://mailgun.com).
10098

101-
* **Forgot Password functionality**. Users will find a link on the _login_ page that allows them to reset their password via email.
102-
* **Email subscriptions / newsletters**. Blog authors can optionally let readers subscribe to their blog posts via email, and optionally supply an email address where readers can privately reply. Authors will also have access to their subscribers list.
99+
For all providers, you'll set the following value:
100+
101+
| Field | Description | Example value |
102+
|-------------------|-------------------------------------------------------------------------------------|--------------------|
103+
| `domain` | Domain where all of your messages will originate (can be different from web domain) | writeasletters.com |
104+
105+
Next, supply additional configuration values depending on your bulk email provider.
106+
107+
### SMTP
108+
109+
Configure these values to send via SMTP and use any provider you'd like.
110+
111+
| Field | Description | Example value |
112+
|-------------------------|---------------------------|---------------|
113+
| `smtp_host` | SMTP provider hostname | example.com |
114+
| `smtp_port` | SMTP provider port number | 587 |
115+
| `smtp_username` | SMTP provider username | username |
116+
| `smtp_password` | SMTP provider password | password |
117+
| `smtp_enable_start_tls` | Whether to use STARTTLS | `true` |
118+
119+
### Mailgun
120+
121+
Supply these values to use Mailgun as your sending provider.
122+
123+
| Field | Description | Example value |
124+
|-------------------|-----------------------------------------|--------------------|
125+
| `mailgun_private` | Mailgun private key | _key-..._ |
126+
| `mailgun_europe` | Whether to use European Mailgun servers | `true` |
103127

104128
## OAuth
105129

0 commit comments

Comments
 (0)