You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@couchdb.apache.org by wo...@apache.org on 2017/09/30 20:45:00 UTC
[couchdb-documentation] branch master updated: httpd->chttpd for
2.x proxy auth and SSL support
This is an automated email from the ASF dual-hosted git repository.
wohali pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/couchdb-documentation.git
The following commit(s) were added to refs/heads/master by this push:
new 6cd1044 httpd->chttpd for 2.x proxy auth and SSL support
6cd1044 is described below
commit 6cd1044e1813fc054da8f911fd39ed8215a5bba6
Author: Joan Touzet <jo...@atypical.net>
AuthorDate: Wed Sep 27 14:37:38 2017 -0400
httpd->chttpd for 2.x proxy auth and SSL support
---
src/api/server/authn.rst | 4 ++--
src/config/http.rst | 34 +++++++++++++++++-----------------
src/config/services.rst | 4 ++--
src/whatsnew/1.6.rst | 2 +-
4 files changed, 22 insertions(+), 22 deletions(-)
diff --git a/src/api/server/authn.rst b/src/api/server/authn.rst
index e9532bc..05675f1 100644
--- a/src/api/server/authn.rst
+++ b/src/api/server/authn.rst
@@ -275,11 +275,11 @@ Proxy Authentication
.. note::
To use this authentication method make sure that the
``{couch_httpd_auth, proxy_authentication_handler}`` value in added to the
- list of the active :config:option:`httpd/authentication_handlers`:
+ list of the active :config:option:`chttpd/authentication_handlers`:
.. code-block:: ini
- [httpd]
+ [chttpd]
authentication_handlers = {couch_httpd_auth, cookie_authentication_handler}, {couch_httpd_auth, proxy_authentication_handler}, {couch_httpd_auth, default_authentication_handler}
`Proxy authentication` is very useful in case your application already uses
diff --git a/src/config/http.rst b/src/config/http.rst
index 2076b2f..7016317 100644
--- a/src/config/http.rst
+++ b/src/config/http.rst
@@ -34,21 +34,6 @@ HTTP Server Options
.. _JSONP: http://www.json-p.org/
- .. config:option:: 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_auth, cookie_authentication_handler}, {couch_httpd_auth, default_authentication_handler}
-
- - ``{couch_httpd_auth, cookie_authentication_handler}``: used for Cookie auth;
- - ``{couch_httpd_auth, proxy_authentication_handler}``: used for Proxy auth;
- - ``{couch_httpd_auth, default_authentication_handler}``: used for Basic auth;
- - ``{couch_httpd_auth, null_authentication_handler}``: disables auth.
- Everlasting `Admin Party`!
-
.. config:option:: bind_address :: Listen IP address
Defines the IP address by which CouchDB will be accessible::
@@ -241,7 +226,7 @@ HTTP Server Options
request bodies instead of document sizes. After the upgrade, it is
advisable to review the usage of these configuration settings.
-.. config:section:: chttpd :: HTTP Server Options
+.. config:section:: chttpd :: Clustered HTTP Server Options
.. config:option:: prefer_minimal :: Sends minimal set of headers
@@ -257,6 +242,21 @@ HTTP Server Options
the CouchDB server header is replaced with the
Mochiweb server header.
+ .. config:option:: authentication_handlers :: Authentication handlers
+
+ List of authentication handlers 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::
+
+ [chttpd]
+ authentication_handlers = {couch_httpd_auth, cookie_authentication_handler}, {couch_httpd_auth, default_authentication_handler}
+
+ - ``{couch_httpd_auth, cookie_authentication_handler}``: used for Cookie auth;
+ - ``{couch_httpd_auth, proxy_authentication_handler}``: used for Proxy auth;
+ - ``{couch_httpd_auth, default_authentication_handler}``: used for Basic auth;
+ - ``{couch_httpd_auth, null_authentication_handler}``: disables auth.
+ Everlasting `Admin Party`!
+
.. _config/ssl:
Secure Socket Level Options
@@ -295,7 +295,7 @@ Secure Socket Level Options
At first, :option:`enable the HTTPS daemon <daemons/httpsd>`::
[daemons]
- httpsd = {couch_httpd, start_link, [https]}
+ httpsd = {chttpd, start_link, [https]}
Next, under the ``[ssl]`` section set up the newly generated certificates::
diff --git a/src/config/services.rst b/src/config/services.rst
index 24d07af..983c7f8 100644
--- a/src/config/services.rst
+++ b/src/config/services.rst
@@ -48,7 +48,7 @@ CouchDB Daemonized Mini Apps
.. config:option:: httpd
- HTTP server daemon::
+ Node-local HTTP server daemon (default port: `5986`)::
[daemons]
httpd={couch_httpd, start_link, []}
@@ -59,7 +59,7 @@ CouchDB Daemonized Mini Apps
listens on is `6984`::
[daemons]
- httpsd = {couch_httpd, start_link, [https]}
+ httpsd = {chttpd, start_link, [https]}
.. config:option:: index_server
diff --git a/src/whatsnew/1.6.rst b/src/whatsnew/1.6.rst
index 656cf26..cb52c51 100644
--- a/src/whatsnew/1.6.rst
+++ b/src/whatsnew/1.6.rst
@@ -29,7 +29,7 @@ The :ref:`Proxy Authentication <api/auth/proxy>` handler was renamed to
``proxy_authentication_handler`` to follow the ``*_authentication_handler`` form
of all other handlers. The old ``proxy_authentification_handler`` name is marked
as deprecated and will be removed in future releases. It's strongly recommended
-to update :config:option:`httpd/authentication_handlers` option with new value
+to update ``httpd/authentication_handlers`` option with new value
in case if you had used such handler.
.. _release/1.6.0:
--
To stop receiving notification emails like this one, please contact
['"commits@couchdb.apache.org" <co...@couchdb.apache.org>'].