[PATCH 7 of 8] e-mail: add documentation about configuration settings to ini files
Thomas De Schampheleire
patrickdepinguin at gmail.com
Wed Jul 22 19:50:07 UTC 2015
# HG changeset patch
# User Thomas De Schampheleire <thomas.de.schampheleire at gmail.com>
# Date 1437061235 -7200
# Thu Jul 16 17:40:35 2015 +0200
# Node ID c024931198851143a30a4e218bbc9d7ff70927e1
# Parent f7b9681ad240d1ddd831f117b312cf24f67e33c5
e-mail: add documentation about configuration settings to ini files
diff --git a/development.ini b/development.ini
--- a/development.ini
+++ b/development.ini
@@ -16,9 +16,22 @@ debug = true
pdebug = false
################################################################################
-## Uncomment and replace with the address which should receive ##
-## any error reports after application crash ##
-## Additionally those settings will be used by Kallithea mailing system ##
+## E-mail settings ##
+## ##
+## E-mail is sent in two broad categories: ##
+## - Error e-mails: In case an exception occurs in Kallithea, an e-mail with ##
+## details about the exception is sent by Paste to the address specified ##
+## in 'email_to', from the address specified in 'error_email_from'. ##
+## - Application e-mails: Kallithea itself sends e-mail to the administrator ##
+## specified in 'email_to' for notifications like new user registration and ##
+## to individual users for notifications about new code comments, review ##
+## invitations, ... These e-mails originate from the address specified in ##
+## 'app_email_from'. ##
+## If desired, the subject of these application e-mails can be prefixed ##
+## with the text specified in 'email_prefix'. ##
+## ##
+## Note: your SMTP server may require 'app_email_from'/'error_email_from' to ##
+## be a valid, existing addresses. ##
################################################################################
#email_to = admin at localhost
#error_email_from = paste_error at localhost
diff --git a/kallithea/bin/template.ini.mako b/kallithea/bin/template.ini.mako
--- a/kallithea/bin/template.ini.mako
+++ b/kallithea/bin/template.ini.mako
@@ -10,9 +10,22 @@ debug = true
pdebug = false
<%text>
################################################################################
-## Uncomment and replace with the address which should receive ##
-## any error reports after application crash ##
-## Additionally those settings will be used by Kallithea mailing system ##
+## E-mail settings ##
+## ##
+## E-mail is sent in two broad categories: ##
+## - Error e-mails: In case an exception occurs in Kallithea, an e-mail with ##
+## details about the exception is sent by Paste to the address specified ##
+## in 'email_to', from the address specified in 'error_email_from'. ##
+## - Application e-mails: Kallithea itself sends e-mail to the administrator ##
+## specified in 'email_to' for notifications like new user registration and ##
+## to individual users for notifications about new code comments, review ##
+## invitations, ... These e-mails originate from the address specified in ##
+## 'app_email_from'. ##
+## If desired, the subject of these application e-mails can be prefixed ##
+## with the text specified in 'email_prefix'. ##
+## ##
+## Note: your SMTP server may require 'app_email_from'/'error_email_from' to ##
+## be a valid, existing addresses. ##
################################################################################</%text>
#email_to = admin at localhost
#error_email_from = paste_error at localhost
diff --git a/kallithea/config/deployment.ini_tmpl b/kallithea/config/deployment.ini_tmpl
--- a/kallithea/config/deployment.ini_tmpl
+++ b/kallithea/config/deployment.ini_tmpl
@@ -11,9 +11,22 @@ debug = true
pdebug = false
################################################################################
-## Uncomment and replace with the address which should receive ##
-## any error reports after application crash ##
-## Additionally those settings will be used by Kallithea mailing system ##
+## E-mail settings ##
+## ##
+## E-mail is sent in two broad categories: ##
+## - Error e-mails: In case an exception occurs in Kallithea, an e-mail with ##
+## details about the exception is sent by Paste to the address specified ##
+## in 'email_to', from the address specified in 'error_email_from'. ##
+## - Application e-mails: Kallithea itself sends e-mail to the administrator ##
+## specified in 'email_to' for notifications like new user registration and ##
+## to individual users for notifications about new code comments, review ##
+## invitations, ... These e-mails originate from the address specified in ##
+## 'app_email_from'. ##
+## If desired, the subject of these application e-mails can be prefixed ##
+## with the text specified in 'email_prefix'. ##
+## ##
+## Note: your SMTP server may require 'app_email_from'/'error_email_from' to ##
+## be a valid, existing addresses. ##
################################################################################
#email_to = admin at localhost
#error_email_from = paste_error at localhost
diff --git a/production.ini b/production.ini
--- a/production.ini
+++ b/production.ini
@@ -15,9 +15,22 @@ debug = true
pdebug = false
################################################################################
-## Uncomment and replace with the address which should receive ##
-## any error reports after application crash ##
-## Additionally those settings will be used by Kallithea mailing system ##
+## E-mail settings ##
+## ##
+## E-mail is sent in two broad categories: ##
+## - Error e-mails: In case an exception occurs in Kallithea, an e-mail with ##
+## details about the exception is sent by Paste to the address specified ##
+## in 'email_to', from the address specified in 'error_email_from'. ##
+## - Application e-mails: Kallithea itself sends e-mail to the administrator ##
+## specified in 'email_to' for notifications like new user registration and ##
+## to individual users for notifications about new code comments, review ##
+## invitations, ... These e-mails originate from the address specified in ##
+## 'app_email_from'. ##
+## If desired, the subject of these application e-mails can be prefixed ##
+## with the text specified in 'email_prefix'. ##
+## ##
+## Note: your SMTP server may require 'app_email_from'/'error_email_from' to ##
+## be a valid, existing addresses. ##
################################################################################
#email_to = admin at localhost
#error_email_from = paste_error at localhost
diff --git a/test.ini b/test.ini
--- a/test.ini
+++ b/test.ini
@@ -15,9 +15,22 @@ debug = true
pdebug = false
################################################################################
-## Uncomment and replace with the address which should receive ##
-## any error reports after application crash ##
-## Additionally those settings will be used by Kallithea mailing system ##
+## E-mail settings ##
+## ##
+## E-mail is sent in two broad categories: ##
+## - Error e-mails: In case an exception occurs in Kallithea, an e-mail with ##
+## details about the exception is sent by Paste to the address specified ##
+## in 'email_to', from the address specified in 'error_email_from'. ##
+## - Application e-mails: Kallithea itself sends e-mail to the administrator ##
+## specified in 'email_to' for notifications like new user registration and ##
+## to individual users for notifications about new code comments, review ##
+## invitations, ... These e-mails originate from the address specified in ##
+## 'app_email_from'. ##
+## If desired, the subject of these application e-mails can be prefixed ##
+## with the text specified in 'email_prefix'. ##
+## ##
+## Note: your SMTP server may require 'app_email_from'/'error_email_from' to ##
+## be a valid, existing addresses. ##
################################################################################
#email_to = admin at localhost
#error_email_from = paste_error at localhost
More information about the kallithea-general
mailing list