winter-software/Wave
winter-software/Wave
1
0
Fork 0
Code Issues Wiki Activity

Added Email section to README

Browse source
This commit is contained in:
Mia Rose Winter 2024-01-18 15:32:10 +01:00
parent 5b68e1d9eb
commit f92ce31f71
Signed by: miawinter
GPG key ID: 4B6F6A83178F595E
1 changed files with 22 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -78,7 +78,28 @@ ## Installation
## Configuring Email
TODO
Wave may send user related mails every now and then, to confirm an account, reset a password, etc.
In order to support that, Wave needs to have a way to send Emails, currently SMTP is supported
### SMTP
The following configuration is required for Wave to connect to an smtp server
(formatted in YAML for brevity).
```yml
Email:
Smtp:
Host: smtp.example.com
Port: 25
SenderEmail: noreply@example.com
SenderName: Wave
Username: user
Password: password
Ssl: true
```
`Username` and `Password` are optional if your server does not require it, and `Ssl` is
`true` by default, only set it to false if you really need to, keeping security in mind.
## License and Attribution