Configuration Quick Reference

Configuration Quick Reference


	admins
	`admins`	Server Administrators

	attachments
	`attachments`	Configuration of Attachment Storage
	`compressible_types`
	`compression_level`

	chttpd
	`chttpd`	Clustered HTTP Server Options
	`authentication_handlers`	Authentication handlers
	`bind_address`	HTTP port IP address binding
	`port`	Listen port
	`prefer_minimal`	Sends minimal set of headers
	`require_valid_user`	Force user authentication
	`require_valid_user_except_for_up`	Force user auth (mostly)

	cluster
	`cluster`	cluster Options
	`n`
	`placement`
	`q`
	`seedlist`

	cors
	`cors`	Cross-Origin Resource Sharing
	`credentials`
	`headers`
	`max_age`
	`methods`
	`origins`

	couch_httpd_auth
	`couch_httpd_auth`	Authentication Configuration
	`allow_persistent_cookies`	Persistent cookies
	`auth_cache_size`	Authentication cache
	`authentication_redirect`	Default redirect for authentication requests
	`cookie_domain`	Cookie Domain
	`iterations`	PBKDF2 iterations count
	`max_iterations`	Maximum PBKDF2 iterations count
	`min_iterations`	Minimum PBKDF2 iterations count
	`proxy_use_secret`	Force proxy auth to use secret token
	`public_fields`	User documents public fields
	`require_valid_user`	Force user authentication
	`same_site`	SameSite
	`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_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
	`default_security`	Default security
	`enable_database_recovery`	Enable database recovery
	`file_compression`	Compression method for documents
	`maintenance_mode`	Maintenance mode
	`max_dbs_open`	Limit of simultaneously opened databases
	`max_document_size`	Limit maximum document body size
	`os_process_timeout`	External processes time limit
	`single_node`	Start in single node mode.
	`uri_file`	Discovery CouchDB help file
	`users_db_security_editable`	Protect `_users` DB security obj
	`users_db_suffix`	Users database suffix
	`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`

	database_compaction
	`database_compaction`	Database Compaction Options
	`checkpoint_after`	Checkpoint trigger
	`doc_buffer_size`	Documents buffer size

	dreyfus
	`dreyfus`	Search Subsystem Configuration
	`limit`	Default result set limit for global search
	`limit_partitions`	Default result set limit for partitioned DBs
	`max_limit`	Maximum result set for global search
	`max_limit_partitions`	Maximum result set for partitioned search
	`name`	Clouseau JVM node name and location
	`retry_limit`	Maximum number of connection retries

	httpd
	`httpd`	HTTP Server Options
	`allow_jsonp`	Enables JSONP support
	`changes_timeout`	Changes feed timeout
	`config_whitelist`	Config options while list
	`enable_cors`	Activates CORS
	`enable_xframe_options`	Controls X-Frame-Options header
	`max_http_request_size`	Maximum HTTP request body size
	`secure_rewrites`	Default request handler
	`server_options`	MochiWeb Server Options
	`socket_options`	Socket Options
	`x_forwarded_host`	X-Forwarder-Host
	`x_forwarded_proto`	X-Forwarder-Proto
	`x_forwarded_ssl`	X-Forwarder-Ssl

	ioq
	`ioq`	IO Queue Configuration
	`concurrency`	Number of in-flight IO requests
	`ratio`	Preference for selecting background over interactive IO

	ioq.bypass
	`ioq.bypass`	Bypass selected IO classes by setting these to true
	`compaction`
	`os_process`
	`read`
	`shard_sync`
	`view_update`
	`write`

	jwt_auth
	`jwt_auth`	JWT Authentication
	`required_claims`	Mandatory claims in JWT tokens

	ken
	`ken`	Background Index Builds
	`batch_channels`	Steady-state build concurrency
	`incremental_channels`	Additional slots for short jobs
	`max_incremental_updates`	Threshold defining a job as short

	ken.ignore
	`ken.ignore`	Auto-Indexing Blacklist

	log
	`log`	Logging options
	`file`	Logging file path
	`include_sasl`
	`level`	Logging verbose level
	`syslog_appid`
	`syslog_facility`
	`syslog_host`
	`syslog_port`
	`write_buffer`
	`write_delay`
	`writer`	Set the log writer to use.

	mango
	`mango`	Mango Configuration
	`default_limit`	Default limit value for Mango queries.
	`index scan warning`
	`index_all_disabled`	Disable “index all fields” behaviour
	`index_scan_warning_threshold`	Ratio threshold that generates an

	native_query_servers
	`native_query_servers`	Native Erlang Query Server

	purge
	`purge`	Configuration of Database Purge
	`index_lag_warn_seconds`
	`max_document_id_number`
	`max_revisions_number`

	query_server_config
	`query_server_config`	Query Servers Configuration
	`commit_freq`	View index commit delay
	`limit`
	`os_process_limit`	Query Server process hard
	`os_process_soft_limit`	Query Server process
	`reduce_limit`	Reduce limit control
	`soft limit`

	replicator
	`replicator`	Replicator Database Configuration
	`auth_plugins`
	`cert_file`
	`checkpoint_interval`
	`connection_timeout`
	`http_connections`
	`interval`
	`key_file`
	`max_churn`
	`max_history`
	`max_jobs`
	`password`
	`retries_per_request`
	`socket_options`
	`ssl_certificate_max_depth`
	`ssl_trusted_certificates_file`
	`update_docs`
	`use_checkpoints`
	`verify_ssl_certificates`
	`worker_batch_size`
	`worker_processes`

	resharding
	`resharding`	Resharding Configuration
	`delete_source`
	`max_history`
	`max_jobs`
	`max_retries`
	`require_node_param`
	`require_range_param`
	`retry_interval_sec`
	`source_close_timeout_sec`
	`update_shard_map_timeout_sec`

	rexi
	`rexi`	Internal RPC Tuning
	`buffer_count`
	`server_per_node`
	`stream_limit`

	smoosh
	`smoosh`	Compaction Daemon Rules
	`cleanup_index_files`	Automatically delete orphaned index files
	`db_channels`	Active database channels
	`staleness`	Minimum time between priority calculations
	`view_channels`	Active secondary index channels
	`wait_secs`	Warmup period before triggering first compaction

	smoosh.
	`smoosh.<channel>`	Per-channel configuration
	`capacity`
	`concurrency`
	`max_priority`
	`max_size`
	`min_changes`
	`min_priority`
	`min_size`
	`priority`

	ssl
	`ssl`	HTTPS (SSL/TLS) 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
	`interval`

	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`	View Compaction Options
	`keyvalue_buffer_size`	Key-Values buffer size