diff options
Diffstat (limited to 'docs/source/siteadmin/plugins.rst')
| -rw-r--r-- | docs/source/siteadmin/plugins.rst | 29 |
1 files changed, 25 insertions, 4 deletions
diff --git a/docs/source/siteadmin/plugins.rst b/docs/source/siteadmin/plugins.rst index baca381d..8682b0c7 100644 --- a/docs/source/siteadmin/plugins.rst +++ b/docs/source/siteadmin/plugins.rst @@ -55,7 +55,7 @@ offer for your media), we would do:: 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). + python (and thus pip) is python 3 (e.g. in *buntu). Once you've installed the plugin software, you need to tell MediaGoblin that this is a plugin you want MediaGoblin to use. To do @@ -110,11 +110,32 @@ comments making the bits clearer):: Check the plugin's documentation for what configuration options are available. +Once you've set up your plugin, you should be sure to update the +database to accommodate the new plugins:: -Removing plugins -================ + ./bin/gmg dbupdate -To remove a plugin, use ``pip uninstall``. For example:: + +Deactivating plugins +==================== + +You should be aware that once you enable a plugin, deactivating it +might be a bit tricky, for migrations reasons. In the future we may +produce better tooling to accommodate this. In short, you will need to +do a bit of database surgery by: + +- Removing all tables and indexes installed by the plugin +- Removing the plugin's migration head id from the `alembic_version` + table. (You might be able to determine which to remove via + examining the output of `./bin/gmg alembic heads`) + +Note that this is a VERY TRICKY process, and you should be sure to make +a backup first. You've been warned! + +Removing plugin packages +======================== + +To remove an external plugin's package, use ``pip uninstall``. For example:: pip uninstall mediagoblin-licenses |