From 1258ec0438cccf09fbd4599a9cb2bc7b5d0d6d1f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ferdinand=20M=C3=BCtsch?= Date: Sun, 6 Mar 2022 12:00:19 +0100 Subject: [PATCH] docs: add smtp and mailwhale config details to readme --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5956b5a..4509b26 100644 --- a/README.md +++ b/README.md @@ -154,10 +154,16 @@ You can specify configuration options either via a config file (default: `config | `db.ssl` /
`WAKAPI_DB_SSL` | `false` | Whether to use TLS encryption for database connection (Postgres and CockroachDB only) | | `db.automgirate_fail_silently` /
`WAKAPI_DB_AUTOMIGRATE_FAIL_SILENTLY` | `false` | Whether to ignore schema auto-migration failures when starting up | | `mail.enabled` /
`WAKAPI_MAIL_ENABLED` | `true` | Whether to allow Wakapi to send e-mail (e.g. for password resets) | -| `mail.sender` /
`WAKAPI_MAIL_SENDER` | `Wakapi ` | Default sender address for outgoing mails (ignored for MailWhale) | +| `mail.sender` /
`WAKAPI_MAIL_SENDER` | `Wakapi ` | Default sender address for outgoing mails (ignored for MailWhale) | | `mail.provider` /
`WAKAPI_MAIL_PROVIDER` | `smtp` | Implementation to use for sending mails (one of [`smtp`, `mailwhale`]) | -| `mail.smtp.*` /
`WAKAPI_MAIL_SMTP_*` | `-` | Various options to configure SMTP. See [default config](config.default.yml) for details | -| `mail.mailwhale.*` /
`WAKAPI_MAIL_MAILWHALE_*` | `-` | Various options to configure [MailWhale](https://mailwhale.dev) sending service. See [default config](config.default.yml) for details | +| `mail.smtp.host` /
`WAKAPI_MAIL_SMTP_HOST` | - | SMTP server address for sending mail (if using `smtp` mail provider) | +| `mail.smtp.port` /
`WAKAPI_MAIL_SMTP_PORT` | - | SMTP server port (usually 465) | +| `mail.smtp.username` /
`WAKAPI_MAIL_SMTP_USER` | - | SMTP server authentication username | +| `mail.smtp.password` /
`WAKAPI_MAIL_SMTP_PASS` | - | SMTP server authentication password | +| `mail.smtp.tls` /
`WAKAPI_MAIL_SMTP_TLS` | `false` | Whether the SMTP server requires TLS encryption (`false` for STARTTLS or no encryption) | +| `mail.mailwhale.url` /
`WAKAPI_MAIL_MAILWHALE_URL` | - | URL of [MailWhale](https://mailwhale.dev) instance (e.g. `https://mailwhale.dev`) (if using `mailwhale` mail provider`) | +| `mail.mailwhale.client_id` /
`WAKAPI_MAIL_MAILWHALE_CLIENT_ID` | - | MailWhale API client ID | +| `mail.mailwhale.client_secret` /
`WAKAPI_MAIL_MAILWHALE_CLIENT_SECRET` | - | MailWhale API client secret | | `sentry.dsn` /
`WAKAPI_SENTRY_DSN` | – | DSN for to integrate [Sentry](https://sentry.io) for error logging and tracing (leave empty to disable) | | `sentry.enable_tracing` /
`WAKAPI_SENTRY_TRACING` | `false` | Whether to enable Sentry request tracing | | `sentry.sample_rate` /
`WAKAPI_SENTRY_SAMPLE_RATE` | `0.75` | Probability of tracing a request in Sentry |