From cd5b82fa446e90475052c75fcce52d9ad5bd5c9b Mon Sep 17 00:00:00 2001 From: Matt Baer Date: Sat, 3 Feb 2024 11:39:53 +0100 Subject: [PATCH] Add more details to Email section --- admin/config.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/admin/config.md b/admin/config.md index 31cbcc2..4e28282 100644 --- a/admin/config.md +++ b/admin/config.md @@ -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.