Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Mirror of Apache CouchDB
JavaScript Shell Python Ruby Erlang PowerShell Makefile
Branch: master
Failed to load latest commit information.
bin Merge branch '1843-feature-bigcouch'
build-aux Redirect stderr: we don't want to see "sed: no input files" here
dev Set same uuid for all dev nodes
rel suppress debug output
share/server Upgrade Coffeescript to version 1.10
support Build main.js
test Remove new CSRF mechanism
.gitignore update .gitignore to ignore release folder and files
.mailmap Integrate Sphinx into autotools
.travis.yml Remove fauxton from Travis run for now Add Markdown extension to relevant root-directory files Add name to committer list Moving to
Dockerfile Improve and document Docker test cluster setup Always build and use own rebar Add Markdown extension to relevant root-directory files
LICENSE Add papaparse license to LICENSE file for Fauxton
Makefile Use eunit.config instead of vm.args to silence error_logger
NOTICE Add papaparse.js to NOTICE file for data-importer in Fauxton Always build and use own rebar
README.rst Remove reference to non-existant document 'INSTALL'
TODO High-level notes on remaining post-merge work
Vagrantfile Fixed line wrapping in Vagrantfile.
configure Fix rebar build when sources are provided while binary is not
configure.ps1 Set -name to hostname during ./configure for Win64
introspect Add introspect script to compare what we currently point to versus th…
license.skip Add Markdown extension to relevant root-directory files
rebar.config.script bump deps Remove fauxton from Travis run for now
setup_eunit.template Don't include eunit.ini into release add version file


Apache CouchDB README


For a high-level guide to Unix-like systems, inc. Mac OS X and Ubuntu, see:


For a high-level guide to Microsoft Windows, see:


Follow the proper instructions to get CouchDB installed on your system.

If you're having problems, skip to the next section.


We have documentation:

They include a changelog:

For troubleshooting, see:

If you're getting a cryptic error message, see:

For general help, see:

We also have an IRC channel:

The mailing lists provide a wealth of support and knowledge for you to tap into. Feel free to drop by with your questions or discussion. See the official CouchDB website for more information about our community resources.

Running the Testsuite

Run the testsuite for couch.js and jquery.couch.js by browsing here:

It should work in at least Firefox >= 3.6 with Private Browsing mode enabled.

Read more about JSpec here:

When you change the specs, but your changes have no effect, manually reload the changed spec file in the browser. When the spec that tests Erlang views fails, make sure you have enabled Erlang views as described here:

Getting started with developing

Basically you just have to install the needed dependencies which are documented in the install docs and then run ./configure && make.

You don't need to run make install after compiling, just use ./dev/run to spin up three nodes. There is a haproxy config file in ./rel. Just run: cd rel && haproxy -f haproxy.cfg. You will now have a local cluster listening on port 5984.

For Fauxton developers fixing the admin-party does not work via the button in Fauxton. To fix the admin party you have to run ./dev/run with the admin flag, e.g. ./dev/run --admin=username:password. If you want to have an admin-party, just omit the flag.

Cryptographic Software Notice

This distribution includes cryptographic software. The country in which you currently reside may have restrictions on the import, possession, use, and/or re-export to another country, of encryption software. BEFORE using any encryption software, please check your country's laws, regulations and policies concerning the import, possession, or use, and re-export of encryption software, to see if this is permitted. See <> for more information.

The U.S. Government Department of Commerce, Bureau of Industry and Security (BIS), has classified this software as Export Commodity Control Number (ECCN) 5D002.C.1, which includes information security software using or performing cryptographic functions with asymmetric algorithms. The form and manner of this Apache Software Foundation distribution makes it eligible for export under the License Exception ENC Technology Software Unrestricted (TSU) exception (see the BIS Export Administration Regulations, Section 740.13) for both object code and source code.

The following provides more details on the included cryptographic software:

CouchDB includes a HTTP client (ibrowse) with SSL functionality.

Something went wrong with that request. Please try again.