docs: add welcome email option for user signup

hackclub · Oct 26, 2024 · a36cb67 · a36cb67
1 parent 527ce21
commit a36cb67
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/DOCS.md b/DOCS.md
@@ -139,8 +139,9 @@ argument) or via environment variables. Here is an overview of all options.
 | `db.max_conn` /<br> `WAKAPI_DB_MAX_CONNECTIONS`                              | `2`                                              | Maximum number of database connections                                                                                                                                                  |
 | `db.ssl` /<br> `WAKAPI_DB_SSL`                                               | `false`                                          | Whether to use TLS encryption for database connection (Postgres and CockroachDB only)                                                                                                   |
 | `db.automgirate_fail_silently` /<br> `WAKAPI_DB_AUTOMIGRATE_FAIL_SILENTLY`   | `false`                                          | Whether to ignore schema auto-migration failures when starting up                                                                                                                       |
-| `mail.enabled` /<br> `WAKAPI_MAIL_ENABLED`                                   | `true`                                           | Whether to allow Hackatime to send e-mail (e.g. for password resets)                                                                                                                    |
-| `mail.sender` /<br> `WAKAPI_MAIL_SENDER`                                     | `Hackatime <[email protected]>`                 | Default sender address for outgoing mails                                                                                                                                               |
+| `mail.enabled` /<br> `WAKAPI_MAIL_ENABLED`                                   | `true`                                           | Whether to allow Hackatime to send e-mail (e.g. for password resets) |
+| `mail.welcome_enabled` /<br> `WAKAPI_WELCOME_ENABLED`                        | `true`                                           | Whether Hackatime should send an e-mail on user signup |
+| `mail.sender` /<br> `WAKAPI_MAIL_SENDER`                                     | `Hackatime <[email protected]>`                 | Default sender address for outgoing mails |
 | `mail.provider` /<br> `WAKAPI_MAIL_PROVIDER`                                 | `smtp`                                           | Implementation to use for sending mails (one of [`smtp`])                                                                                                                               |
 | `mail.smtp.host` /<br> `WAKAPI_MAIL_SMTP_HOST`                               | -                                                | SMTP server address for sending mail (if using `smtp` mail provider)                                                                                                                    |
 | `mail.smtp.port` /<br> `WAKAPI_MAIL_SMTP_PORT`                               | -                                                | SMTP server port (usually 465)                                                                                                                                                          |