philorg/sms-handler
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 2 Wiki Activity Actions

Improve doc
All checks were successful
/ test (push) Successful in 7s
Details

Browse source
This commit is contained in:
phil 2024-12-01 03:11:11 +01:00
parent 0ada185e13
commit 9a2dcd5a77
1 changed files with 7 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -13,13 +13,13 @@ apt install -y pipx && pipx install uv
Configuration is done by environment variables, prefixed by `SMS_HANDLER_`:
* `MAIL_SENDER`: origin email address (default: <username>@localhost)
* `MAIL_TO`: destination email address (default: <username>@localhost)
* `MAIL_SERVER`: address of the mail server (default: localhost)
* `MAIL_SERVER_PORT`: port of the mail server (default: 25)
* `MAIL_SERVER_START_TLS`: initiate mail server connection with TLS (default: no)
* `MAIL_TEMLATE`: used to format the body of the mails
* `MAIL_ENABLE`: no or false to disable mails (default: yes)
* `SMS_HANDLER_MAIL_SENDER`: origin email address (default: <username>@localhost)
* `SMS_HANDLER_MAIL_TO`: destination email address (default: <username>@localhost)
* `SMS_HANDLER_MAIL_SERVER`: address of the mail server (default: localhost)
* `SMS_HANDLER_MAIL_SERVER_PORT`: port of the mail server (default: 25)
* `SMS_HANDLER_MAIL_SERVER_START_TLS`: initiate mail server connection with TLS (default: no)
* `SMS_HANDLER_MAIL_TEMLATE`: used to format the body of the mails
* `SMS_HANDLER_MAIL_ENABLE`: no or false to disable mails (default: yes)
The default settings assume that a mail server runs on the localhost,
and mails are sent to the user that owns the process.