From 6a93bb4ef7d832419b2c607af20384556b5cbeea Mon Sep 17 00:00:00 2001 From: Rodney Ewing Date: Tue, 9 Jul 2013 12:31:01 -0700 Subject: basic_auth documentation --- mediagoblin/plugins/basic_auth/README.rst | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 mediagoblin/plugins/basic_auth/README.rst (limited to 'mediagoblin/plugins') diff --git a/mediagoblin/plugins/basic_auth/README.rst b/mediagoblin/plugins/basic_auth/README.rst new file mode 100644 index 00000000..65a7345e --- /dev/null +++ b/mediagoblin/plugins/basic_auth/README.rst @@ -0,0 +1,22 @@ +=================== + Basic_auth plugin +=================== + +The basic_auth plugin is enabled by default in mediagoblin.ini. This plugin +provides basic username and password authentication for GNU Mediagoblin. + +This plugin can be enabled alongside :ref:`openid-chapter` and +:ref:`persona-chapter`. + +Set up the Basic_auth plugin +============================ + +1. Add the following to your MediaGoblin .ini file in the ``[plugins]`` section:: + + [[mediagoblin.plugins.basic_auth]] + +2. Run:: + + gmg assetlink + + in order to link basic_auth's static assets -- cgit v1.2.3 From 2c4cdd096f77772ae1f07a163e68c033c0fe1b2c Mon Sep 17 00:00:00 2001 From: Rodney Ewing Date: Tue, 9 Jul 2013 12:34:13 -0700 Subject: added openid docs --- mediagoblin/plugins/openid/README.rst | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 mediagoblin/plugins/openid/README.rst (limited to 'mediagoblin/plugins') diff --git a/mediagoblin/plugins/openid/README.rst b/mediagoblin/plugins/openid/README.rst new file mode 100644 index 00000000..e753b0f9 --- /dev/null +++ b/mediagoblin/plugins/openid/README.rst @@ -0,0 +1,32 @@ +=================== + 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 :reg:`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. -- cgit v1.2.3 From bd0ece0557d7ac4cbbf77617b125060b8c083892 Mon Sep 17 00:00:00 2001 From: Rodney Ewing Date: Tue, 9 Jul 2013 12:57:57 -0700 Subject: added basic_auth and openid docs to index and link them together --- mediagoblin/plugins/basic_auth/README.rst | 6 ++++-- mediagoblin/plugins/openid/README.rst | 12 +++++++----- 2 files changed, 11 insertions(+), 7 deletions(-) (limited to 'mediagoblin/plugins') diff --git a/mediagoblin/plugins/basic_auth/README.rst b/mediagoblin/plugins/basic_auth/README.rst index 65a7345e..82f247ed 100644 --- a/mediagoblin/plugins/basic_auth/README.rst +++ b/mediagoblin/plugins/basic_auth/README.rst @@ -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 @@ -8,7 +10,7 @@ provides basic username and password authentication for GNU Mediagoblin. This plugin can be enabled alongside :ref:`openid-chapter` and :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:: diff --git a/mediagoblin/plugins/openid/README.rst b/mediagoblin/plugins/openid/README.rst index e753b0f9..870a2b58 100644 --- a/mediagoblin/plugins/openid/README.rst +++ b/mediagoblin/plugins/openid/README.rst @@ -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. This plugin can be enabled alongside :ref:`basic_auth-chapter` and :ref:`persona-chapter`. .. note:: - When :reg:`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 + 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 +Set up the openid plugin ============================ 1. Install the ``python-openid`` package. -- cgit v1.2.3 From 26d2cce85ef629a58d80def85fcda8e324d5d182 Mon Sep 17 00:00:00 2001 From: Rodney Ewing Date: Tue, 9 Jul 2013 13:31:32 -0700 Subject: added docs for the persona plugin --- mediagoblin/plugins/persona/README.rst | 41 ++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 mediagoblin/plugins/persona/README.rst (limited to 'mediagoblin/plugins') 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. -- cgit v1.2.3 From 94a566e60e79c39d74fdcbe668bca1d1d41d4aa3 Mon Sep 17 00:00:00 2001 From: Rodney Ewing Date: Tue, 9 Jul 2013 13:41:40 -0700 Subject: typo --- mediagoblin/plugins/persona/README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'mediagoblin/plugins') diff --git a/mediagoblin/plugins/persona/README.rst b/mediagoblin/plugins/persona/README.rst index fd086129..ef19ac5d 100644 --- a/mediagoblin/plugins/persona/README.rst +++ b/mediagoblin/plugins/persona/README.rst @@ -5,7 +5,7 @@ ================ The persona plugin allows users to login to you GNU MediaGoblin instance using -`Mozilla's Persona`_. +`Mozilla Persona`_. This plugin can be enabled alongside :ref:`openid-chapter` and :ref:`basic_auth-chapter`. @@ -16,7 +16,7 @@ This plugin can be enabled alongside :ref:`openid-chapter` and password to their account, they can use the forgot password feature to do so. -.. _Mozilla's Persona: https://www.mozilla.org/en-US/persona/ +.. _Mozilla Persona: https://www.mozilla.org/en-US/persona/ Set up the persona plugin ========================= -- cgit v1.2.3