diff options
author | Rodney Ewing <ewing.rj@gmail.com> | 2013-07-09 13:31:32 -0700 |
---|---|---|
committer | Rodney Ewing <ewing.rj@gmail.com> | 2013-07-09 13:31:32 -0700 |
commit | 26d2cce85ef629a58d80def85fcda8e324d5d182 (patch) | |
tree | ff7e80d8f75d4b2431743d3387a4fec579c0514d | |
parent | bd0ece0557d7ac4cbbf77617b125060b8c083892 (diff) | |
download | mediagoblin-26d2cce85ef629a58d80def85fcda8e324d5d182.tar.lz mediagoblin-26d2cce85ef629a58d80def85fcda8e324d5d182.tar.xz mediagoblin-26d2cce85ef629a58d80def85fcda8e324d5d182.zip |
added docs for the persona plugin
-rw-r--r-- | docs/source/index.rst | 1 | ||||
-rw-r--r-- | docs/source/plugindocs/persona.rst | 2 | ||||
-rw-r--r-- | mediagoblin/plugins/persona/README.rst | 41 |
3 files changed, 44 insertions, 0 deletions
diff --git a/docs/source/index.rst b/docs/source/index.rst index f6bc5561..0e7d0c2b 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -61,6 +61,7 @@ Part 2: Core plugin documentation plugindocs/raven plugindocs/basic_auth plugindocs/openid + plugindocs/persona Part 3: Plugin Writer's Guide diff --git a/docs/source/plugindocs/persona.rst b/docs/source/plugindocs/persona.rst new file mode 100644 index 00000000..2524127d --- /dev/null +++ b/docs/source/plugindocs/persona.rst @@ -0,0 +1,2 @@ +.. include:: ../../../mediagoblin/plugins/persona/README.rst + diff --git a/mediagoblin/plugins/persona/README.rst b/mediagoblin/plugins/persona/README.rst new file mode 100644 index 00000000..fd086129 --- /dev/null +++ b/mediagoblin/plugins/persona/README.rst @@ -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. |