aboutsummaryrefslogtreecommitdiffstats
path: root/mediagoblin/plugins/openid
diff options
context:
space:
mode:
authorRodney Ewing <ewing.rj@gmail.com>2013-08-16 10:24:41 -0700
committerRodney Ewing <ewing.rj@gmail.com>2013-08-16 10:24:41 -0700
commitfb900ef27b65b3d220ce16972593869441b4c82c (patch)
tree87cd40ca32c1123703d23ce62c4adecfafb03ee2 /mediagoblin/plugins/openid
parent71b2bee6228164993394f74202e5acd82535c34d (diff)
parentd194770dd24c70cf1306d1287ec2cf82f07e2107 (diff)
downloadmediagoblin-fb900ef27b65b3d220ce16972593869441b4c82c.tar.lz
mediagoblin-fb900ef27b65b3d220ce16972593869441b4c82c.tar.xz
mediagoblin-fb900ef27b65b3d220ce16972593869441b4c82c.zip
Merge branch 'auth_docs'
Conflicts: docs/source/index.rst
Diffstat (limited to 'mediagoblin/plugins/openid')
-rw-r--r--mediagoblin/plugins/openid/README.rst34
1 files changed, 34 insertions, 0 deletions
diff --git a/mediagoblin/plugins/openid/README.rst b/mediagoblin/plugins/openid/README.rst
new file mode 100644
index 00000000..870a2b58
--- /dev/null
+++ b/mediagoblin/plugins/openid/README.rst
@@ -0,0 +1,34 @@
+.. _openid-chapter:
+
+===================
+ 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 :ref:`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.