Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id 619DA200D13 for ; Sat, 30 Sep 2017 20:43:28 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id 6060A1609C2; Sat, 30 Sep 2017 18:43:28 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id 806A81609D5 for ; Sat, 30 Sep 2017 20:43:27 +0200 (CEST) Received: (qmail 37461 invoked by uid 500); 30 Sep 2017 18:43:26 -0000 Mailing-List: contact commits-help@couchdb.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@couchdb.apache.org Delivered-To: mailing list commits@couchdb.apache.org Received: (qmail 37452 invoked by uid 99); 30 Sep 2017 18:43:26 -0000 Received: from ec2-52-202-80-70.compute-1.amazonaws.com (HELO gitbox.apache.org) (52.202.80.70) by apache.org (qpsmtpd/0.29) with ESMTP; Sat, 30 Sep 2017 18:43:26 +0000 Received: by gitbox.apache.org (ASF Mail Server at gitbox.apache.org, from userid 33) id 46E91816D6; Sat, 30 Sep 2017 18:43:24 +0000 (UTC) Date: Sat, 30 Sep 2017 18:43:25 +0000 To: "commits@couchdb.apache.org" Subject: [couchdb-documentation] 01/01: httpd->chttpd for 2.x proxy auth and SSL support MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit From: wohali@apache.org In-Reply-To: <150679700404.18119.1674209932115895830@gitbox.apache.org> References: <150679700404.18119.1674209932115895830@gitbox.apache.org> X-Git-Host: gitbox.apache.org X-Git-Repo: couchdb-documentation X-Git-Refname: refs/heads/proxy-auth-fixup X-Git-Reftype: branch X-Git-Rev: b0e863d26165875cbfb73f5bdfe1871c5ac920c8 X-Git-NotificationType: diff X-Git-Multimail-Version: 1.5.dev Auto-Submitted: auto-generated Message-Id: <20170930184325.46E91816D6@gitbox.apache.org> archived-at: Sat, 30 Sep 2017 18:43:28 -0000 This is an automated email from the ASF dual-hosted git repository. wohali pushed a commit to branch proxy-auth-fixup in repository https://gitbox.apache.org/repos/asf/couchdb-documentation.git commit b0e863d26165875cbfb73f5bdfe1871c5ac920c8 Author: Joan Touzet 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..4b5c5a8 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 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:: + + [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 = {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 ` 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" .