You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@couchdb.apache.org by kx...@apache.org on 2013/08/09 10:57:15 UTC
[3/9] git commit: updated refs/heads/1781-reorganize-and-improve-docs
to f2a0c93
Add auth API references for config. Small cleanup.
Project: http://git-wip-us.apache.org/repos/asf/couchdb/repo
Commit: http://git-wip-us.apache.org/repos/asf/couchdb/commit/dbd7643d
Tree: http://git-wip-us.apache.org/repos/asf/couchdb/tree/dbd7643d
Diff: http://git-wip-us.apache.org/repos/asf/couchdb/diff/dbd7643d
Branch: refs/heads/1781-reorganize-and-improve-docs
Commit: dbd7643decef9dbaa08233a78c8d6527505192b4
Parents: d8d0805
Author: Alexander Shorin <kx...@apache.org>
Authored: Fri Aug 9 00:17:36 2013 +0400
Committer: Alexander Shorin <kx...@apache.org>
Committed: Fri Aug 9 00:17:36 2013 +0400
----------------------------------------------------------------------
share/doc/src/config/auth.rst | 21 +++++++++++----------
1 file changed, 11 insertions(+), 10 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/couchdb/blob/dbd7643d/share/doc/src/config/auth.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/config/auth.rst b/share/doc/src/config/auth.rst
index 16c2012..e2229cf 100644
--- a/share/doc/src/config/auth.rst
+++ b/share/doc/src/config/auth.rst
@@ -173,7 +173,7 @@ that requires authentication::
---------------------------------------------------------
When this option ``true`` the :ref:`secret <config/couch_httpd_auth/secret>` is
-required for `Proxy Auth`::
+required for :ref:`api/auth/proxy`::
[couch_httpd_auth]
proxy_use_secret = false
@@ -221,7 +221,7 @@ should be authenticated::
``secret`` :: Proxy Auth secret token
-------------------------------------
-The secret token used for `Proxy Auth` authentication method::
+The secret token used for :ref:`api/auth/proxy` method::
[couch_httpd_auth]
secret = 92de07df7e7a3fe14808cef90a7cc0d91
@@ -259,7 +259,7 @@ all users documents while users may browse only their own document::
-------------------------------------------
HTTP header name (``X-Auth-CouchDB-Roles`` by default) that contains the list of
-user's roles separated by a comma. Used for `Proxy Auth`::
+user's roles separated by a comma. Used for :ref:`api/auth/proxy`::
[couch_httpd_auth]
x_auth_roles = X-Auth-CouchDB-Roles
@@ -276,7 +276,7 @@ authenticate the authorization. This token is an `HMAC-SHA1` created from
:ref:`username <config/couch_httpd_auth/x_auth_username>`. The secret key
should be the same in the client and CouchDB node. This token is optional
if value of :ref:`proxy_use_secret <config/couch_httpd_auth/proxy_use_secret>`
-option isn't ``true``. Used for `Proxy Auth`::
+option isn't ``true``. Used for :ref:`api/auth/proxy`::
[couch_httpd_auth]
x_auth_roles = X-Auth-CouchDB-Token
@@ -288,7 +288,7 @@ option isn't ``true``. Used for `Proxy Auth`::
-------------------------------------------------
HTTP header name (``X-Auth-CouchDB-UserName`` by default) containing the
-username. Used for `Proxy Auth`::
+username. Used for :ref:`api/auth/proxy`::
[couch_httpd_auth]
x_auth_username = X-Auth-CouchDB-UserName
@@ -307,8 +307,9 @@ username. Used for `Proxy Auth`::
Store credentials within config
-------------------------------
-To let users be authenticated by `OAuth` (:rfc:`5849`) method there is need to
-setup three special sections in :ref:`configuration <config>` file:
+To let users be authenticated by :ref:`api/auth/oauth` (:rfc:`5849`) method
+there is need to setup three special sections in :ref:`configuration <config>`
+file:
1. Consumer secret:
@@ -338,10 +339,10 @@ setup three special sections in :ref:`configuration <config>` file:
Store OAuth credentials within auth database
--------------------------------------------
-.. versionadded:: 1.2: CouchDB is able to store OAuth credentials within users
- documents instead of config file.
+.. versionadded:: 1.2
-::
+CouchDB is able to store OAuth credentials within users documents instead of
+config file by using next option::
[couch_httpd_oauth]
use_users_db = true