added openid docs

2 files changed, 34 insertions, 0 deletions

diff --git a/docs/source/plugindocs/openid.rst b/docs/source/plugindocs/openid.rst
new file mode 100644
index 00000000..045bf9d0
--- /dev/null
+++ b/docs/source/plugindocs/openid.rst
@@ -0,0 +1,2 @@
+.. include:: ../../../mediagoblin/plugins/openid/README.rst
+
diff --git a/mediagoblin/plugins/openid/README.rst b/mediagoblin/plugins/openid/README.rst
new file mode 100644
index 00000000..e753b0f9
--- /dev/null
+++ b/mediagoblin/plugins/openid/README.rst
@@ -0,0 +1,32 @@
+===================
+ Openid plugin
+===================
+
+The Openid plugin allows user to login to your GNU Mediagoblin instance using
+their openid url.
+
+This plugin can be enabled alongside :ref:`basic_auth-chapter` and
+:ref:`persona-chapter`.
+
+.. note::
+    When :reg:`basic_auth-chapter` is enabled alongside this Openid plugin, and
+    a user creates an account using their Openid. If they would like to add a
+    password to their account, they can use the forgot password feature to do
+    so.
+
+
+Set up the Openid plugin
+============================
+
+1. Install the ``python-openid`` package.
+
+2. Add the following to your MediaGoblin .ini file in the ``[plugins]`` section::
+
+    [[mediagoblin.plugins.openid]]
+
+3. Run::
+
+        gmg dbupdate
+
+   in order to create and apply migrations to any database tables that the
+   plugin requires.