summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndrew Dolgov <[email protected]>2021-03-03 14:34:02 +0300
committerAndrew Dolgov <[email protected]>2021-03-03 14:34:02 +0300
commite5e76d233fb632cb2928eae125c6e45c488fdf89 (patch)
tree38b6fe1ccd95a9ea00f8b87f1fddb91872057a01
parent3d904dc8f34d1479ed949c26d9f871dcaabcfb34 (diff)
update README
-rw-r--r--README.md23
1 files changed, 18 insertions, 5 deletions
diff --git a/README.md b/README.md
index 30e13a5..0eced43 100644
--- a/README.md
+++ b/README.md
@@ -4,11 +4,24 @@
2. Enable via `TTRSS_PLUGINS` global configuration setting (this is a system plugin, it can't be enabled per-user).
3. Set the following plugin settings via `.env` or `putenv()` in `config.php`:
- - `TTRSS_SMTP_SERVER` - Send outgoing mail via this server (hostname:port). Required.
- - `TTRSS_SMTP_LOGIN`, `TTRSS_SMTP_PASSWORD` - SMTP login/password, if needed.
- - `TTRSS_SMTP_SECURE` - Use secure connection. Allowed values: `ssl`, `tls`, or empty.
- - `TTRSS_SMTP_SKIP_CERT_CHECKS` - Accept all SSL certificates, use with caution.
- - `TTRSS_SMTP_CA_FILE` - Use a custom CA certificate for SSL/TLS secure connections. Only used if TTRSS_SMTP_SKIP_CERT_CHECKS is false.
+```ini
+TTRSS_SMTP_SERVER=localhost:587
+# Use this server (hostname:port). Empty value disables plugin.
+
+TTRSS_SMTP_LOGIN=
+TTRSS_SMTP_PASSWORD=
+# Login/password for SMTP auth, if needed.
+
+TTRSS_SMTP_SECURE=tls
+#Use secure connection. Allowed values: `ssl`, `tls`, or empty.
+
+#TTRSS_SMTP_SKIP_CERT_CHECKS=
+# Accept all SSL certificates, use with caution.
+
+#TTRSS_SMTP_CA_FILE=
+# Use custom CA certificate for SSL/TLS secure connections. Only used if TTRSS_SMTP_SKIP_CERT_CHECKS is false.
+```
+
## Upgrading from legacy setup