1c6a29006STrond Norbye; CouchDB Configuration Settings
2c6a29006STrond Norbye
3c6a29006STrond Norbye; Custom settings should be made in this file. They will override settings
4c6a29006STrond Norbye; in default.ini, but unlike changes made to default.ini, this file won't be
5c6a29006STrond Norbye; overwritten on server upgrade.
6c6a29006STrond Norbye
7c6a29006STrond Norbye[couchdb]
8c6a29006STrond Norbye;max_document_size = 4294967296 ; bytes
9c6a29006STrond Norbye
10c6a29006STrond Norbye[httpd]
11c6a29006STrond Norbye;port = 5984
12f7298f32Sharsha;ip4_bind_address =
13f7298f32Sharsha;ip6_bind_address = ::1
14c6a29006STrond Norbye; Options for the MochiWeb HTTP server.
15c6a29006STrond Norbye;server_options = [{backlog, 128}, {acceptor_pool_size, 16}]
16c6a29006STrond Norbye; For more socket options, consult Erlang's module 'inet' man page.
17c6a29006STrond Norbye;socket_options = [{recbuf, 262144}, {sndbuf, 262144}, {nodelay, true}]
18c6a29006STrond Norbye
19c6a29006STrond Norbye; Uncomment next line to trigger basic-auth popup on unauthorized requests.
20c6a29006STrond Norbye;WWW-Authenticate = Basic realm="administrator"
21c6a29006STrond Norbye
22c6a29006STrond Norbye; Uncomment next line to set the configuration modification whitelist. Only
23c6a29006STrond Norbye; whitelisted values may be changed via the /_config URLs. To allow the admin
24c6a29006STrond Norbye; to change this value over HTTP, remember to include {httpd,config_whitelist}
25c6a29006STrond Norbye; itself. Excluding it from the list would require editing this file to update
26c6a29006STrond Norbye; the whitelist.
27c6a29006STrond Norbye;config_whitelist = [{httpd,config_whitelist}, {log,level}, {etc,etc}]
28c6a29006STrond Norbye
29c6a29006STrond Norbye[httpd_global_handlers]
30c6a29006STrond Norbye;_google = {couch_httpd_proxy, handle_proxy_req, <<"http://www.google.com">>}
31c6a29006STrond Norbye
32c6a29006STrond Norbye[log]
33c6a29006STrond Norbye;level = debug
34c6a29006STrond Norbye
35c6a29006STrond Norbye[os_daemons]
36c6a29006STrond Norbye; For any commands listed here, CouchDB will attempt to ensure that
37c6a29006STrond Norbye; the process remains alive while CouchDB runs as well as shut them
38c6a29006STrond Norbye; down when CouchDB exits.
39c6a29006STrond Norbye;foo = /path/to/command -with args
40c6a29006STrond Norbye
41c6a29006STrond Norbye[daemons]
42c6a29006STrond Norbye; enable SSL support by uncommenting the following line and supply the PEM's below.
43c6a29006STrond Norbye; the default ssl port CouchDB listens on is 6984
44c6a29006STrond Norbye; httpsd = {couch_httpd, start_link, [https]}
45c6a29006STrond Norbye
46c6a29006STrond Norbye[ssl]
47c6a29006STrond Norbye;cert_file = /full/path/to/server_cert.pem
48c6a29006STrond Norbye;key_file = /full/path/to/server_key.pem
49c6a29006STrond Norbye
50c6a29006STrond Norbye; To enable Virtual Hosts in CouchDB, add a vhost = path directive. All requests to
51c6a29006STrond Norbye; the Virual Host will be redirected to the path. In the example below all requests
52c6a29006STrond Norbye; to http://example.com/ are redirected to /database.
53c6a29006STrond Norbye; If you run CouchDB on a specific port, include the port number in the vhost:
54c6a29006STrond Norbye; example.com:5984 = /database
55c6a29006STrond Norbye
56c6a29006STrond Norbye[vhosts]
57c6a29006STrond Norbye;example.com = /database/
58c6a29006STrond Norbye
59c6a29006STrond Norbye[update_notification]
60c6a29006STrond Norbye;unique notifier name=/full/path/to/exe -with "cmd line arg"
61c6a29006STrond Norbye
62c6a29006STrond Norbye; To create an admin account uncomment the '[admins]' section below and add a
63c6a29006STrond Norbye; line in the format 'username = password'. When you next start CouchDB, it
64c6a29006STrond Norbye; will change the password to a hash (so that your passwords don't linger
65c6a29006STrond Norbye; around in plain-text files). You can add more admin accounts with more
66c6a29006STrond Norbye; 'username = password' lines. Don't forget to restart CouchDB after
67c6a29006STrond Norbye; changing this.
68c6a29006STrond Norbye[admins]
69c6a29006STrond Norbye;admin = mysecretpassword