summaryrefslogtreecommitdiff
path: root/config/config.md
diff options
context:
space:
mode:
Diffstat (limited to 'config/config.md')
-rw-r--r--config/config.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/config/config.md b/config/config.md
index dbbfa9194..2e7f6244c 100644
--- a/config/config.md
+++ b/config/config.md
@@ -30,6 +30,31 @@ This filter replaces the filename (not the path) of an upload. For complete obfu
* `text`: Text to replace filenames in links. If empty, `{random}.extension` will be used.
+## Pleroma.Mailer
+* `adapter`: one of the mail adapters listed in [Swoosh readme](https://github.com/swoosh/swoosh#adapters), or `Swoosh.Adapters.Local` for in-memory mailbox.
+* `api_key` / `password` and / or other adapter-specific settings, per the above documentation.
+
+An example for Sendgrid adapter:
+
+```
+config :pleroma, Pleroma.Mailer,
+ adapter: Swoosh.Adapters.Sendgrid,
+ api_key: "YOUR_API_KEY"
+```
+
+An example for SMTP adapter:
+```
+config :pleroma, Pleroma.Mailer,
+ adapter: Swoosh.Adapters.SMTP,
+ relay: "smtp.gmail.com",
+ username: "YOUR_USERNAME@gmail.com",
+ password: "YOUR_SMTP_PASSWORD",
+ port: 465,
+ ssl: true,
+ tls: :always,
+ auth: :always
+```
+
## :uri_schemes
* `valid_schemes`: List of the scheme part that is considered valid to be an URL