Apache CouchDB
Erlang JavaScript Python C Shell Ruby Other
Failed to load latest commit information.
.github Add/update contribution guidelines, issue/PR templates for GH Issues May 20, 2017
bin Merge branch '1843-feature-bigcouch' Jul 10, 2014
build-aux Strip ?rev off of logfile-uploader's printed URL Jul 24, 2017
dev really disable compaction daemon for JS tests Jul 7, 2017
rel Leave the uncommented defaults uncommented Jul 27, 2017
share/server Improve reduce function overlow handling Mar 28, 2017
src Merge pull request #710 from apache/fix/peruser-test Jul 27, 2017
support do not pollute the global scope Sep 9, 2016
test Improve JS restartServer() support function Jul 21, 2017
.gitignore Add auto log uploader for CI workflow May 15, 2017
.mailmap Integrate Sphinx into autotools Dec 11, 2012
.travis.yml Enable OS process IO logging + upload for Travis and Jenkins tests Jun 14, 2017
BUGS.md Add Markdown extension to relevant root-directory files Jun 26, 2015
COMMITTERS.md Add name to committer list Aug 30, 2015
CONTRIBUTING.md Update CONTRIBUTING.md to reflect monorepo Jun 30, 2017
CONTRIBUTORS.in Moving THANKS.in to CONTRIBUTORS.in Oct 30, 2014
Dockerfile update Dockerfile to debian jessie May 12, 2016
INSTALL.Unix.md Improve UNIX dependency installation (Node.JS, Sphinx) Jul 13, 2017
INSTALL.Windows.md Revise Windows installation readme Jul 19, 2016
Jenkinsfile Restore Jenkins builds on master Jul 22, 2017
LICENSE Remove deprecated OAuth 1.0 implementation Jul 9, 2017
Makefile Add soak-javascript target Jul 25, 2017
Makefile.win Fix Windows release builds Jul 9, 2017
NOTICE Explicitly mention Facebook "BSD+Patents" license in NOTICE per Jul 21, 2017
README-DEV.rst Remove "--prefix" option from README-DEV May 26, 2017
README.rst Fix link to changelog/whatsnew Jul 24, 2017
TODO High-level notes on remaining post-merge work Jul 10, 2014
Vagrantfile Remove TeX/LaTeX and texinfo from the build chain Mar 19, 2017
configure Fix configure when whoami errors out May 24, 2017
configure.ps1 Fix Windows build Jul 8, 2017
introspect Add introspect script to compare what we currently point to versus th… Sep 24, 2015
license.skip Remove deprecated OAuth 1.0 implementation Jul 9, 2017
rebar.config.script Bump config dep to 1.0.1 (ncrease timeouts for set and get). Jul 22, 2017
setup_eunit.template Don't include eunit.ini into release May 11, 2015
version.mk bump version.mk Apr 30, 2017


Apache CouchDB README

Travis CI master build status travisci
Jenkins CI master build status jenkins


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:


It includes a changelog:


For troubleshooting or cryptic error messages, 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.

Verifying your Installation

Run a basic test suite for CouchDB by browsing here:

Getting started with developing

For more detail, read the README-DEV.rst file in this directory.

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. You can add haproxy as a caching layer in front of this cluster by running ./dev/run --with-haproxy --haproxy=/path/to/haproxy . 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.

Contributing to CouchDB

You can learn more about our contributing process here:


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 <http://www.wassenaar.org/> 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.