Repository: couchdb Updated Branches: refs/heads/master ce2c357fb -> a1ecde1eb
Add Markdown extension to relevant root-directory files Project: http://git-wip-us.apache.org/repos/asf/couchdb/repo Commit: http://git-wip-us.apache.org/repos/asf/couchdb/commit/a1ecde1e Tree: http://git-wip-us.apache.org/repos/asf/couchdb/tree/a1ecde1e Diff: http://git-wip-us.apache.org/repos/asf/couchdb/diff/a1ecde1e Branch: refs/heads/master Commit: a1ecde1ebe1a4c5bda0dedc28b905546bea4ea3a Parents: ce2c357 Author: Joan Touzet <woh...@apache.org> Authored: Fri Jun 26 18:06:44 2015 -0400 Committer: Joan Touzet <woh...@apache.org> Committed: Fri Jun 26 18:06:44 2015 -0400 ---------------------------------------------------------------------- BUGS | 8 -- BUGS.md | 8 ++ COMMITTERS | 50 -------- COMMITTERS.md | 50 ++++++++ INSTALL.Unix | 322 ------------------------------------------------ INSTALL.Unix.md | 322 ++++++++++++++++++++++++++++++++++++++++++++++++ INSTALL.Windows | 204 ------------------------------ INSTALL.Windows.md | 204 ++++++++++++++++++++++++++++++ README-DEV | 194 ----------------------------- README-DEV.md | 194 +++++++++++++++++++++++++++++ license.skip | 15 ++- 11 files changed, 787 insertions(+), 784 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/couchdb/blob/a1ecde1e/BUGS ---------------------------------------------------------------------- diff --git a/BUGS b/BUGS deleted file mode 100644 index 1bdc478..0000000 --- a/BUGS +++ /dev/null @@ -1,8 +0,0 @@ -Apache CouchDB BUGS -=================== - -Visit our issue tracker: - - https://issues.apache.org/jira/browse/CouchDB - -You can use this to report bugs, request features, or suggest enhancements. http://git-wip-us.apache.org/repos/asf/couchdb/blob/a1ecde1e/BUGS.md ---------------------------------------------------------------------- diff --git a/BUGS.md b/BUGS.md new file mode 100644 index 0000000..1bdc478 --- /dev/null +++ b/BUGS.md @@ -0,0 +1,8 @@ +Apache CouchDB BUGS +=================== + +Visit our issue tracker: + + https://issues.apache.org/jira/browse/CouchDB + +You can use this to report bugs, request features, or suggest enhancements. http://git-wip-us.apache.org/repos/asf/couchdb/blob/a1ecde1e/COMMITTERS ---------------------------------------------------------------------- diff --git a/COMMITTERS b/COMMITTERS deleted file mode 100644 index 6030e5b..0000000 --- a/COMMITTERS +++ /dev/null @@ -1,50 +0,0 @@ -Apache CouchDB COMMITTERS -========================= - -Committers are given a binding vote in certain project decsions, as well as -write access to public project infrastructure. The following people were -elected as a committer in recognition of their commitment to the project. We -mean this in the sense of being loyal to the project and its interests. - - * Damien Katz <dam...@apache.org> - * Jan Lehnardt <j...@apache.org> - * Noah Slater <nsla...@apache.org> - * Christopher Lenz <cml...@apache.org> - * J. Chris Anderson <jch...@apache.org> - * Paul Joseph Davis <dav...@apache.org> - * Adam Kocoloski <kocol...@apache.org> - * Jason Davies <jasondav...@apache.org> - * Mark Hammond <mhamm...@apache.org> - * Benoît Chesneau <beno...@apache.org> - * Filipe Manana <fdman...@apache.org> - * Robert Newson <rnew...@apache.org> - * Randall Leeds <rand...@apache.org> - * Bob Dionne <bitdid...@apache.org> - * Dave Cottlehuber <d...@apache.org> - * Jason Smith <j...@apache.org> - * Joan Touzet <woh...@apache.org> - * Dale Harvey <d...@apache.org> - * Dirkjan Ochtman <d...@apache.org> - * Alexander Shorin <kxe...@apache.org> - * Garren Smith <gar...@apache.org> - * Sue Lockwood <deathb...@apache.org> - * Andy Wenk <andyw...@apache.org> - * Klaus Trainer <klaus_trai...@apache.org> - * Benjamin Young <bigblue...@apache.org> - * Robert Kowalski <robertkowal...@apache.org> - * Max Thayer <garba...@apache.org> - * Gianugo Rabellino <gian...@apache.org> - * Jenn Schiffer <j...@apache.org> - * Lena Reinhard <l...@apache.org> - * Simon Metson <met...@apache.org> - * Mike Wallace <mikewall...@apache.org> - * Nick North <nickno...@apache.org> - * Ryan Ramage <ryanram...@apache.org> - * Sebastian Rothbucher <sebastia...@apache.org> - * Ted Leung <t...@apache.org> - * Wendall Cada <wenda...@apache.org> - * Benjamin Bastian <bbast...@apache.org> - * Ben Keen <benk...@apache.org> - * Maria Andersson <m...@apache.org> - -For a list of other credits see the `THANKS` file. http://git-wip-us.apache.org/repos/asf/couchdb/blob/a1ecde1e/COMMITTERS.md ---------------------------------------------------------------------- diff --git a/COMMITTERS.md b/COMMITTERS.md new file mode 100644 index 0000000..6030e5b --- /dev/null +++ b/COMMITTERS.md @@ -0,0 +1,50 @@ +Apache CouchDB COMMITTERS +========================= + +Committers are given a binding vote in certain project decsions, as well as +write access to public project infrastructure. The following people were +elected as a committer in recognition of their commitment to the project. We +mean this in the sense of being loyal to the project and its interests. + + * Damien Katz <dam...@apache.org> + * Jan Lehnardt <j...@apache.org> + * Noah Slater <nsla...@apache.org> + * Christopher Lenz <cml...@apache.org> + * J. Chris Anderson <jch...@apache.org> + * Paul Joseph Davis <dav...@apache.org> + * Adam Kocoloski <kocol...@apache.org> + * Jason Davies <jasondav...@apache.org> + * Mark Hammond <mhamm...@apache.org> + * Benoît Chesneau <beno...@apache.org> + * Filipe Manana <fdman...@apache.org> + * Robert Newson <rnew...@apache.org> + * Randall Leeds <rand...@apache.org> + * Bob Dionne <bitdid...@apache.org> + * Dave Cottlehuber <d...@apache.org> + * Jason Smith <j...@apache.org> + * Joan Touzet <woh...@apache.org> + * Dale Harvey <d...@apache.org> + * Dirkjan Ochtman <d...@apache.org> + * Alexander Shorin <kxe...@apache.org> + * Garren Smith <gar...@apache.org> + * Sue Lockwood <deathb...@apache.org> + * Andy Wenk <andyw...@apache.org> + * Klaus Trainer <klaus_trai...@apache.org> + * Benjamin Young <bigblue...@apache.org> + * Robert Kowalski <robertkowal...@apache.org> + * Max Thayer <garba...@apache.org> + * Gianugo Rabellino <gian...@apache.org> + * Jenn Schiffer <j...@apache.org> + * Lena Reinhard <l...@apache.org> + * Simon Metson <met...@apache.org> + * Mike Wallace <mikewall...@apache.org> + * Nick North <nickno...@apache.org> + * Ryan Ramage <ryanram...@apache.org> + * Sebastian Rothbucher <sebastia...@apache.org> + * Ted Leung <t...@apache.org> + * Wendall Cada <wenda...@apache.org> + * Benjamin Bastian <bbast...@apache.org> + * Ben Keen <benk...@apache.org> + * Maria Andersson <m...@apache.org> + +For a list of other credits see the `THANKS` file. http://git-wip-us.apache.org/repos/asf/couchdb/blob/a1ecde1e/INSTALL.Unix ---------------------------------------------------------------------- diff --git a/INSTALL.Unix b/INSTALL.Unix deleted file mode 100644 index 8b4b53d..0000000 --- a/INSTALL.Unix +++ /dev/null @@ -1,322 +0,0 @@ -Apache CouchDB INSTALL.Unix -========================== - -A high-level guide to Unix-like systems, inc. Mac OS X and Ubuntu. - -Community installation guides are available on the wiki: - - http://wiki.apache.org/couchdb/Installation - -If you are trying to build CouchDB from a git checkout rather than -a .tar.gz, see the `DEVELOPERS` file. - -This document is the canonical source of installation -information. However, many systems have gotchas that you need to be -aware of. In addition, dependencies frequently change as distributions -update their archives. If you're running into trouble, be sure to -check out the wiki. If you have any tips to share, please also update -the wiki so that others can benefit from your experience. - -Troubleshooting ---------------- - -There is a troubleshooting guide: - - http://wiki.apache.org/couchdb/Troubleshooting - -There is a wiki for general documentation: - - http://wiki.apache.org/couchdb/ - -There are collection of friendly mailing lists: - - http://couchdb.apache.org/community/lists.html - -Please work through these in order if you experience any problems. - -Dependencies ------------- - -You should have the following installed: - - * Erlang OTP (>=R14B01, =<R17) (http://erlang.org/) - * ICU (http://icu-project.org/) - * OpenSSL (http://www.openssl.org/) - * Mozilla SpiderMonkey (1.8.5) (http://www.mozilla.org/js/spidermonkey/) - * GNU Make (http://www.gnu.org/software/make/) - * GNU Compiler Collection (http://gcc.gnu.org/) - * libcurl (http://curl.haxx.se/libcurl/) - * help2man (http://www.gnu.org/s/help2man/) - * Python (>=2.7) for docs (http://python.org/) - * Python Sphinx (>=1.1.3) (http://pypi.python.org/pypi/Sphinx) - -It is recommended that you install Erlang OTP R13B-4 or above where -possible. You will only need libcurl if you plan to run the -JavaScript test suite. And help2man is only need if you plan on -installing the CouchDB man pages. Python and Sphinx are only required -for building the online documentation. - -Debian-based Systems -~~~~~~~~~~~~~~~~~~~~ - -You can install the dependencies by running: - - sudo apt-get install build-essential erlang-base-hipe \ - erlang-dev erlang-manpages erlang-eunit erlang-nox \ - libicu-dev libmozjs185-dev libcurl4-openssl-dev \ - pkg-config rebar - -There are lots of Erlang packages. If there is a problem with your -install, try a different mix. There is more information on the -wiki. Additionally, you might want to install some of the optional -Erlang tools which may also be useful. - -Be sure to update the version numbers to match your system's available -packages. - -For up to date instructions, please see: - - http://wiki.apache.org/couchdb/Installing_on_Debian - - http://wiki.apache.org/couchdb/Installing_on_Ubuntu - -Unfortunately, it seems that installing dependencies on Ubuntu is -troublesome. - -RedHat-based (Fedora, Centos, RHEL) Systems -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -You can install the dependencies by running: - - sudo yum install autoconf autoconf-archive automake \ - curl-devel erlang-asn1 erlang-erts erlang-eunit \ - erlang-os_mon erlang-xmerl erlang-rebar help2man \ - js-devel libicu-devel libtool perl-Test-Harness - -While CouchDB builds against the default js-devel-1.7.0 included in -some distributions, it's recommended to use a more recent -js-devel-1.8.5. - -Mac OS X -~~~~~~~~ - -To build CouchDB from source on Mac OS X, you will need to install -the Command Line Tools: - - xcode-select --install - -You can then install the other dependencies by running: - - brew install autoconf autoconf-archive automake libtool \ - erlang icu4c spidermonkey curl pkg-config rebar - -You will need Homebrew installed to use the `brew` command. - -Learn more about Homebrew at: - - http://mxcl.github.com/homebrew/ - -Some versions of Mac OS X ship a problematic OpenSSL library. If -you're experiencing troubles with CouchDB crashing intermittently with -a segmentation fault or a bus error, you will need to install your own -version of OpenSSL. See the troubleshooting guide, mentioned above, -for more information. - -FreeBSD -------- - -FreeBSD requires the use of GNU Make. Where `make` is specified in this -documentation, substitute `gmake`. - -You can install this by running: - - pkg install gmake - -Installing ----------- - -Once you have satisfied the dependencies you should run: - - ./configure - -This script will configure CouchDB to be installed into `/usr/local` -by default. - -If you wish to customize the installation, pass `--help` to this -script. - -If everything was successful you should see the following message: - - You have configured Apache CouchDB, time to relax. - -Relax. - -To install CouchDB you should run: - - make && sudo make install - -You only need to use `sudo` if you're installing into a system directory. - -Try `gmake` if `make` is giving you any problems. - -If everything was successful you should see the following message: - - You have installed Apache CouchDB, time to relax. - -Relax. - -User Registration ------------------ - -You should create a special `couchdb` user for CouchDB. - -On many Unix-like systems you can run: - - adduser --system \ - --home /usr/local/var/lib/couchdb \ - --no-create-home \ - --shell /bin/bash \ - --group --gecos \ - "CouchDB Administrator" couchdb - -On Mac OS X you can use the Workgroup Manager to create users: - - http://www.apple.com/support/downloads/serveradmintools1047.html - -You must make sure that: - - * The user has a working POSIX shell - - * The user's home directory is `/usr/local/var/lib/couchdb` - -You can test this by: - - * Trying to log in as the `couchdb` user - - * Running `pwd` and checking the present working directory - -Change the ownership of the CouchDB directories by running: - - chown -R couchdb:couchdb /usr/local/etc/couchdb - chown -R couchdb:couchdb /usr/local/var/lib/couchdb - chown -R couchdb:couchdb /usr/local/var/log/couchdb - chown -R couchdb:couchdb /usr/local/var/run/couchdb - -Change the permission of the CouchDB directories by running: - - chmod 0770 /usr/local/etc/couchdb - chmod 0770 /usr/local/var/lib/couchdb - chmod 0770 /usr/local/var/log/couchdb - chmod 0770 /usr/local/var/run/couchdb - -Update the permissions for your `default.ini` file: - - chmod 0644 /usr/local/etc/couchdb/default.ini - -First Run ---------- - -You can start the CouchDB server by running: - - sudo -i -u couchdb couchdb - -This uses the `sudo` command to run the `couchdb` command as the -`couchdb` user. - -When CouchDB starts it should eventually display the following -message: - - Apache CouchDB has started, time to relax. - -Relax. - -To check that everything has worked, point your web browser to: - - http://127.0.0.1:5984/_utils/index.html - -From here you should run the test suite in Firefox. - -Running as a Daemon -------------------- - -SysV/BSD-style Systems -~~~~~~~~~~~~~~~~~~~~~~ - -You can use the `couchdb` init script to control the CouchDB daemon. - -On SysV-style systems, the init script will be installed into: - - /usr/local/etc/init.d - -On BSD-style systems, the init script will be installed into: - - /usr/local/etc/rc.d - -We use the `[init.d|rc.d]` notation to refer to both of these -directories. - -You can control the CouchDB daemon by running: - - /usr/local/etc/[init.d|rc.d]/couchdb [start|stop|restart|status] - -If you wish to configure how the init script works, you can edit: - - /usr/local/etc/default/couchdb - -Comment out the `COUCHDB_USER` setting if you're running as a -non-superuser. - -To start the daemon on boot, copy the init script to: - - /etc/[init.d|rc.d] - -You should then configure your system to run the init script -automatically. - -You may be able to run: - - sudo update-rc.d couchdb defaults - -If this fails, consult your system documentation for more information. - -A `logrotate` configuration is installed into: - - /usr/local/etc/logrotate.d/couchdb - -Consult your `logrotate` documentation for more information. - -It is critical that the CouchDB logs are rotated so as not to fill -your disk. - -Mac OS X -~~~~~~~~ - -You can use the `launchctl` command to control the CouchDB daemon. - -You can load the configuration by running: - - sudo launchctl load \ - /usr/local/Library/LaunchDaemons/org.apache.couchdb.plist - -You can stop the CouchDB daemon by running: - - sudo launchctl unload \ - /usr/local/Library/LaunchDaemons/org.apache.couchdb.plist - -You can start CouchDB by running: - - sudo launchctl start org.apache.couchdb - -You can restart CouchDB by running: - - sudo launchctl stop org.apache.couchdb - -You can edit the launchd configuration by running: - - open /usr/local/Library/LaunchDaemons/org.apache.couchdb.plist - -To start the daemon on boot, copy the configuration file to: - - /Library/LaunchDaemons - -Consult your system documentation for more information. http://git-wip-us.apache.org/repos/asf/couchdb/blob/a1ecde1e/INSTALL.Unix.md ---------------------------------------------------------------------- diff --git a/INSTALL.Unix.md b/INSTALL.Unix.md new file mode 100644 index 0000000..8b4b53d --- /dev/null +++ b/INSTALL.Unix.md @@ -0,0 +1,322 @@ +Apache CouchDB INSTALL.Unix +========================== + +A high-level guide to Unix-like systems, inc. Mac OS X and Ubuntu. + +Community installation guides are available on the wiki: + + http://wiki.apache.org/couchdb/Installation + +If you are trying to build CouchDB from a git checkout rather than +a .tar.gz, see the `DEVELOPERS` file. + +This document is the canonical source of installation +information. However, many systems have gotchas that you need to be +aware of. In addition, dependencies frequently change as distributions +update their archives. If you're running into trouble, be sure to +check out the wiki. If you have any tips to share, please also update +the wiki so that others can benefit from your experience. + +Troubleshooting +--------------- + +There is a troubleshooting guide: + + http://wiki.apache.org/couchdb/Troubleshooting + +There is a wiki for general documentation: + + http://wiki.apache.org/couchdb/ + +There are collection of friendly mailing lists: + + http://couchdb.apache.org/community/lists.html + +Please work through these in order if you experience any problems. + +Dependencies +------------ + +You should have the following installed: + + * Erlang OTP (>=R14B01, =<R17) (http://erlang.org/) + * ICU (http://icu-project.org/) + * OpenSSL (http://www.openssl.org/) + * Mozilla SpiderMonkey (1.8.5) (http://www.mozilla.org/js/spidermonkey/) + * GNU Make (http://www.gnu.org/software/make/) + * GNU Compiler Collection (http://gcc.gnu.org/) + * libcurl (http://curl.haxx.se/libcurl/) + * help2man (http://www.gnu.org/s/help2man/) + * Python (>=2.7) for docs (http://python.org/) + * Python Sphinx (>=1.1.3) (http://pypi.python.org/pypi/Sphinx) + +It is recommended that you install Erlang OTP R13B-4 or above where +possible. You will only need libcurl if you plan to run the +JavaScript test suite. And help2man is only need if you plan on +installing the CouchDB man pages. Python and Sphinx are only required +for building the online documentation. + +Debian-based Systems +~~~~~~~~~~~~~~~~~~~~ + +You can install the dependencies by running: + + sudo apt-get install build-essential erlang-base-hipe \ + erlang-dev erlang-manpages erlang-eunit erlang-nox \ + libicu-dev libmozjs185-dev libcurl4-openssl-dev \ + pkg-config rebar + +There are lots of Erlang packages. If there is a problem with your +install, try a different mix. There is more information on the +wiki. Additionally, you might want to install some of the optional +Erlang tools which may also be useful. + +Be sure to update the version numbers to match your system's available +packages. + +For up to date instructions, please see: + + http://wiki.apache.org/couchdb/Installing_on_Debian + + http://wiki.apache.org/couchdb/Installing_on_Ubuntu + +Unfortunately, it seems that installing dependencies on Ubuntu is +troublesome. + +RedHat-based (Fedora, Centos, RHEL) Systems +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +You can install the dependencies by running: + + sudo yum install autoconf autoconf-archive automake \ + curl-devel erlang-asn1 erlang-erts erlang-eunit \ + erlang-os_mon erlang-xmerl erlang-rebar help2man \ + js-devel libicu-devel libtool perl-Test-Harness + +While CouchDB builds against the default js-devel-1.7.0 included in +some distributions, it's recommended to use a more recent +js-devel-1.8.5. + +Mac OS X +~~~~~~~~ + +To build CouchDB from source on Mac OS X, you will need to install +the Command Line Tools: + + xcode-select --install + +You can then install the other dependencies by running: + + brew install autoconf autoconf-archive automake libtool \ + erlang icu4c spidermonkey curl pkg-config rebar + +You will need Homebrew installed to use the `brew` command. + +Learn more about Homebrew at: + + http://mxcl.github.com/homebrew/ + +Some versions of Mac OS X ship a problematic OpenSSL library. If +you're experiencing troubles with CouchDB crashing intermittently with +a segmentation fault or a bus error, you will need to install your own +version of OpenSSL. See the troubleshooting guide, mentioned above, +for more information. + +FreeBSD +------- + +FreeBSD requires the use of GNU Make. Where `make` is specified in this +documentation, substitute `gmake`. + +You can install this by running: + + pkg install gmake + +Installing +---------- + +Once you have satisfied the dependencies you should run: + + ./configure + +This script will configure CouchDB to be installed into `/usr/local` +by default. + +If you wish to customize the installation, pass `--help` to this +script. + +If everything was successful you should see the following message: + + You have configured Apache CouchDB, time to relax. + +Relax. + +To install CouchDB you should run: + + make && sudo make install + +You only need to use `sudo` if you're installing into a system directory. + +Try `gmake` if `make` is giving you any problems. + +If everything was successful you should see the following message: + + You have installed Apache CouchDB, time to relax. + +Relax. + +User Registration +----------------- + +You should create a special `couchdb` user for CouchDB. + +On many Unix-like systems you can run: + + adduser --system \ + --home /usr/local/var/lib/couchdb \ + --no-create-home \ + --shell /bin/bash \ + --group --gecos \ + "CouchDB Administrator" couchdb + +On Mac OS X you can use the Workgroup Manager to create users: + + http://www.apple.com/support/downloads/serveradmintools1047.html + +You must make sure that: + + * The user has a working POSIX shell + + * The user's home directory is `/usr/local/var/lib/couchdb` + +You can test this by: + + * Trying to log in as the `couchdb` user + + * Running `pwd` and checking the present working directory + +Change the ownership of the CouchDB directories by running: + + chown -R couchdb:couchdb /usr/local/etc/couchdb + chown -R couchdb:couchdb /usr/local/var/lib/couchdb + chown -R couchdb:couchdb /usr/local/var/log/couchdb + chown -R couchdb:couchdb /usr/local/var/run/couchdb + +Change the permission of the CouchDB directories by running: + + chmod 0770 /usr/local/etc/couchdb + chmod 0770 /usr/local/var/lib/couchdb + chmod 0770 /usr/local/var/log/couchdb + chmod 0770 /usr/local/var/run/couchdb + +Update the permissions for your `default.ini` file: + + chmod 0644 /usr/local/etc/couchdb/default.ini + +First Run +--------- + +You can start the CouchDB server by running: + + sudo -i -u couchdb couchdb + +This uses the `sudo` command to run the `couchdb` command as the +`couchdb` user. + +When CouchDB starts it should eventually display the following +message: + + Apache CouchDB has started, time to relax. + +Relax. + +To check that everything has worked, point your web browser to: + + http://127.0.0.1:5984/_utils/index.html + +From here you should run the test suite in Firefox. + +Running as a Daemon +------------------- + +SysV/BSD-style Systems +~~~~~~~~~~~~~~~~~~~~~~ + +You can use the `couchdb` init script to control the CouchDB daemon. + +On SysV-style systems, the init script will be installed into: + + /usr/local/etc/init.d + +On BSD-style systems, the init script will be installed into: + + /usr/local/etc/rc.d + +We use the `[init.d|rc.d]` notation to refer to both of these +directories. + +You can control the CouchDB daemon by running: + + /usr/local/etc/[init.d|rc.d]/couchdb [start|stop|restart|status] + +If you wish to configure how the init script works, you can edit: + + /usr/local/etc/default/couchdb + +Comment out the `COUCHDB_USER` setting if you're running as a +non-superuser. + +To start the daemon on boot, copy the init script to: + + /etc/[init.d|rc.d] + +You should then configure your system to run the init script +automatically. + +You may be able to run: + + sudo update-rc.d couchdb defaults + +If this fails, consult your system documentation for more information. + +A `logrotate` configuration is installed into: + + /usr/local/etc/logrotate.d/couchdb + +Consult your `logrotate` documentation for more information. + +It is critical that the CouchDB logs are rotated so as not to fill +your disk. + +Mac OS X +~~~~~~~~ + +You can use the `launchctl` command to control the CouchDB daemon. + +You can load the configuration by running: + + sudo launchctl load \ + /usr/local/Library/LaunchDaemons/org.apache.couchdb.plist + +You can stop the CouchDB daemon by running: + + sudo launchctl unload \ + /usr/local/Library/LaunchDaemons/org.apache.couchdb.plist + +You can start CouchDB by running: + + sudo launchctl start org.apache.couchdb + +You can restart CouchDB by running: + + sudo launchctl stop org.apache.couchdb + +You can edit the launchd configuration by running: + + open /usr/local/Library/LaunchDaemons/org.apache.couchdb.plist + +To start the daemon on boot, copy the configuration file to: + + /Library/LaunchDaemons + +Consult your system documentation for more information. http://git-wip-us.apache.org/repos/asf/couchdb/blob/a1ecde1e/INSTALL.Windows ---------------------------------------------------------------------- diff --git a/INSTALL.Windows b/INSTALL.Windows deleted file mode 100644 index 29c69b0..0000000 --- a/INSTALL.Windows +++ /dev/null @@ -1,204 +0,0 @@ -Apache CouchDB INSTALL.Windows -============================== - -For a high-level guide to Microsoft Windows. - -Troubleshooting ---------------- - -There is a troubleshooting guide: - - http://wiki.apache.org/couchdb/Troubleshooting - -There is a wiki for general documentation: - - http://wiki.apache.org/couchdb/ - -And some Windows-specific tips: - - http://wiki.apache.org/couchdb/Quirks_on_Windows - -There are collection of friendly mailing lists: - - http://couchdb.apache.org/community/lists.html - -Please work through these in order if you experience any problems. - -Dependencies ------------- - -You will need the following installed: - - * Erlang OTP (>=14B01, <R17) (http://erlang.org/) - * ICU (>=4.*) (http://icu-project.org/) - * OpenSSL (>=0.9.8r) (http://www.openssl.org/) - * Mozilla SpiderMonkey (=1.8.5) (http://www.mozilla.org/js/spidermonkey/) - * libcurl (>=7.20) (http://curl.haxx.se/libcurl/) - * Cygwin (http://www.cygwin.com/) - * Microsoft SDK 7.0 or 7.1 (http://www.microsoft.com/en-us/download/details.aspx?id=8279) - * Python (>= 2.68) for docs (http://python.org/) - * Python Sphinx (>=1.1.3) (http://pypi.python.org/pypi/Sphinx) - -General Notes -------------- - - * When installing Cygwin, be sure to select all the `development` tools. - - * When installing Erlang, you must build it from source. - - * The CouchDB build requires a number of the Erlang build scripts. - - * All dependent libraries should be built with the same version of - microsoft SDK. - - * Do not try to link against libraries built with, or included in, - Cygwin or MingW. They are not compatible with the Erlang/OTP or CouchDB - build scripts. - - * ICU version 4.6 and later will build cleanly using MSBuild. - - * Python and Sphinx are optional for building the online documentation. - Use cygwin-provided Python and install Sphinx via easy_install or pip. - Further information is here http://pypi.python.org/pypi/setuptools#id4 - -Setting Up Cygwin ------------------ - -Before starting any Cygwin terminals, run: - - set CYGWIN=nontsec - -To set up your environment, run: - - [VS_BIN]/vcvars32.bat - -Replace [VS_BIN] with the path to your Visual Studio `bin` directory. - -You must check that: - - * The `which link` command points to the Microsoft linker. - - * The `which cl` command points to the Microsoft compiler. - - * The `which mc` command points to the Microsoft message compiler. - - * The `which mt` command points to the Microsoft manifest tool. - - * The `which nmake` command points to the Microsoft make tool. - -If you do not do this, the build may fail due to Cygwin ones found in `/usr/bin` -being used instead. - -Building Erlang ---------------- - -You must include Win32 OpenSSL, built statically from source. Use -exactly the same version as required by the Erlang/OTP build process. - -However, you can skip the GUI tools by running: - - echo "skipping gs" > lib/gs/SKIP - - echo "skipping ic" > lib/ic/SKIP - - echo "skipping jinterface" > lib/jinterface/SKIP - -Follow the rest of the Erlang instructions as described. - -After running: - - ./otp_build release -a - -You should run: - - ./release/win32/Install.exe -s - -This will set up the release/win32/bin directory correctly. The CouchDB -installation scripts currently write their data directly into this -location. - -To set up your environment for building CouchDB, run: - - eval `./otp_build env_win32` - -To set up the `ERL_TOP` environment variable, run: - - export ERL_TOP=[ERL_TOP] - -Replace `[ERL_TOP]` with the Erlang source directory name. - -Remember to use `/cygdrive/c/` instead of `c:/` as the directory prefix. - -To set up your path, run: - - export PATH=$ERL_TOP/release/win32/erts-5.8.5/bin:$PATH - -If everything was successful, you should be ready to build CouchDB. - -Relax. - -Building CouchDB ----------------- - -Note that `win32-curl` is only required if you wish to run the developer -tests. - -The documentation step may be skipped using `--disable-docs` if you wish. - -Once you have satisfied the dependencies you should run: - - ./configure \ - --with-js-include=/cygdrive/c/path_to_spidermonkey_include \ - --with-js-lib=/cygdrive/c/path_to_spidermonkey_lib \ - --with-win32-icu-binaries=/cygdrive/c/path_to_icu_binaries_root \ - --with-erlang=$ERL_TOP/release/win32/usr/include \ - --with-win32-curl=/cygdrive/c/path/to/curl/root/directory \ - --with-openssl-bin-dir=/cygdrive/c/openssl/bin \ - --with-msvc-redist-dir=/cygdrive/c/dir/with/vcredist_platform_executable \ - --disable-init \ - --disable-launchd \ - --prefix=$ERL_TOP/release/win32 - -This command could take a while to complete. - -If everything was successful you should see the following message: - - You have configured Apache CouchDB, time to relax. - -Relax. - -To install CouchDB you should run: - - make install - -If everything was successful you should see the following message: - - You have installed Apache CouchDB, time to relax. - -Relax. - -To build the .exe installer package, you should run: - - make dist - -Alternatively, you may run CouchDB directly from the build tree, but -to avoid any contamination do not run `make dist` after this. - -First Run ---------- - -You can start the CouchDB server by running: - - $ERL_TOP/release/win32/bin/couchdb.bat - -When CouchDB starts it should eventually display the following message: - - Apache CouchDB has started, time to relax. - -Relax. - -To check that everything has worked, point your web browser to: - - http://127.0.0.1:5984/_utils/index.html - -From here you should run the verification tests in Firefox. http://git-wip-us.apache.org/repos/asf/couchdb/blob/a1ecde1e/INSTALL.Windows.md ---------------------------------------------------------------------- diff --git a/INSTALL.Windows.md b/INSTALL.Windows.md new file mode 100644 index 0000000..29c69b0 --- /dev/null +++ b/INSTALL.Windows.md @@ -0,0 +1,204 @@ +Apache CouchDB INSTALL.Windows +============================== + +For a high-level guide to Microsoft Windows. + +Troubleshooting +--------------- + +There is a troubleshooting guide: + + http://wiki.apache.org/couchdb/Troubleshooting + +There is a wiki for general documentation: + + http://wiki.apache.org/couchdb/ + +And some Windows-specific tips: + + http://wiki.apache.org/couchdb/Quirks_on_Windows + +There are collection of friendly mailing lists: + + http://couchdb.apache.org/community/lists.html + +Please work through these in order if you experience any problems. + +Dependencies +------------ + +You will need the following installed: + + * Erlang OTP (>=14B01, <R17) (http://erlang.org/) + * ICU (>=4.*) (http://icu-project.org/) + * OpenSSL (>=0.9.8r) (http://www.openssl.org/) + * Mozilla SpiderMonkey (=1.8.5) (http://www.mozilla.org/js/spidermonkey/) + * libcurl (>=7.20) (http://curl.haxx.se/libcurl/) + * Cygwin (http://www.cygwin.com/) + * Microsoft SDK 7.0 or 7.1 (http://www.microsoft.com/en-us/download/details.aspx?id=8279) + * Python (>= 2.68) for docs (http://python.org/) + * Python Sphinx (>=1.1.3) (http://pypi.python.org/pypi/Sphinx) + +General Notes +------------- + + * When installing Cygwin, be sure to select all the `development` tools. + + * When installing Erlang, you must build it from source. + + * The CouchDB build requires a number of the Erlang build scripts. + + * All dependent libraries should be built with the same version of + microsoft SDK. + + * Do not try to link against libraries built with, or included in, + Cygwin or MingW. They are not compatible with the Erlang/OTP or CouchDB + build scripts. + + * ICU version 4.6 and later will build cleanly using MSBuild. + + * Python and Sphinx are optional for building the online documentation. + Use cygwin-provided Python and install Sphinx via easy_install or pip. + Further information is here http://pypi.python.org/pypi/setuptools#id4 + +Setting Up Cygwin +----------------- + +Before starting any Cygwin terminals, run: + + set CYGWIN=nontsec + +To set up your environment, run: + + [VS_BIN]/vcvars32.bat + +Replace [VS_BIN] with the path to your Visual Studio `bin` directory. + +You must check that: + + * The `which link` command points to the Microsoft linker. + + * The `which cl` command points to the Microsoft compiler. + + * The `which mc` command points to the Microsoft message compiler. + + * The `which mt` command points to the Microsoft manifest tool. + + * The `which nmake` command points to the Microsoft make tool. + +If you do not do this, the build may fail due to Cygwin ones found in `/usr/bin` +being used instead. + +Building Erlang +--------------- + +You must include Win32 OpenSSL, built statically from source. Use +exactly the same version as required by the Erlang/OTP build process. + +However, you can skip the GUI tools by running: + + echo "skipping gs" > lib/gs/SKIP + + echo "skipping ic" > lib/ic/SKIP + + echo "skipping jinterface" > lib/jinterface/SKIP + +Follow the rest of the Erlang instructions as described. + +After running: + + ./otp_build release -a + +You should run: + + ./release/win32/Install.exe -s + +This will set up the release/win32/bin directory correctly. The CouchDB +installation scripts currently write their data directly into this +location. + +To set up your environment for building CouchDB, run: + + eval `./otp_build env_win32` + +To set up the `ERL_TOP` environment variable, run: + + export ERL_TOP=[ERL_TOP] + +Replace `[ERL_TOP]` with the Erlang source directory name. + +Remember to use `/cygdrive/c/` instead of `c:/` as the directory prefix. + +To set up your path, run: + + export PATH=$ERL_TOP/release/win32/erts-5.8.5/bin:$PATH + +If everything was successful, you should be ready to build CouchDB. + +Relax. + +Building CouchDB +---------------- + +Note that `win32-curl` is only required if you wish to run the developer +tests. + +The documentation step may be skipped using `--disable-docs` if you wish. + +Once you have satisfied the dependencies you should run: + + ./configure \ + --with-js-include=/cygdrive/c/path_to_spidermonkey_include \ + --with-js-lib=/cygdrive/c/path_to_spidermonkey_lib \ + --with-win32-icu-binaries=/cygdrive/c/path_to_icu_binaries_root \ + --with-erlang=$ERL_TOP/release/win32/usr/include \ + --with-win32-curl=/cygdrive/c/path/to/curl/root/directory \ + --with-openssl-bin-dir=/cygdrive/c/openssl/bin \ + --with-msvc-redist-dir=/cygdrive/c/dir/with/vcredist_platform_executable \ + --disable-init \ + --disable-launchd \ + --prefix=$ERL_TOP/release/win32 + +This command could take a while to complete. + +If everything was successful you should see the following message: + + You have configured Apache CouchDB, time to relax. + +Relax. + +To install CouchDB you should run: + + make install + +If everything was successful you should see the following message: + + You have installed Apache CouchDB, time to relax. + +Relax. + +To build the .exe installer package, you should run: + + make dist + +Alternatively, you may run CouchDB directly from the build tree, but +to avoid any contamination do not run `make dist` after this. + +First Run +--------- + +You can start the CouchDB server by running: + + $ERL_TOP/release/win32/bin/couchdb.bat + +When CouchDB starts it should eventually display the following message: + + Apache CouchDB has started, time to relax. + +Relax. + +To check that everything has worked, point your web browser to: + + http://127.0.0.1:5984/_utils/index.html + +From here you should run the verification tests in Firefox. http://git-wip-us.apache.org/repos/asf/couchdb/blob/a1ecde1e/README-DEV ---------------------------------------------------------------------- diff --git a/README-DEV b/README-DEV deleted file mode 100644 index 997e3db..0000000 --- a/README-DEV +++ /dev/null @@ -1,194 +0,0 @@ -Apache CouchDB DEVELOPERS -========================= - -Before you start here, read `INSTALL.Unix` (or `INSTALL.Windows`) and -follow the setup instructions including the installation of all the -listed dependencies for your system. - -Only follow these instructions if you are building from a source checkout. - -If you're unsure what this means, ignore this document. - -Dependencies ------------- - -You will need the following installed: - - * Rebar (>=2.5.0) (https://github.com/rebar/rebar) - -You may also need: - - * Sphinx (http://sphinx.pocoo.org/) - * LaTex (http://www.latex-project.org/) - * GNU Texinfo (http://www.gnu.org/software/texinfo/) - * GNU help2man (http://www.gnu.org/software/help2man/) - * GnuPG (http://www.gnupg.org/) - * md5sum (http://www.microbrew.org/tools/md5sha1sum/) - * sha1sum (http://www.microbrew.org/tools/md5sha1sum/) - -The first of these optional dependencies are required for building the -documentation. The last three are needed to build releases. - -You will need these optional dependencies installed if: - - * You are working on the documentation, or - * You are preparing a distribution archive - -However, you do not need them if: - - * You are building from a distribution archive, or - * You don't care about building the documentation - -If you intend to build Fauxton, you will also need to install its -dependencies. After running ./configure to download all of the -dependent repositories, you can read about required dependencies in -`src/fauxton/readme.md`. Typically, installing npm and node.js are -sufficient to enable a Fauxton build. - -Here is a list of *optional* dependencies for various operating systems. -Installation will be easiest, when you install them all. - -Debian-based (inc. Ubuntu) Systems -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - sudo apt-get install help2man python-sphinx \ - texlive-latex-base texlive-latex-recommended \ - texlive-latex-extra texlive-fonts-recommended texinfo gnupg - -Gentoo-based Systems -~~~~~~~~~~~~~~~~~~~~ - - sudo emerge texinfo gnupg coreutils pkgconfig help2man - sudo USE=latex emerge sphinx - -RedHat-based (Fedora, Centos, RHEL) Systems -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - sudo yum install help2man python-sphinx python-docutils \ - python-pygments texlive-latex texlive-latex-fonts texinfo gnupg - -Mac OS X -~~~~~~~~ - -Install Homebrew, if you do not have it already: - - https://github.com/mxcl/homebrew - -Unless you want to install the optional dependencies, skip to the next section. - -Install what else we can with Homebrew: - - brew install help2man gnupg md5sha1sum - -If you don't already have pip installed, install it: - - sudo easy_install pip - -Now, install the required Python packages: - - sudo pip install sphinx - sudo pip install docutils - sudo pip install pygments - -Download MaxTeX from here: - - http://www.tug.org/mactex/ - -Follow the instructions to get a working LaTeX install on your system. - -FreeBSD -------- - - - pkg install help2man texinfo gnupg py27-sphinx texlive-full tex-formats - -Windows -~~~~~~~ - -Follow the instructions in INSTALL.Windows and build all components from -source, using the same Visual C++ compiler and runtime. - -Configuring ------------ - -Configure the source by running: - - ./configure - -If you intend to run the test suites: - - ./configure -c - -If you want to build it into different destination than `/usr/local`. - - ./configure --prefix=/<your directory path> - -Testing -------- - -Check the test suite by running: - - make check - -Generate a coverage report by running: - - make cover - -Please report any problems to the developer's mailing list. - -Testing a cluster ------------------ - -We use Docker (https://docker.io) to safely run a local three node -cluster all inside a single docker container. - -Assuming you have Docker installed and running: - - make docker-image - -This will create a docker image (tagged 'couchdb/dev-cluster') capable -of running a joined three node cluster. - -To start it up: - - make docker-start - -A three node cluster should now be running (you can now use `docker ps` -to find the exposed ports of the nodes). - -To stop it: - - make docker-stop - -Releasing ---------- - -The release procedure is documented here: - - https://wiki.apache.org/couchdb/Release_Procedure - -Unix-like Systems -~~~~~~~~~~~~~~~~~ - -Prepare the release artefacts by running: - - make distcheck - -You can prepare signed release artefacts by running: - - make distsign - -The release artefacts can be found in the root source directory. - -Microsoft Windows -~~~~~~~~~~~~~~~~~ - -Prepare the release artefacts by running: - - make dist - -The release artefacts can be found in the `etc/windows` directory. - -Until the build system has been improved, you must make sure that you run this -command from a clean source checkout. If you do not, your test database and log -files will be bundled up in the release artefact. http://git-wip-us.apache.org/repos/asf/couchdb/blob/a1ecde1e/README-DEV.md ---------------------------------------------------------------------- diff --git a/README-DEV.md b/README-DEV.md new file mode 100644 index 0000000..997e3db --- /dev/null +++ b/README-DEV.md @@ -0,0 +1,194 @@ +Apache CouchDB DEVELOPERS +========================= + +Before you start here, read `INSTALL.Unix` (or `INSTALL.Windows`) and +follow the setup instructions including the installation of all the +listed dependencies for your system. + +Only follow these instructions if you are building from a source checkout. + +If you're unsure what this means, ignore this document. + +Dependencies +------------ + +You will need the following installed: + + * Rebar (>=2.5.0) (https://github.com/rebar/rebar) + +You may also need: + + * Sphinx (http://sphinx.pocoo.org/) + * LaTex (http://www.latex-project.org/) + * GNU Texinfo (http://www.gnu.org/software/texinfo/) + * GNU help2man (http://www.gnu.org/software/help2man/) + * GnuPG (http://www.gnupg.org/) + * md5sum (http://www.microbrew.org/tools/md5sha1sum/) + * sha1sum (http://www.microbrew.org/tools/md5sha1sum/) + +The first of these optional dependencies are required for building the +documentation. The last three are needed to build releases. + +You will need these optional dependencies installed if: + + * You are working on the documentation, or + * You are preparing a distribution archive + +However, you do not need them if: + + * You are building from a distribution archive, or + * You don't care about building the documentation + +If you intend to build Fauxton, you will also need to install its +dependencies. After running ./configure to download all of the +dependent repositories, you can read about required dependencies in +`src/fauxton/readme.md`. Typically, installing npm and node.js are +sufficient to enable a Fauxton build. + +Here is a list of *optional* dependencies for various operating systems. +Installation will be easiest, when you install them all. + +Debian-based (inc. Ubuntu) Systems +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + sudo apt-get install help2man python-sphinx \ + texlive-latex-base texlive-latex-recommended \ + texlive-latex-extra texlive-fonts-recommended texinfo gnupg + +Gentoo-based Systems +~~~~~~~~~~~~~~~~~~~~ + + sudo emerge texinfo gnupg coreutils pkgconfig help2man + sudo USE=latex emerge sphinx + +RedHat-based (Fedora, Centos, RHEL) Systems +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + sudo yum install help2man python-sphinx python-docutils \ + python-pygments texlive-latex texlive-latex-fonts texinfo gnupg + +Mac OS X +~~~~~~~~ + +Install Homebrew, if you do not have it already: + + https://github.com/mxcl/homebrew + +Unless you want to install the optional dependencies, skip to the next section. + +Install what else we can with Homebrew: + + brew install help2man gnupg md5sha1sum + +If you don't already have pip installed, install it: + + sudo easy_install pip + +Now, install the required Python packages: + + sudo pip install sphinx + sudo pip install docutils + sudo pip install pygments + +Download MaxTeX from here: + + http://www.tug.org/mactex/ + +Follow the instructions to get a working LaTeX install on your system. + +FreeBSD +------- + + + pkg install help2man texinfo gnupg py27-sphinx texlive-full tex-formats + +Windows +~~~~~~~ + +Follow the instructions in INSTALL.Windows and build all components from +source, using the same Visual C++ compiler and runtime. + +Configuring +----------- + +Configure the source by running: + + ./configure + +If you intend to run the test suites: + + ./configure -c + +If you want to build it into different destination than `/usr/local`. + + ./configure --prefix=/<your directory path> + +Testing +------- + +Check the test suite by running: + + make check + +Generate a coverage report by running: + + make cover + +Please report any problems to the developer's mailing list. + +Testing a cluster +----------------- + +We use Docker (https://docker.io) to safely run a local three node +cluster all inside a single docker container. + +Assuming you have Docker installed and running: + + make docker-image + +This will create a docker image (tagged 'couchdb/dev-cluster') capable +of running a joined three node cluster. + +To start it up: + + make docker-start + +A three node cluster should now be running (you can now use `docker ps` +to find the exposed ports of the nodes). + +To stop it: + + make docker-stop + +Releasing +--------- + +The release procedure is documented here: + + https://wiki.apache.org/couchdb/Release_Procedure + +Unix-like Systems +~~~~~~~~~~~~~~~~~ + +Prepare the release artefacts by running: + + make distcheck + +You can prepare signed release artefacts by running: + + make distsign + +The release artefacts can be found in the root source directory. + +Microsoft Windows +~~~~~~~~~~~~~~~~~ + +Prepare the release artefacts by running: + + make dist + +The release artefacts can be found in the `etc/windows` directory. + +Until the build system has been improved, you must make sure that you run this +command from a clean source checkout. If you do not, your test database and log +files will be bundled up in the release artefact. http://git-wip-us.apache.org/repos/asf/couchdb/blob/a1ecde1e/license.skip ---------------------------------------------------------------------- diff --git a/license.skip b/license.skip index 55adcd8..c1bd0e9 100644 --- a/license.skip +++ b/license.skip @@ -3,15 +3,16 @@ ^.*.DS_Store ^.*.beam ^AUTHORS -^BUGS +^BUGS.md +^COMMITTERS.md ^CHANGES ^DEVELOPERS ^DEVELOPERS.gz -^INSTALL -^INSTALL.Unix -^INSTALL.Unix.gz -^INSTALL.Windows -^INSTALL.Windows.gz +^INSTALL.md +^INSTALL.Unix.md +^INSTALL.Unix.md.gz +^INSTALL.Windows.md +^INSTALL.Windows.md.gz ^INSTALL.gz ^LICENSE.gz ^Makefile @@ -19,6 +20,8 @@ ^NEWS ^NOTICE ^README +^README.rst +^README-DEV.md ^THANKS ^aclocal.m4 ^apache-couchdb-.*
