aboutsummaryrefslogtreecommitdiffstats
path: root/mediagoblin/plugins/persona/README.rst
blob: ef19ac5d6a9a47e92928cdbdc9eeb5aaa860efe6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
.. _persona-chapter:

================
 persona plugin
================

The persona plugin allows users to login to you GNU MediaGoblin instance using
`Mozilla Persona`_.

This plugin can be enabled alongside :ref:`openid-chapter` and
:ref:`basic_auth-chapter`.

.. note::
    When :ref:`basic_auth-chapter` is enabled alongside this persona plugin, and
    a user creates an account using their persona. If they would like to add a
    password to their account, they can use the forgot password feature to do
    so.

.. _Mozilla Persona: https://www.mozilla.org/en-US/persona/

Set up the persona plugin
=========================

1. Install the ``requests`` package.

2. Add the following to your MediaGoblin .ini file in the ``[plugins]`` section::

    [[mediagoblin.plugins.persona]]

3. Run::

        gmg dbupdate

   in order to create and apply migrations to any database tables that the
   plugin requires.

4. Run::

        gmg assetlink

   in order to persona's static assets.