bump hyper dependency, fix Windows build
[couchdb.git] / README.rst
1 Apache CouchDB README
2 =====================
3
4 +--------------------------------+------------+
5 | Travis CI master build status  | |travisci| |
6 +--------------------------------+------------+
7 | Jenkins CI master build status | |jenkins|  |
8 +--------------------------------+------------+
9
10 .. |travisci| image:: https://travis-ci.org/apache/couchdb.svg?branch=master
11     :target: https://travis-ci.org/apache/couchdb
12
13 .. |jenkins| image:: https://builds.apache.org/job/CouchDB/job/master/badge/icon
14     :target: https://builds.apache.org/blue/organizations/jenkins/CouchDB/activity
15
16 Installation
17 ------------
18
19 For a high-level guide to Unix-like systems, inc. Mac OS X and Ubuntu, see:
20
21     INSTALL.Unix
22
23 For a high-level guide to Microsoft Windows, see:
24
25     INSTALL.Windows
26
27 Follow the proper instructions to get CouchDB installed on your system.
28
29 If you're having problems, skip to the next section.
30
31 Documentation
32 -------------
33
34 We have documentation:
35
36     http://docs.couchdb.org/
37
38 It includes a changelog:
39
40     http://docs.couchdb.org/en/latest/whatsnew/
41
42 For troubleshooting or cryptic error messages, see:
43
44     http://docs.couchdb.org/en/latest/install/troubleshooting.html
45
46 For general help, see:
47
48      http://couchdb.apache.org/#mailing-list
49      
50 We also have an IRC channel:
51
52     http://webchat.freenode.net/?channels=couchdb
53
54 The mailing lists provide a wealth of support and knowledge for you to tap into.
55 Feel free to drop by with your questions or discussion. See the official CouchDB
56 website for more information about our community resources.
57
58 Verifying your Installation
59 ---------------------------
60
61 Run a basic test suite for CouchDB by browsing here:
62
63     http://127.0.0.1:5984/_utils/#verifyinstall
64
65 Getting started with developing
66 -------------------------------
67
68 For more detail, read the README-DEV.rst file in this directory.
69
70 Basically you just have to install the needed dependencies which are
71 documented in the install docs and then run ``./configure && make``.
72
73 You don't need to run ``make install`` after compiling, just use
74 ``./dev/run`` to spin up three nodes. You can add haproxy as a caching
75 layer in front of this cluster by running ``./dev/run --with-haproxy
76 --haproxy=/path/to/haproxy`` . You will now have a local cluster
77 listening on port 5984.
78
79 For Fauxton developers fixing the admin-party does not work via the button in
80 Fauxton. To fix the admin party you have to run ``./dev/run`` with the ``admin``
81 flag, e.g. ``./dev/run --admin=username:password``. If you want to have an
82 admin-party, just omit the flag.
83
84 Contributing to CouchDB
85 -----------------------
86
87 You can learn more about our contributing process here:
88
89     https://github.com/apache/couchdb/blob/master/CONTRIBUTING.md
90
91 Cryptographic Software Notice
92 -----------------------------
93
94 This distribution includes cryptographic software. The country in which you
95 currently reside may have restrictions on the import, possession, use, and/or
96 re-export to another country, of encryption software. BEFORE using any
97 encryption software, please check your country's laws, regulations and policies
98 concerning the import, possession, or use, and re-export of encryption software,
99 to see if this is permitted. See <http://www.wassenaar.org/> for more
100 information.
101
102 The U.S. Government Department of Commerce, Bureau of Industry and Security
103 (BIS), has classified this software as Export Commodity Control Number (ECCN)
104 5D002.C.1, which includes information security software using or performing
105 cryptographic functions with asymmetric algorithms. The form and manner of this
106 Apache Software Foundation distribution makes it eligible for export under the
107 License Exception ENC Technology Software Unrestricted (TSU) exception (see the
108 BIS Export Administration Regulations, Section 740.13) for both object code and
109 source code.
110
111 The following provides more details on the included cryptographic software:
112
113 CouchDB includes a HTTP client (ibrowse) with SSL functionality.