.. 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.

Configuration Reference
=======================


Configuration Groups
--------------------

+----------------------------------+-------------------------------------------+
| Section                          | Description                               |
+==================================+===========================================+
| attachments                      | Attachment options                        |
+----------------------------------+-------------------------------------------+
| couchdb                          | CouchDB specific options                  |
+----------------------------------+-------------------------------------------+
| couch_httpd_auth                 | HTTPD Authentication options              |
+----------------------------------+-------------------------------------------+
| daemons                          | Daemons and background processes          |
+----------------------------------+-------------------------------------------+
| httpd                            | HTTPD Server options                      |
+----------------------------------+-------------------------------------------+
| httpd_db_handlers                | Database Operation handlers               |
+----------------------------------+-------------------------------------------+
| httpd_design_handlers            | Handlers for design document operations   |
+----------------------------------+-------------------------------------------+
| httpd_global_handlers            | Handlers for global operations            |
+----------------------------------+-------------------------------------------+
| log                              | Logging options                           |
+----------------------------------+-------------------------------------------+
| query_servers                    | Query Server options                      |
+----------------------------------+-------------------------------------------+
| query_server_config              | Query server options                      |
+----------------------------------+-------------------------------------------+
| replicator                       | Replicator Options                        |
+----------------------------------+-------------------------------------------+
| ssl                              | SSL (Secure Sockets Layer) Options        |
+----------------------------------+-------------------------------------------+
| stats                            | Statistics options                        |
+----------------------------------+-------------------------------------------+
| uuids                            | UUID generation options                   |
+----------------------------------+-------------------------------------------+
| cors                             | Cross Origin Resource Sharing settings    |
+----------------------------------+-------------------------------------------+

attachments Configuration Options
---------------------------------

+--------------------------------------+---------------------------------------+
| Option                               | Description                           |
+======================================+=======================================+
| compressible_types                   | compressible_types                    |
+--------------------------------------+---------------------------------------+
| compression_level                    | compression_level                     |
+--------------------------------------+---------------------------------------+

couchdb Configuration Options
-----------------------------

+--------------------------------------+---------------------------------------+
| Option                               | Description                           |
+======================================+=======================================+
| database_dir                         | database_dir                          |
+--------------------------------------+---------------------------------------+
| delayed_commits                      | delayed_commits                       |
+--------------------------------------+---------------------------------------+
| max_attachment_chunk_size            | max_attachment_chunk_size             |
+--------------------------------------+---------------------------------------+
| max_dbs_open                         | max_dbs_open                          |
+--------------------------------------+---------------------------------------+
| max_document_size                    | max_document_size                     |
+--------------------------------------+---------------------------------------+
| os_process_timeout                   | os_process_timeout                    |
+--------------------------------------+---------------------------------------+
| uri_file                             | uri_file                              |
+--------------------------------------+---------------------------------------+
| util_driver_dir                      | util_driver_dir                       |
+--------------------------------------+---------------------------------------+
| view_index_dir                       | view_index_dir                        |
+--------------------------------------+---------------------------------------+

daemons Configuration Options
-----------------------------

+--------------------------------------+---------------------------------------+
| Option                               | Description                           |
+======================================+=======================================+
| auth_cache                           | auth_cache                            |
+--------------------------------------+---------------------------------------+
| db_update_notifier                   | db_update_notifier                    |
+--------------------------------------+---------------------------------------+
| external_manager                     | external_manager                      |
+--------------------------------------+---------------------------------------+
| httpd                                | httpd                                 |
+--------------------------------------+---------------------------------------+
| httpsd                               | Enabled HTTPS service                 |
+--------------------------------------+---------------------------------------+
| query_servers                        | query_servers                         |
+--------------------------------------+---------------------------------------+
| stats_aggregator                     | stats_aggregator                      |
+--------------------------------------+---------------------------------------+
| stats_collector                      | stats_collector                       |
+--------------------------------------+---------------------------------------+
| uuids                                | uuids                                 |
+--------------------------------------+---------------------------------------+
| view_manager                         | view_manager                          |
+--------------------------------------+---------------------------------------+

httpd_db_handlers Configuration Options
---------------------------------------

+--------------------------------------+---------------------------------------+
| Option                               | Description                           |
+======================================+=======================================+
| _changes                             | _changes                              |
+--------------------------------------+---------------------------------------+
| _compact                             | _compact                              |
+--------------------------------------+---------------------------------------+
| _design                              | _design                               |
+--------------------------------------+---------------------------------------+
| _temp_view                           | _temp_view                            |
+--------------------------------------+---------------------------------------+
| _view_cleanup                        | _view_cleanup                         |
+--------------------------------------+---------------------------------------+

.. _config-couch_httpd_auth:

couch_httpd_auth Configuration Options
--------------------------------------

+--------------------------------------+---------------------------------------+
| Option                               | Description                           |
+======================================+=======================================+
| auth_cache_size                      | auth_cache_size                       |
+--------------------------------------+---------------------------------------+
| authentication_db                    | authentication_db                     |
+--------------------------------------+---------------------------------------+
| authentication_redirect              | authentication_redirect               |
+--------------------------------------+---------------------------------------+
| require_valid_user                   | require_valid_user                    |
+--------------------------------------+---------------------------------------+
| timeout                              | timeout                               |
+--------------------------------------+---------------------------------------+
| iterations                           | Password key derivation iterations    |
+--------------------------------------+---------------------------------------+
| users_db_public                      | Allow all users to view user documents|
+--------------------------------------+---------------------------------------+
| public_fields                        | World-viewable user document fields   |
+--------------------------------------+---------------------------------------+

