writefreely/docs
2
0
Fork 0
mirror of https://github.com/writefreely/documentation.git synced 2024-11-14 15:01:02 +00:00
Code Issues Releases Wiki Activity

Add more details to Email section

Browse Source
This commit is contained in:
Matt Baer 2024-02-03 11:39:53 +01:00
parent 5906c72660
commit cd5b82fa44
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
admin/config.md
View File

@ -89,13 +89,18 @@ These fields are experimental and subject to change with little notice. _Using t
## Email
Configure the `[email]` section to enable password resets and other email-based functionality. Today, WriteFreely only supports Mailgun as a sending provider.
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.
| Field | Description | Example value |
|-------------------|----------------------------|--------------------|
| `domain` | Domain to send emails from | writeasletters.com |
| `mailgun_private` | Mailgun private key | _key-..._ |
With both configuration values set, your instance will have the following email-based functionality automatically enabled:
* **Forgot Password functionality**. Users will find a link on the _login_ page that allows them to reset their password via email.
* **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.
## OAuth
There are several possible OAuth configuration blocks for different implementations.