Missing codecs processing with gst 1.4

[mediagoblin.git] / docs / source / siteadmin / plugins.rst

diff --git a/docs/source/siteadmin/plugins.rst b/docs/source/siteadmin/plugins.rst
index 41f2970f5e3806affc39a1fdbf534e311ffa912b..baca381dd8f449acf15b0d049e2d419bf635c5d2 100644 (file)
--- a/docs/source/siteadmin/plugins.rst
+++ b/docs/source/siteadmin/plugins.rst
@@ -44,29 +44,33 @@ If the plugin is available on the `Python Package Index
     pip install <plugin-name>
 
 For example, if we wanted to install the plugin named
-"mediagoblin-restrictfive", we would do::
+"mediagoblin-licenses" (which allows you to customize the licenses you
+offer for your media), we would do::
 
-    pip install mediagoblin-restrictfive
+    pip install mediagoblin-licenses
 
 .. Note::
 
    If you're using a virtual environment, make sure to activate the
-   virtual environment before installing with pip. Otherwise the
-   plugin may get installed in a different environment than the one
-   MediaGoblin is installed in.
+   virtual environment before installing with pip. Otherwise the plugin
+   may get installed in a different environment than the one MediaGoblin
+   is installed in. Also make sure, you use e.g. pip-2.7 if your default
+   python (and thus pip) is python 3 (e.g. in Ubuntu).
 
 Once you've installed the plugin software, you need to tell
 MediaGoblin that this is a plugin you want MediaGoblin to use. To do
 that, you edit the ``mediagoblin.ini`` file and add the plugin as a
 subsection of the plugin section.
 
-For example, say the "mediagoblin-restrictfive" plugin had the Python
-package path ``restrictfive``, then you would add ``restrictfive`` to
+For example, say the "mediagoblin-licenses" plugin has the Python
+package path ``mediagoblin_licenses``, then you would add ``mediagoblin_licenses`` to
 the ``plugins`` section as a subsection::
 
     [plugins]
 
-    [[restrictfive]]
+    [[mediagoblin_licenses]]
+    license_01=abbrev1, name1, http://url1
+    license_02=abbrev2, name1, http://url2
 
 
 Configuring plugins
@@ -79,14 +83,18 @@ should come with documentation that tells you how to configure them.
 Example 1: Core MediaGoblin plugin
 
 If you wanted to use the core MediaGoblin flatpages plugin, the module
-for that is ``mediagoblin.plugins.flatpages`` and you would add that
-to your ``.ini`` file like this::
+for that is ``mediagoblin.plugins.flatpagesfile`` and you would add
+that to your ``.ini`` file like this::
 
     [plugins]
 
-    [[mediagoblin.plugins.flatpages]]
-    # configuration for flatpages plugin here!
-    directory = /srv/mediagoblin/flatpages
+    [[mediagoblin.plugins.flatpagesfile]]
+    # configuration for flatpagesfile plugin here!
+    about-view = '/about', about.html
+    terms-view = '/terms', terms.html
+
+(Want to know more about the flatpagesfile plugin?  See
+:ref:`flatpagesfile-chapter`)
 
 Example 2: Plugin that is not a core MediaGoblin plugin
 
@@ -108,7 +116,7 @@ Removing plugins
 
 To remove a plugin, use ``pip uninstall``. For example::
 
-    pip uninstall mediagoblin-restrictfive
+    pip uninstall mediagoblin-licenses
 
 .. Note::
 
@@ -135,3 +143,35 @@ For plugins that you install with pip, you can upgrade them with pip::
     pip install -U <plugin-name>
 
 The ``-U`` tells pip to upgrade the package.
+
+
+Troubleshooting plugins
+=======================
+
+Sometimes plugins just don't work right. When you're having problems
+with plugins, think about the following:
+
+1. Check the log files.
+
+   Some plugins will log errors to the log files and you can use that
+   to diagnose the problem.
+
+2. Try running MediaGoblin without that plugin.
+
+   It's easy to disable a plugin from MediaGoblin. Add a ``-`` to the
+   name in your config file.
+
+   For example, change::
+
+       [[mediagoblin.plugins.flatpagesfile]]
+
+   to::
+
+       [[-mediagoblin.plugins.flatpagesfile]]
+
+   That'll prevent the ``mediagoblin.plugins.flatpagesfile`` plugin from
+   loading.
+
+3. If it's a core plugin that comes with MediaGoblin, ask us for help!
+
+   If it's a plugin you got from somewhere else, ask them for help!