aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/siteadmin/configuration.rst
diff options
context:
space:
mode:
authorBen Sturmfels <ben@sturm.com.au>2021-03-29 16:01:14 +1100
committerBen Sturmfels <ben@sturm.com.au>2021-03-29 16:01:14 +1100
commitf06784c58eef33c8c4fa916940e7bf132f70ebda (patch)
treef21707445e697f827af41e3d92a8b8dc192ce032 /docs/source/siteadmin/configuration.rst
parent0cc3febdaac8ef55b27f87af8e822570a9b032eb (diff)
downloadmediagoblin-f06784c58eef33c8c4fa916940e7bf132f70ebda.tar.lz
mediagoblin-f06784c58eef33c8c4fa916940e7bf132f70ebda.tar.xz
mediagoblin-f06784c58eef33c8c4fa916940e7bf132f70ebda.zip
docs: Tune up configuration documentation.
Diffstat (limited to 'docs/source/siteadmin/configuration.rst')
-rw-r--r--docs/source/siteadmin/configuration.rst44
1 files changed, 16 insertions, 28 deletions
diff --git a/docs/source/siteadmin/configuration.rst b/docs/source/siteadmin/configuration.rst
index 92d77628..488919d7 100644
--- a/docs/source/siteadmin/configuration.rst
+++ b/docs/source/siteadmin/configuration.rst
@@ -24,18 +24,13 @@ some configuration parameters. Well you've come to the right place!
MediaGoblin's config files
==========================
-When configuring MediaGoblin, there are two files you might want to
-make local modified versions of, and one extra file that might be
-helpful to look at. Let's examine these.
+There are two main files used to configure MediaGoblin:
``mediagoblin.ini``
This is the main config file for MediaGoblin. If you want to tweak any
- settings for MediaGoblin, you'll usually do that here.
-
-``mediagoblin.example.ini``
- When you run MediaGoblin for the first time, this default config is copied to
- your new ``mediagoblin.ini``. Keep this in mind if you need to refer back to
- the original settings.
+ settings for MediaGoblin, you'll usually do that here. This file is copied
+ from ``mediagoblin.example.ini`` the first time MediaGoblin runs. Keep this in
+ mind if you ever need to refer back to the original settings.
``paste.ini``
This is primarily a server configuration file, on the Python side
@@ -47,17 +42,10 @@ helpful to look at. Let's examine these.
Python server other than Waitress / plain HTTP, you might configure it
here. You probably won't need to change this file very much.
-
-There's one more file that you certainly won't change unless you're
-making coding contributions to MediaGoblin, but which can be useful to
-read and reference:
-
-``mediagoblin/config_spec.ini``
- This file is actually a specification for mediagoblin.ini itself, as
- a config file! It defines types and defaults. Sometimes it's a
- good place to look for documentation... or to find that hidden
- option that we didn't tell you about. :)
-
+Changes to these two files only take effect after restarting MediaGoblin. If you
+followed your deployment guide, see the section on :ref:`restarting MediaGoblin
+<restarting mediagoblin>`. If you're using ``lazyserver.sh`` or
+``lazycelery.sh``, first quit with ``Ctrl-c`` and then re-run the command.
Enabling extra media types or plugins may require an update to the database, so
after making changes, it is also a good idea to run::
@@ -97,6 +85,7 @@ they sound like.
- ``email_smtp_use_ssl`` (default is ``False``)
- ``email_smtp_force_starttls`` (default is ``False``)
+
Changing the data directory
---------------------------
@@ -126,14 +115,13 @@ If you use Nginx you need to change the config::
Once you have done this you will need to move any existing media you had in the
old directory to the new directory so existing media still can be displayed.
+
All other configuration changes
-------------------------------
-To be perfectly honest, there are quite a few options and we haven't had
-time to document them all, including Celery configuration.
-
-So here's a cop-out section saying that if you get into trouble, hop
-onto IRC and we'll help you out. Details for the IRC channel is on the
-`join page`_ of the website.
-
-.. _join page: http://mediagoblin.org/join/
+There are a number of other settings which aren't documented here. Currently,
+the best reference for these options is ``mediagoblin/config_spec.ini`` and the
+additional config specifications for each media type eg.
+``mediagoblin/media_types/video/config_spec.ini``. These files are the
+specification for ``mediagoblin.ini`` and define the types and default values
+for each configuration option.