.. note::
   Using the `public_fields` whitelist for user document properties requires
   setting the `users_db_public` option to `true` (the latter option has no
   other purpose).

httpd Configuration Options
---------------------------

+--------------------------------------+---------------------------------------+
| Option                               | Description                           |
+======================================+=======================================+
| allow_jsonp                          | allow_jsonp                           |
+--------------------------------------+---------------------------------------+
| authentication_handlers              | authentication_handlers               |
+--------------------------------------+---------------------------------------+
| bind_address                         | bind_address                          |
+--------------------------------------+---------------------------------------+
| default_handler                      | default_handler                       |
+--------------------------------------+---------------------------------------+
| max_connections                      | max_connections                       |
+--------------------------------------+---------------------------------------+
| nodelay                              | Enable TCP_NODELAY                    |
+--------------------------------------+---------------------------------------+
| port                                 | port                                  |
+--------------------------------------+---------------------------------------+
| secure_rewrites                      | secure_rewrites                       |
+--------------------------------------+---------------------------------------+
| vhost_global_handlers                | vhost_global_handlers                 |
+--------------------------------------+---------------------------------------+
| enable_cors                          | enables CORS functionality when true  |
+--------------------------------------+---------------------------------------+

httpd_design_handlers Configuration Options
-------------------------------------------

+--------------------------------------+---------------------------------------+
| Option                               | Description                           |
+======================================+=======================================+
| _info                                | _info                                 |
+--------------------------------------+---------------------------------------+
| _list                                | _list                                 |
+--------------------------------------+---------------------------------------+
| _rewrite                             | _rewrite                              |
+--------------------------------------+---------------------------------------+
| _show                                | _show                                 |
+--------------------------------------+---------------------------------------+
| _update                              | _update                               |
+--------------------------------------+---------------------------------------+
| _view                                | _view                                 |
+--------------------------------------+---------------------------------------+

httpd_global_handlers Configuration Options
-------------------------------------------

+--------------------------------------+---------------------------------------+
| Option                               | Description                           |
+======================================+=======================================+
| /                                    | /                                     |
+--------------------------------------+---------------------------------------+
| _active_tasks                        | _active_tasks                         |
+--------------------------------------+---------------------------------------+
| _all_dbs                             | _all_dbs                              |
+--------------------------------------+---------------------------------------+
| _config                              | _config                               |
+--------------------------------------+---------------------------------------+
| _log                                 | _log                                  |
+--------------------------------------+---------------------------------------+
| _oauth                               | _oauth                                |
+--------------------------------------+---------------------------------------+
| _replicate                           | _replicate                            |
+--------------------------------------+---------------------------------------+
| _restart                             | _restart                              |
+--------------------------------------+---------------------------------------+
| _session                             | _session                              |
+--------------------------------------+---------------------------------------+
| _stats                               | _stats                                |
+--------------------------------------+---------------------------------------+
| _utils                               | _utils                                |
+--------------------------------------+---------------------------------------+
| _uuids                               | _uuids                                |
+--------------------------------------+---------------------------------------+
| favicon.ico                          | favicon.ico                           |
+--------------------------------------+---------------------------------------+

log Configuration Options
-------------------------

+--------------------------------------+---------------------------------------+
| Option                               | Description                           |
+======================================+=======================================+
| file                                 | file                                  |
+--------------------------------------+---------------------------------------+
| include_sasl                         | include_sasl                          |
+--------------------------------------+---------------------------------------+
| level                                | level                                 |
+--------------------------------------+---------------------------------------+

query_servers Configuration Options
-----------------------------------

+--------------------------------------+---------------------------------------+
| Option                               | Description                           |
+======================================+=======================================+
| javascript                           | javascript                            |
+--------------------------------------+---------------------------------------+

query_server_config Configuration Options
-----------------------------------------

+--------------------------------------+---------------------------------------+
| Option                               | Description                           |
+======================================+=======================================+
| reduce_limit                         | reduce_limit                          |
+--------------------------------------+---------------------------------------+

replicator Configuration Options
--------------------------------

+--------------------------------------+---------------------------------------+
| Option                               | Description                           |
+======================================+=======================================+
| max_http_pipeline_size               | max_http_pipeline_size                |
+--------------------------------------+---------------------------------------+
| max_http_sessions                    | max_http_sessions                     |
+--------------------------------------+---------------------------------------+

stats Configuration Options
---------------------------

+--------------------------------------+---------------------------------------+
| Option                               | Description                           |
+======================================+=======================================+
| rate                                 | rate                                  |
+--------------------------------------+---------------------------------------+
| samples                              | samples                               |
+--------------------------------------+---------------------------------------+

uuids Configuration Options
---------------------------

+--------------------------------------+---------------------------------------+
| Option                               | Description                           |
+======================================+=======================================+
| algorithm                            | algorithm                             |
+--------------------------------------+---------------------------------------+


cors Configuration Options
---------------------------

+--------------------------------------+---------------------------------------+
| Option                               | Description                           |
+======================================+=======================================+
| origins                              | List of origins, separated by a comma |
|                                      | (protocol, host, optional port)       |
+--------------------------------------+---------------------------------------+
| methods                              | accepted HTTP methods                 |
+--------------------------------------+---------------------------------------+
| credentials                          | `true` sends additional header        |
|                                      | Access-Control-Allow-Credentials=true |
+--------------------------------------+---------------------------------------+

Note that `credentials=true` and `origins=*` are mutually exclusive.

cors vhost Configuration
------------------------

The same configuration options for `cors` overall may be applied to an
individual vhost, within a specific section header, for `example.com` the
appropriate section would be: `[cors:http://example.com]`