From 10877b5c59513bf133c1dcc08a0e2a15edd24990 Mon Sep 17 00:00:00 2001 From: les Date: Wed, 6 Nov 2019 11:23:40 +0100 Subject: [PATCH] [doc] add smtp config documentation --- docs/configuration.md | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/docs/configuration.md b/docs/configuration.md index 4c710fb5..ab9d77d7 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -53,8 +53,29 @@ Where to save images `"upload_path": "./uploads"` - ### SMTP -- ### Admin -Email of administrator. Email from gancio comes from this email. +SMTP configuration. +Gancio should send emails at following events: +- the admin should receive emails of anon event (if enabled) to confirm them. +- the admin should receive emails of registration request (if enabled) to confirm them. +- an user should receive an email of registration requested. +- an user should receive an email of confirmed registration. +- an user should receive a confirmation email when subscribed directly by admin. + +```json +"smtp": { + "auth": { + "user": "", + "pass": "" + }, + "secure": true, + "host": "" + } +``` + +- ### Admin_email +Email of administrator. Note that email from gancio comes from this email and that +the SMTP configuration above should allow to use this address as from. + - ### Favicon You could specify another favicon. This is also used as logo (top-left