Fixed Copyright Headers
[mediagoblin.git] / mediagoblin / plugins / openid / README.rst
1 .. _openid-chapter:
2
3 ===================
4 openid plugin
5 ===================
6
7 The openid plugin allows user to login to your GNU Mediagoblin instance using
8 their openid url.
9
10 This plugin can be enabled alongside :ref:`basic_auth-chapter` and
11 :ref:`persona-chapter`.
12
13 .. note::
14 When :ref:`basic_auth-chapter` is enabled alongside this openid plugin, and
15 a user creates an account using their openid. If they would like to add a
16 password to their account, they can use the forgot password feature to do
17 so.
18
19
20 Set up the openid plugin
21 ============================
22
23 1. Install the ``python-openid`` package.
24
25 2. Add the following to your MediaGoblin .ini file in the ``[plugins]`` section::
26
27 [[mediagoblin.plugins.openid]]
28
29 3. Run::
30
31 gmg dbupdate
32
33 in order to create and apply migrations to any database tables that the
34 plugin requires.