docs/source/configuration.rst

   1 .. _configuration-chapter:
   2
   3 ========================
   4 Configuring MediaGoblin
   5 ========================
   6
   7 So!  You've got MediaGoblin up and running, but you need to adjust
   8 some configuration parameters.  Well you've come to the right place!
   9
  10 MediaGoblin's config files
  11 ==========================
  12
  13 When configuring MediaGoblin, there are two files you might want to
  14 make local modified versions of, and one extra file that might be
  15 helpful to look at.  Let's examine these.
  16
  17 mediagoblin.ini
  18   This is the config file for MediaGoblin, the application.  If you want to
  19   tweak settings for MediaGoblin, you'll usually tweak them here.
  20
  21 paste.ini
  22   This is primarily a server configuration file, on the Python side
  23   (specifically, on the WSGI side, via `paste deploy
  24   <http://pythonpaste.org/deploy/>`_ / `paste script
  25   <http://pythonpaste.org/script/>`_).  It also sets up some
  26   middleware that you can mostly ignore, except to configure
  27   sessions... more on that later.  If you are adding a different
  28   Python server other than fastcgi / plain HTTP, you might configure
  29   it here.  You probably won't need to change this file very much.
  30
  31
  32 There's one more file that you certainly won't change unless you're
  33 making coding contributions to mediagoblin, but which can be useful to
  34 read and reference:
  35
  36 mediagoblin/config_spec.ini
  37   This file is actually a specification for mediagoblin.ini itself, as
  38   a config file!  It defines types and defaults.  Sometimes it's a
  39   good place to look for documentation... or to find that hidden
  40   option that we didn't tell you about. :)
  41
  42
  43 Making local copies
  44 ===================
  45
  46 Let's assume you're doing the virtualenv setup described elsewhere in this
  47 manual, and you need to make local tweaks to the config files. How do you do
  48 that? Let's see.
  49
  50 To make changes to mediagoblin.ini ::
  51
  52     cp mediagoblin.ini mediagoblin_local.ini
  53
  54 To make changes to paste.ini ::
  55
  56     cp paste.ini paste_local.ini
  57
  58 From here you should be able to make direct adjustments to the files,
  59 and most of the commands described elsewhere in this manual will "notice"
  60 your local config files and use those instead of the non-local version.
  61
  62 .. note::
  63
  64    Note that all commands provide a way to pass in a specific config
  65    file also, usually by a ``-cf`` flag.
  66
  67
  68 Common changes
  69 ==============
  70
  71 Enabling email notifications
  72 ----------------------------
  73
  74 You'll almost certainly want to enable sending emails.  By default,
  75 MediaGoblin doesn't really do this... for the sake of developer
  76 convenience, it runs in "email debug mode".  Change this::
  77
  78     email_debug_mode = false
  79
  80 You can (and should) change the "from" email address by setting
  81 ``email_sender_address``.
  82
  83 Note that you need a mailer daemon running for this to work.
  84
  85 If you have more custom SMTP settings, you also have the following
  86 options at your disposal, which are all optional, and do exactly what
  87 they sound like.
  88
  89 - email_smtp_host
  90 - email_smtp_port
  91 - email_smtp_user
  92 - email_smtp_pass
  93
  94 All other configuration changes
  95 -------------------------------
  96
  97 To be perfectly honest, there are quite a few options and we haven't had
  98 time to document them all
  99
 100 So here's a cop-out section saying that if you get into trouble, hop
 101 onto IRC and we'll help you out::
 102
 103     #mediagoblin on irc.freenode.net
 104
 105 Celery
 106 ======
 107
 108 We should point to another celery-specific section of the document
 109 actually :)