[mediagoblin.git] / mediagoblin / plugins / openid / README.rst

.. _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.
Commit	Line	Data
bd0ece05 RE	1	.. _openid-chapter:
bd0ece05 RE	2
2c4cdd09	3	===================
9650aa39	4	OpenID plugin
2c4cdd09 RE	5	===================
2c4cdd09 RE	6
9650aa39 BS	7	The OpenID plugin allows user to login to your GNU MediaGoblin instance using
9650aa39 BS	8	their OpenID URL.
2c4cdd09 RE	9
	10	This plugin can be enabled alongside :ref:`basic_auth-chapter` and
	11	:ref:`persona-chapter`.
	12
	13	.. note::
9650aa39 BS	14	When :ref:`basic_auth-chapter` is enabled alongside this OpenID plugin, and
9650aa39 BS	15	a user creates an account using their OpenID. If they would like to add a
2c4cdd09 RE	16	password to their account, they can use the forgot password feature to do
	17	so.
	18
	19
9650aa39	20	Set up the OpenID plugin
2c4cdd09 RE	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.