aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source')
-rw-r--r--docs/source/configuration.rst33
-rw-r--r--docs/source/index.rst1
2 files changed, 34 insertions, 0 deletions
diff --git a/docs/source/configuration.rst b/docs/source/configuration.rst
index 7eb61ec4..093f492c 100644
--- a/docs/source/configuration.rst
+++ b/docs/source/configuration.rst
@@ -64,6 +64,39 @@ 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
+
+All other configuration changes
+-------------------------------
+
+To be perfectly honest, there are quite a few options and I'm not
+going to be able to get to documanting them all in time for 0.1.0.
+
+So here's a cop-out section saying that if you get into trouble, hop
+onto IRC and we'll help you out:
+
+ #mediagoblin on irc.freenode.net
Celery
======
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 088b5359..e9f3993e 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -14,6 +14,7 @@ Table of Contents:
foreword
about
deploying
+ configuration
help
theming
codebase