Skip to content
Mirror of Apache CouchDB
JavaScript Shell Python Ruby Erlang Makefile PowerShell
Find file
Failed to load latest commit information.
bin Merge branch '1843-feature-bigcouch'
build-aux Fix {vsn, git} replace on BSD systems during make dist
dev Fix a broken path in Windows
rel Improve healthcheck
share/server Rewrite via query server
support Build main.js
test make install: fix default localstatedir
.gitignore Add targets for code analyze
.mailmap Integrate Sphinx into autotools
.travis.yml Simplify exit on first test suite failure
BUGS.md Add Markdown extension to relevant root-directory files
COMMITTERS.md Add name to committer list
CONTRIBUTORS.in Moving THANKS.in to CONTRIBUTORS.in
Dockerfile fix Dockerfile to just build couch
INSTALL.Unix.md docs: do not recommend HiPE packages for installations
INSTALL.Windows.md Update Erlang requirements
LICENSE add react-bootstrap license
Makefile js test: fix running tests from release tarball
NOTICE add react-bootstrap license
README-DEV.rst Fix typo
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 make install: fix default localstatedir
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 update mango to include the catch-all feature
setup_eunit.template Don't include eunit.ini into release
version.mk add version file

README.rst

Apache CouchDB README

Installation

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

INSTALL.Unix

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

INSTALL.Windows

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

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

Documentation

We have documentation:

http://docs.couchdb.org/

They include a changelog:

http://docs.couchdb.org/en/latest/changelog.html

For troubleshooting, see:

http://wiki.apache.org/couchdb/Troubleshooting

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

http://wiki.apache.org/couchdb/Error_messages

For general help, see:

http://couchdb.apache.org/#mailing-list

We also have an IRC channel:

http://webchat.freenode.net/?channels=couchdb

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:

http://127.0.0.1:5984/_utils/spec/run.html

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

Read more about JSpec here:

https://github.com/liblime/jspec

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:

http://wiki.apache.org/couchdb/EnableErlangViews

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

Something went wrong with that request. Please try again.