From f92ce31f712c155051c7e0f2e6c6f6f2c4f40b71 Mon Sep 17 00:00:00 2001 From: Mia Winter Date: Thu, 18 Jan 2024 15:32:10 +0100 Subject: [PATCH] Added Email section to README --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 85d53d8..78a550f 100644 --- a/README.md +++ b/README.md @@ -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