Mirror of Apache CouchDB
JavaScript Shell Python Ruby Erlang Makefile Other
Failed to load latest commit information.
bin Merge branch '1843-feature-bigcouch' Jul 10, 2014
build-aux Include our rebar into release tarball Feb 22, 2016
dev Fix dev/run: "content" should be "contents" Aug 3, 2016
rel Fix logging for eunit tests Jul 22, 2016
share/server Rewrite via query server Dec 21, 2015
support Build main.js Feb 3, 2014
test Don't set "authenticated" property in _session unless we authenticated Jul 30, 2016
.gitignore Add targets for code analyze Oct 19, 2015
.mailmap Integrate Sphinx into autotools Dec 11, 2012
.travis.yml Simplify exit on first test suite failure Oct 19, 2015
BUGS.md Add Markdown extension to relevant root-directory files Jun 26, 2015
COMMITTERS.md Add name to committer list Aug 30, 2015
CONTRIBUTORS.in Moving THANKS.in to CONTRIBUTORS.in Oct 30, 2014
Dockerfile update Dockerfile to debian jessie May 12, 2016
INSTALL.Unix.md Recommend installing the full 'erlang' package to ensure builds succeed Aug 23, 2016
INSTALL.Windows.md Revise Windows installation readme Jul 19, 2016
LICENSE Add EPL to LICENSE for trunc_io modules Jul 22, 2016
Makefile don't hide output of 'make release' Aug 23, 2016
Makefile.win Remove lager and its dependencies Jul 22, 2016
NOTICE adding velocity-react license for Fauxton Mar 31, 2016
README-DEV.rst Fix inaccuracies in README files Aug 27, 2016
README.rst Fix inaccuracies in README files Aug 27, 2016
TODO High-level notes on remaining post-merge work Jul 10, 2014
Vagrantfile Fixed line wrapping in Vagrantfile. Aug 24, 2013
configure Remove lager and its dependencies Jul 22, 2016
configure.ps1 More Windows fixes; make release now works Jul 18, 2016
introspect Add introspect script to compare what we currently point to versus th… Sep 24, 2015
license.skip Add Markdown extension to relevant root-directory files Jun 26, 2015
rebar.config.script Update dependencies to use updated config API Aug 26, 2016
setup_eunit.template Don't include eunit.ini into release May 11, 2015
version.mk add version file Jun 24, 2015


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 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.

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.