added docs for the persona plugin
This commit is contained in:
parent
bd0ece0557
commit
26d2cce85e
@ -61,6 +61,7 @@ Part 2: Core plugin documentation
|
||||
plugindocs/raven
|
||||
plugindocs/basic_auth
|
||||
plugindocs/openid
|
||||
plugindocs/persona
|
||||
|
||||
|
||||
Part 3: Plugin Writer's Guide
|
||||
|
2
docs/source/plugindocs/persona.rst
Normal file
2
docs/source/plugindocs/persona.rst
Normal file
@ -0,0 +1,2 @@
|
||||
.. include:: ../../../mediagoblin/plugins/persona/README.rst
|
||||
|
41
mediagoblin/plugins/persona/README.rst
Normal file
41
mediagoblin/plugins/persona/README.rst
Normal file
@ -0,0 +1,41 @@
|
||||
.. _persona-chapter:
|
||||
|
||||
================
|
||||
persona plugin
|
||||
================
|
||||
|
||||
The persona plugin allows users to login to you GNU MediaGoblin instance using
|
||||
`Mozilla's 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's 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.
|
Loading…
x
Reference in New Issue
Block a user