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/06/14 10:25:09 UTC
[12/32] git commit: updated
refs/heads/1781-reorganize-and-improve-docs to 11fd32a
Sort httpd options.
Project: http://git-wip-us.apache.org/repos/asf/couchdb/repo
Commit: http://git-wip-us.apache.org/repos/asf/couchdb/commit/0097a537
Tree: http://git-wip-us.apache.org/repos/asf/couchdb/tree/0097a537
Diff: http://git-wip-us.apache.org/repos/asf/couchdb/diff/0097a537
Branch: refs/heads/1781-reorganize-and-improve-docs
Commit: 0097a537bbab99ab6570c68f0c5c2719d29eea87
Parents: 12d6511
Author: Alexander Shorin <kx...@apache.org>
Authored: Tue Jun 11 20:11:01 2013 +0400
Committer: Alexander Shorin <kx...@apache.org>
Committed: Tue Jun 11 21:28:43 2013 +0400
----------------------------------------------------------------------
share/doc/src/config/httpd.rst | 180 ++++++++++++++++++------------------
1 file changed, 90 insertions(+), 90 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/couchdb/blob/0097a537/share/doc/src/config/httpd.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/config/httpd.rst b/share/doc/src/config/httpd.rst
index 441b100..554c88c 100644
--- a/share/doc/src/config/httpd.rst
+++ b/share/doc/src/config/httpd.rst
@@ -19,6 +19,33 @@
These options are under ``[httpd]`` section.
+.. _config/httpd/allow_jsonp:
+
+``allow_jsonp`` :: Enables JSONP support
+----------------------------------------
+
+::
+
+ [httpd]
+ allow_jsonp = false
+
+
+.. _config/httpd/authentication_handlers:
+
+``authentication_handlers`` :: Authentication handlers
+------------------------------------------------------
+
+List of used authentication handlers that used by CouchDB. You may extend them
+via third-party plugins or remove some of them if you won't let users to use one
+of provided methods::
+
+ [httpd]
+ authentication_handlers = {couch_httpd_oauth, oauth_authentication_handler}, {couch_httpd_auth, cookie_authentication_handler}, {couch_httpd_auth, default_authentication_handler}
+
+- ``{couch_httpd_oauth, oauth_authentication_handler}`` - handles OAuth;
+- ``{couch_httpd_auth, cookie_authentication_handler}`` - used for Cookie auth;
+- ``{couch_httpd_auth, default_authentication_handler}`` - used for Basic auth;
+
.. _config/httpd/bind_address:
@@ -47,84 +74,87 @@ or ``::`` for any available::
bind_address = ::
-.. _config/httpd/port:
-
-``port`` :: Listen port
------------------------
-
-Defined the port number to listen::
+.. _config/httpd/config_whitelist:
- [httpd]
- port = 5984
+``config_whitelist`` :: Config options while list
+-------------------------------------------------
-To let CouchDB handle any free port, set this option to ``0``::
+Sets the configuration modification whitelist. Only whitelisted values may be
+changed via the :ref:`config API <api/config>`. To allow the admin to change
+this value over HTTP, remember to include ``{httpd,config_whitelist}`` itself.
+Excluding it from the list would require editing this file to update the
+whitelist::
[httpd]
- port = 0
-
-After that, CouchDB URI could be located within the URI file.
+ config_whitelist = [{httpd,config_whitelist}, {log,level}, {etc,etc}]
-.. _config/httpd/authentication_handlers:
+.. _config/httpd/default_handler:
-``authentication_handlers`` :: Authentication handlers
-------------------------------------------------------
+``default_handler`` :: Default request handler
+----------------------------------------------
-List of used authentication handlers that used by CouchDB. You may extend them
-via third-party plugins or remove some of them if you won't let users to use one
-of provided methods::
+Specifies default HTTP requests handler::
[httpd]
- authentication_handlers = {couch_httpd_oauth, oauth_authentication_handler}, {couch_httpd_auth, cookie_authentication_handler}, {couch_httpd_auth, default_authentication_handler}
+ default_handler = {couch_httpd_db, handle_request}
-* ``{couch_httpd_oauth, oauth_authentication_handler}`` - handles OAuth;
-* ``{couch_httpd_auth, cookie_authentication_handler}`` - used for Cookie auth;
-* ``{couch_httpd_auth, default_authentication_handler}`` - used for Basic auth;
+.. _config/httpd/enable_cors:
-.. _config/httpd/default_handler:
+``enable_cors`` :: Activates CORS
+---------------------------------
-``default_handler`` :: Default request handler
-----------------------------------------------
+.. versionadded:: 1.3
-Specifies default HTTP requests handler::
+Controls :ref:`CORS <config/cors>` feature::
[httpd]
- default_handler = {couch_httpd_db, handle_request}
+ enable_cors = false
-.. _config/httpd/secure_rewrites:
+.. _config/httpd/log_max_chunk_size:
-``secure_rewrites`` :: Default request handler
-----------------------------------------------
+``log_max_chunk_size`` :: Logs chunk size
+-----------------------------------------
-This option allow to isolate databases via subdomains::
+Defines maximum chunk size in bytes for :ref:`_log <api/misc/log>` resource::
[httpd]
- secure_rewrites = true
+ log_max_chunk_size = 1000000
-.. _config/httpd/vhost_global_handlers:
+.. _config/httpd/port:
-``vhost_global_handlers`` :: Virtual hosts global handlers
-----------------------------------------------------------
+``port`` :: Listen port
+-----------------------
-List of global handlers that are available for
-:ref:`virtual hosts <config/vhosts>`::
+Defined the port number to listen::
[httpd]
- vhost_global_handlers = _utils, _uuids, _session, _oauth, _users
+ port = 5984
+To let CouchDB handle any free port, set this option to ``0``::
-.. _config/httpd/allow_jsonp:
+ [httpd]
+ port = 0
-``allow_jsonp`` :: Enables JSONP support
-----------------------------------------
+After that, CouchDB URI could be located within the URI file.
-::
+
+.. _config/httpd/redirect_vhost_handler:
+
+``redirect_vhost_handler`` :: Virtual Hosts custom redirect handler
+-------------------------------------------------------------------
+
+This option allows to change the default function that handles requests to
+:ref:`virtual hosts <config/vhosts>`::
[httpd]
- allow_jsonp = false
+ redirect_vhost_handler = {Module, Fun}
+
+Specified function take 2 arguments: the Mochiweb request object and the target
+path.
.. _config/httpd/server_options:
@@ -142,6 +172,17 @@ configuration files::
.. _MochiWeb: https://github.com/mochi/mochiweb
+.. _config/httpd/secure_rewrites:
+
+``secure_rewrites`` :: Default request handler
+----------------------------------------------
+
+This option allow to isolate databases via subdomains::
+
+ [httpd]
+ secure_rewrites = true
+
+
.. _config/httpd/socket_options:
``socket_options`` :: Socket Options
@@ -160,28 +201,16 @@ TCP/IP stack. A list of the supported options are provided in the
.. _Erlang inet: http://www.erlang.org/doc/man/inet.html#setopts-2
-.. _config/httpd/log_max_chunk_size:
-
-``log_max_chunk_size`` :: Logs chunk size
------------------------------------------
-
-Defines maximum chunk size in bytes for :ref:`_log <api/misc/log>` resource::
-
- [httpd]
- log_max_chunk_size = 1000000
-
-
-.. _config/httpd/enable_cors:
-
-``enable_cors`` :: Activates CORS
----------------------------------
+.. _config/httpd/vhost_global_handlers:
-.. versionadded:: 1.3
+``vhost_global_handlers`` :: Virtual hosts global handlers
+----------------------------------------------------------
-Controls :ref:`CORS <config/cors>` feature::
+List of global handlers that are available for
+:ref:`virtual hosts <config/vhosts>`::
[httpd]
- enable_cors = false
+ vhost_global_handlers = _utils, _uuids, _session, _oauth, _users
.. _config/httpd/WWW-Authenticate:
@@ -194,32 +223,3 @@ Set this option to trigger basic-auth popup on unauthorized requests::
[httpd]
WWW-Authenticate = Basic realm="Welcome to the Couch!"
-
-.. _config/httpd/config_whitelist:
-
-``config_whitelist`` :: Config options while list
--------------------------------------------------
-
-Sets the configuration modification whitelist. Only whitelisted values may be
-changed via the :ref:`config API <api/config>`. To allow the admin to change
-this value over HTTP, remember to include ``{httpd,config_whitelist}`` itself.
-Excluding it from the list would require editing this file to update the
-whitelist::
-
- [httpd]
- config_whitelist = [{httpd,config_whitelist}, {log,level}, {etc,etc}]
-
-
-.. _config/httpd/redirect_vhost_handler:
-
-``redirect_vhost_handler`` :: Virtual Hosts custom redirect handler
--------------------------------------------------------------------
-
-This option allows to change the default function that handles requests to
-:ref:`virtual hosts <config/vhosts>`::
-
- [httpd]
- redirect_vhost_handler = {Module, Fun}
-
-Specified function take 2 arguments: the Mochiweb request object and the target
-path.