aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Johannes Christ <[email protected]>2024-08-25 20:34:39 +0200
committerGravatar Johannes Christ <[email protected]>2024-08-25 20:34:39 +0200
commitdc53e377adfcfee328778e5334496038ccba8f78 (patch)
treed9734eb46fda85b0fe19372906629ab2d419577d
parentParse tuples to all() (diff)
Document e-mail variables
Initial work for #262.
-rw-r--r--README.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/README.md b/README.md
index 1e7b33b..9eb0703 100644
--- a/README.md
+++ b/README.md
@@ -44,6 +44,10 @@ The environment variables are required to work with the LDAP/FreeIPA system.
| KING_ARTHUR_KEYCLOAK_USERNAME | The username of the keycloak user to make requests with | kingarthur |
| KING_ARTHUR_KEYCLOAK_PASSWORD | The password of the keycloak user to make requests with | Required |
| KING_ARTHUR_KEYCLOAK_USER_REALM | The keycloak realm to make requests to | pydis |
+| KING_ARTHUR_EMAIL_HOST | The e-mail relay to send e-mails via | |
+| KING_ARTHUR_EMAIL_FROM | The "From:" address to set in e-mails sent by King Arthur | |
+| KING_ARTHUR_EMAIL_USERNAME | The username to authenticate to the mail relay with | |
+| KING_ARTHUR_EMAIL_PASSWORD | The password to authenticate to the mail relay with | |
## A note on LDAP