From: Christopher Allan Webber <cwebber@dustycloud.org>
Date: Tue, 1 Nov 2011 03:26:47 +0000 (-0500)
Subject: Enabling email notifications documentation!
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=14fbfd18afc09ad5e1768d2604df340aeec09cc7;p=mediagoblin.git

Enabling email notifications documentation!
---

diff --git a/docs/source/configuration.rst b/docs/source/configuration.rst
index 0d8bf5ec..b6c55900 100644
--- a/docs/source/configuration.rst
+++ b/docs/source/configuration.rst
@@ -64,6 +64,28 @@ file also, usually by a -cf flag.)
 Common changes
 ==============
 
+Enabling email notifications
+----------------------------
+
+You'll almost certainly want to enable sending emails.  By default,
+MediaGoblin doesn't really do this... for the sake of developer
+convenience, it runs in "email debug mode".  Change this:
+
+  email_debug_mode = false
+
+You can (and should) change the "from" email address by setting
+``email_sender_address``.
+
+Note that you need a mailer daemon running for this to work.
+
+If you have more custom SMTP settings, you also have the following
+options at your disposal, which are all optional, and do exactly what
+they sound like.
+
+ - email_smtp_host
+ - email_smtp_port
+ - email_smtp_user
+ - email_smtp_pass
 
 Celery
 ======