heckyel/mediagoblin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

added basic_auth and openid docs to index and link them together

Browse Source
This commit is contained in:
Rodney Ewing 2013-07-09 12:57:57 -07:00
parent 2c4cdd096f
commit bd0ece0557
3 changed files with 13 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/source/index.rst
View File

@ -59,6 +59,8 @@ Part 2: Core plugin documentation
plugindocs/oauth plugindocs/oauth
plugindocs/trim_whitespace plugindocs/trim_whitespace
plugindocs/raven plugindocs/raven
plugindocs/basic_auth
plugindocs/openid
Part 3: Plugin Writer's Guide Part 3: Plugin Writer's Guide

6
mediagoblin/plugins/basic_auth/README.rst
View File

@ -1,5 +1,7 @@
.. _basic_auth-chapter:
=================== ===================
Basic_auth plugin basic_auth plugin
=================== ===================
The basic_auth plugin is enabled by default in mediagoblin.ini. This plugin The basic_auth plugin is enabled by default in mediagoblin.ini. This plugin
@ -8,7 +10,7 @@ provides basic username and password authentication for GNU Mediagoblin.
This plugin can be enabled alongside :ref:`openid-chapter` and This plugin can be enabled alongside :ref:`openid-chapter` and
:ref:`persona-chapter`. :ref:`persona-chapter`.
Set up the Basic_auth plugin Set up the basic_auth plugin
============================ ============================
1. Add the following to your MediaGoblin .ini file in the ``[plugins]`` section:: 1. Add the following to your MediaGoblin .ini file in the ``[plugins]`` section::

12
mediagoblin/plugins/openid/README.rst
View File

@ -1,21 +1,23 @@
.. _openid-chapter:
=================== ===================
Openid plugin openid plugin
=================== ===================
The Openid plugin allows user to login to your GNU Mediagoblin instance using The openid plugin allows user to login to your GNU Mediagoblin instance using
their openid url. their openid url.
This plugin can be enabled alongside :ref:`basic_auth-chapter` and This plugin can be enabled alongside :ref:`basic_auth-chapter` and
:ref:`persona-chapter`. :ref:`persona-chapter`.
.. note:: .. note::
When :reg:`basic_auth-chapter` is enabled alongside this Openid plugin, and 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 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 password to their account, they can use the forgot password feature to do
so. so.
Set up the Openid plugin Set up the openid plugin
============================ ============================
1. Install the ``python-openid`` package. 1. Install the ``python-openid`` package.