Skip to content

Commit

Permalink
httpd->chttpd for 2.x proxy auth and SSL support
Browse files Browse the repository at this point in the history
  • Loading branch information
wohali committed Sep 30, 2017
1 parent 9f8cd38 commit 6cd1044
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 22 deletions.
4 changes: 2 additions & 2 deletions src/api/server/authn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
34 changes: 17 additions & 17 deletions src/config/http.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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::
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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::

Expand Down
4 changes: 2 additions & 2 deletions src/config/services.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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, []}
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/whatsnew/1.6.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 6cd1044

Please sign in to comment.