Repository files navigation

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.

We have documentation:

https://docs.couchdb.org/

It includes a changelog:

https://docs.couchdb.org/en/latest/whatsnew/

For troubleshooting or cryptic error messages, see:

https://docs.couchdb.org/en/latest/install/troubleshooting.html

For general help, see:

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

We also have an IRC channel:

https://web.libera.chat/#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 CouchDBwebsite for more information about our community resources.

Run a basic test suite for CouchDB by browsing here:

http://127.0.0.1:5984/_utils/#verifyinstall

Quickstart:

If you already have VS Code and Docker installed, you can click the badge above orhereto get started. Clicking these links will cause VS Code to automatically install theRemote - Containers extension if needed, clone the source code into a container volume,and spin up a dev container for use.

Thisdevcontainer will automatically run./configure && make the first time it is created.While this may take some extra time to spin up, this tradeoff means you will be able torun things like./dev/run,./dev/run --admin=admin:admin,./dev/run --with-admin-party-please,andmake check straight away. Subsequent startups should be quick.

Manual Dev Setup:

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

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

You don't need to runmake install after compiling, just use./dev/run to spin up three nodes. You can add haproxy as a cachinglayer in front of this cluster by running./dev/run --with-haproxy--haproxy=/path/to/haproxy . You will now have a local clusterlistening on port 5984.

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

You can learn more about our contributing process here:

https://github.com/apache/couchdb/blob/main/CONTRIBUTING.md

This project is proudly supported by:

IBM Cloudant

This distribution includes cryptographic software. The country in which youcurrently reside may have restrictions on the import, possession, use, and/orre-export to another country, of encryption software. BEFORE using anyencryption software, please check your country's laws, regulations and policiesconcerning the import, possession, or use, and re-export of encryption software,to see if this is permitted. See <https://www.wassenaar.org/> for moreinformation.

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 performingcryptographic functions with asymmetric algorithms. The form and manner of thisApache Software Foundation distribution makes it eligible for export under theLicense Exception ENC Technology Software Unrestricted (TSU) exception (see theBIS Export Administration Regulations, Section 740.13) for both object code andsource code.

The following provides more details on the included cryptographic software:

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