Current location

narf Source control manager Git

diff options
authorChristopher Allan Webber <>2016-03-25 15:47:19 -0700
committerChristopher Allan Webber <>2016-03-26 11:39:08 -0700
commitcca25b6fcfd47a95bd1cf1b00adf036b2f8f331b (patch)
parente3cfc9a84f07265000a383f0df50c0655986cdf3 (diff)
doc: Update plugins documentation in light of alembic branching usage
* docs/source/siteadmin/plugins.rst: Added a reminder to run "./bin/gmg dbupdate" after installing a plugin. Added a new "Deactivating plugins" section. Renamed "Removing plugins" to "Removing plugin packages".
1 files changed, 24 insertions, 3 deletions
diff --git a/docs/source/siteadmin/plugins.rst b/docs/source/siteadmin/plugins.rst
index 1f82c670..67c8bad1 100644
--- a/docs/source/siteadmin/plugins.rst
+++ b/docs/source/siteadmin/plugins.rst
@@ -110,11 +110,32 @@ comments making the bits clearer)::
Check the plugin's documentation for what configuration options are
+Once you've set up your plugin, you should be sure to update the
+database to accomodate 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 accomodate 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