couchdb-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From kxe...@apache.org
Subject [09/32] git commit: updated refs/heads/1781-reorganize-and-improve-docs to 11fd32a
Date Fri, 14 Jun 2013 08:25:06 GMT
Describe couch_httpd_auth config section.


Project: http://git-wip-us.apache.org/repos/asf/couchdb/repo
Commit: http://git-wip-us.apache.org/repos/asf/couchdb/commit/e93f3d30
Tree: http://git-wip-us.apache.org/repos/asf/couchdb/tree/e93f3d30
Diff: http://git-wip-us.apache.org/repos/asf/couchdb/diff/e93f3d30

Branch: refs/heads/1781-reorganize-and-improve-docs
Commit: e93f3d30dfa8a718f07b9b0325cd6ca68690b0cf
Parents: 5325b2c
Author: Alexander Shorin <kxepal@apache.org>
Authored: Tue Jun 11 18:29:47 2013 +0400
Committer: Alexander Shorin <kxepal@apache.org>
Committed: Tue Jun 11 21:28:43 2013 +0400

----------------------------------------------------------------------
 share/doc/build/Makefile.am               |   3 +
 share/doc/src/config/couch-httpd-auth.rst | 108 +++++++++++++++++++++++++
 share/doc/src/config/index.rst            |   1 +
 3 files changed, 112 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/couchdb/blob/e93f3d30/share/doc/build/Makefile.am
----------------------------------------------------------------------
diff --git a/share/doc/build/Makefile.am b/share/doc/build/Makefile.am
index 133a6bc..2a78dee 100644
--- a/share/doc/build/Makefile.am
+++ b/share/doc/build/Makefile.am
@@ -56,6 +56,7 @@ html_files = \
     html/_sources/config/admins.txt \
     html/_sources/config/attachments.txt \
     html/_sources/config/cors.txt \
+    html/_sources/config/couch-httpd-auth.txt \
     html/_sources/config/couchdb.txt \
     html/_sources/config/httpd.txt \
     html/_sources/config/index.txt \
@@ -112,6 +113,7 @@ html_files = \
     html/config/admins.html \
     html/config/attachments.html \
     html/config/cors.html \
+    html/config/couch-httpd-auth.html \
     html/config/couchdb.html \
     html/config/httpd.html \
     html/config/index.html \
@@ -166,6 +168,7 @@ src_files = \
     ../src/config/admins.rst \
     ../src/config/attachments.rst \
     ../src/config/cors.rst \
+    ../src/config/couch-httpd-auth.rst \
     ../src/config/couchdb.rst \
     ../src/config/httpd.rst \
     ../src/config/index.rst \

http://git-wip-us.apache.org/repos/asf/couchdb/blob/e93f3d30/share/doc/src/config/couch-httpd-auth.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/config/couch-httpd-auth.rst b/share/doc/src/config/couch-httpd-auth.rst
new file mode 100644
index 0000000..b0ebf35
--- /dev/null
+++ b/share/doc/src/config/couch-httpd-auth.rst
@@ -0,0 +1,108 @@
+.. Licensed under the Apache License, Version 2.0 (the "License"); you may not
+.. use this file except in compliance with the License. You may obtain a copy of
+.. the License at
+..
+..   http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+.. WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+.. License for the specific language governing permissions and limitations under
+.. the License.
+
+.. highlight:: ini
+
+.. _config/couch_httpd_auth:
+
+``[couch_httpd_auth]`` :: Authentication Configuration
+======================================================
+
+These options are under ``[couch_httpd_auth]`` section.
+
+
+.. _config/couch_httpd_auth/authentication_db:
+
+``authentication_db`` :: Users database
+---------------------------------------
+
+Specifies name of the system database for storing CouchDB users::
+
+  [couch_httpd_auth]
+  authentication_db = _users
+
+.. warning:: If there was any reasons to change this name for you, don't forget
+   to remove/cleanup old database since it wouldn't be protected by CouchDB
+   anymore.
+
+
+.. _config/couch_httpd_auth/authentication_redirect:
+
+``authentication_redirect`` :: Default redirect for authentication requests
+---------------------------------------------------------------------------
+
+Specifies location for redirection on successful authentication if ``text/html``
+response accepted by client (via ``Accept`` header)::
+
+  [couch_httpd_auth]
+  authentication_redirect = /_utils/session.html
+
+
+.. _config/couch_httpd_auth/auth_cache_size:
+
+``auth_cache_size`` :: Authentication cache
+-------------------------------------------
+
+Number of :ref:`userctx_object` to cache in memory to reduce disk lookups::
+
+  [couch_httpd_auth]
+  auth_cache_size = 50
+
+
+.. _config/couch_httpd_auth/allow_persistent_cookies:
+
+``allow_persistent_cookies`` :: Persistent cookies
+--------------------------------------------------
+
+Makes cookies persistent if ``true``::
+
+  [couch_httpd_auth]
+  allow_persistent_cookies = false
+
+
+.. _config/couch_httpd_auth/iterations:
+
+``iterations`` :: PBKDF2 iterations count
+-----------------------------------------
+
+.. versionadded:: 1.3
+
+Number of iterations for password hashing by PBKDF2 algorithm. Higher number
+provides better hash durability, but with cost of performance on each request
+that requires authentication::
+
+  [couch_httpd_auth]
+  iterations = 10000
+
+
+.. _config/couch_httpd_auth/require_valid_user:
+
+``require_valid_user`` :: Force users authentication
+----------------------------------------------------
+
+When this option ``true`` no requests allowed from anonymous users - everyone
+should be authenticated::
+
+  [couch_httpd_auth]
+  require_valid_user = false
+
+
+.. _config/couch_httpd_auth/timeout:
+
+``timeout`` :: Session timeout
+------------------------------
+
+Number of seconds since the last request before session will be expired::
+
+  [couch_httpd_auth]
+  timeout = 600
+

http://git-wip-us.apache.org/repos/asf/couchdb/blob/e93f3d30/share/doc/src/config/index.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/config/index.rst b/share/doc/src/config/index.rst
index b1a6a78..56353e2 100644
--- a/share/doc/src/config/index.rst
+++ b/share/doc/src/config/index.rst
@@ -50,6 +50,7 @@ Content:
    admins
    attachments
    cors
+   couch-httpd-auth
    couchdb
    httpd
    os-daemons


Mime
View raw message