Configuration Reference — Apache CouchDB 2.0 Documentation

### Navigation

- API Reference
- Config Reference |
- Apache CouchDB 2.0 Documentation »

# Configuration Reference

| admins |
| `admins` | Server Administrators
| attachments |
| `attachments` | Configuration of Attachment Storage
| `compressible_types` |
| `compression_level` |
| compaction_daemon |
| `compaction_daemon` | Configuration of Compaction Daemon
| `check_interval` |
| `min_file_size` |
| compactions |
| `compactions` | Compaction Daemon Rules
| cors |
| `cors` | Cross-Origin Resource Sharing
| `credentials` |
| `headers` |
| `methods` |
| `origins` |
| couch_httpd_auth |
| `couch_httpd_auth` | Authentication Configuration
| `allow_persistent_cookies` | Persistent cookies
| `auth_cache_size` | Authentication cache
| `authentication_db` | Users database
| `authentication_redirect` | Default redirect for authentication requests
| `iterations` | PBKDF2 iterations count
| `max_iterations` | Maximum PBKDF2 iterations count
| `min_iterations` | Minimum PBKDF2 iterations count
| `proxy_use_secret` | Force proxy auth use secret token
| `public_fields` | User documents public fields
| `require_valid_user` | Force user authentication
| `secret` | Authentication secret token
| `timeout` | Session timeout
| `users_db_public` | Publish user documents
| `x_auth_roles` | Proxy Auth roles header
| `x_auth_token` | Proxy Auth token header
| `x_auth_username` | Proxy Auth username header
| couch_httpd_oauth |
| `couch_httpd_oauth` | HTTP OAuth Configuration
| `use_users_db` |
| couch_peruser |
| `couch_peruser` | couch_peruser Options
| `delete_dbs` |
| `enable` |
| couchdb |
| `couchdb` | Base CouchDB Options
| `attachment_stream_buffer_size` | Attachment streaming buffer
| `database_dir` | Databases location directory
| `delayed_commits` | Delayed commits
| `file_compression` | Compression method for documents
| `fsync_options` | Fsync options
| `maintenance_mode` | Maintenance mode
| `max_dbs_open` | Limit of simultaneously opened databases
| `max_document_size` | Maximum document size
| `os_process_timeout` | External processes time limit
| `uri_file` | Discovery CouchDB help file
| `util_driver_dir` | CouchDB binary utility drivers
| `uuid` | CouchDB server UUID
| `view_index_dir` | View indexes location directory
| csp |
| `csp` | Content-Security-Policy
| `enable` |
| `header_value` |
| daemons |
| `daemons` | CouchDB Daemonized Mini Apps
| `auth_cache` |
| `compaction_daemon` |
| `external_manager` |
| `httpd` |
| `httpsd` |
| `index_server` |
| `os_daemons` |
| `query_servers` |
| `replicator_manager` |
| `stats_aggregator` |
| `stats_collector` |
| `uuids` |
| `vhosts` |
| database_compaction |
| `database_compaction` | Database Compaction Options
| `checkpoint_after` | Checkpoint trigger
| `doc_buffer_size` | Documents buffer size
| httpd |
| `httpd` | HTTP Server Options
| `WWW-Authenticate` | Force basic auth
| `allow_jsonp` | Enables JSONP support
| `authentication_handlers` | Authentication handlers
| `bind_address` | Listen IP address
| `changes_timeout` | Changes feed timeout
| `config_whitelist` | Config options while list
| `default_handler` | Default request handler
| `enable_cors` | Activates CORS
| `log_max_chunk_size` | Logs chunk size
| `port` | Listen port
| `redirect_vhost_handler` | Virtual Hosts custom redirect handler
| `secure_rewrites` | Default request handler
| `server_options` | MochiWeb Server Options
| `socket_options` | Socket Options
| `vhost_global_handlers` | Virtual hosts global handlers
| `x_forwarded_host` | X-Forwarder-Host
| `x_forwarded_proto` | X-Forwarder-Proto
| `x_forwarded_ssl` | X-Forwarder-Ssl
| httpd_db_handlers |
| `httpd_db_handlers` | Database HTTP Handlers
| `_all_docs` |
| `_changes` |
| `_compact` |
| `_design` |
| `_design_docs` |
| `_local_docs` |
| `_view_cleanup` |
| httpd_design_handlers |
| `httpd_design_handlers` | Design Documents HTTP Handlers
| `_compact` |
| `_info` |
| `_list` |
| `_rewrite` |
| `_show` |
| `_update` |
| `_view` |
| httpd_global_handlers |
| `httpd_global_handlers` | Global HTTP Handlers
| `/` |
| `_active_tasks` |
| `_all_dbs` |
| `_config` |
| `_log` |
| `_oauth` |
| `_replicate` |
| `_restart` |
| `_session` |
| `_stats` |
| `_utils` |
| `_uuids` |
| `favicon.ico` |
| log |
| `log` | Logging options
| `file` | Logging file path
| `include_sasl` |
| `level` | Logging verbose level
| log_level_by_module |
| `log_level_by_module` | Per module logging
| native_query_servers |
| `native_query_servers` | Native Erlang Query Server
| oauth_* |
| `oauth_*` | OAuth Configuration
| os_daemon_settings |
| `os_daemon_settings` | OS Daemons settings
| `max_retries` | Maximum restart retries
| `retry_time` | Delay between restart attempts
| os_daemons |
| `os_daemons` | OS Daemons
| query_server_config |
| `query_server_config` | Query Servers Configuration
| `commit_freq` | View index commit delay
| `os_process_limit` | Query Server operation timeout
| `reduce_limit` | Reduce limit control
| query_servers |
| `query_servers` | Query Servers Definition
| replicator |
| `replicator` | Replicator Database Configuration
| `cert_file` |
| `checkpoint_interval` |
| `connection_timeout` |
| `http_connections` |
| `key_file` |
| `max_replication_retry_count` |
| `password` |
| `retries_per_request` |
| `socket_options` |
| `ssl_certificate_max_depth` |
| `ssl_trusted_certificates_file` |
| `use_checkpoints` |
| `verify_ssl_certificates` |
| `worker_batch_size` |
| `worker_processes` |
| ssl |
| `ssl` | Secure Socket Level Options
| `cacert_file` | CA Certificate file
| `cert_file` | Certificate file
| `ciphers` | Specify permitted server cipher list
| `fail_if_no_peer_cert` | Require presence of client certificate if certificate verification is enabled
| `key_file` | Certificate key file
| `password` | Certificate key password
| `secure_renegotiate` | Enable secure renegotiation
| `ssl_certificate_max_depth` | Maximum peer certificate depth
| `tls_versions` | Specify permitted server SSL/TLS protocol versions
| `verify_fun` | SSL verification function
| `verify_ssl_certificates` | Enable certificate verification
| stats |
| `stats` | Statistic Calculation
| `rate` |
| `samples` |
| update_notification |
| `update_notification` | Update notifications
| uuids |
| `uuids` | UUIDs Configuration
| `algorithm` | Generation Algorithm
| `max_count` | Per-Request UUID Limit
| `utc_id_suffix` | UTC ID Suffix
| vendor |
| `vendor` | Vendor information
| vhosts |
| `vhosts` | Virtual Hosts
| view_compaction |
| `view_compaction` | Views Compaction Options
| `keyvalue_buffer_size` | Key-Values buffer size

### Navigation

- API Reference
- Config Reference |
- Apache CouchDB 2.0 Documentation »