Backport INSTALL.Unix updates from master.
Project: http://git-wip-us.apache.org/repos/asf/couchdb/repo Commit: http://git-wip-us.apache.org/repos/asf/couchdb/commit/9c966cb0 Tree: http://git-wip-us.apache.org/repos/asf/couchdb/tree/9c966cb0 Diff: http://git-wip-us.apache.org/repos/asf/couchdb/diff/9c966cb0 Branch: refs/heads/1.2.x Commit: 9c966cb02d86b7b0430522f4807522fc2c77cd68 Parents: 71a0f58 Author: Jan Lehnardt <[email protected]> Authored: Mon Jan 30 19:47:00 2012 +0100 Committer: Jan Lehnardt <[email protected]> Committed: Mon Feb 6 19:47:54 2012 +0100 ---------------------------------------------------------------------- INSTALL.Unix | 57 ++++++++++++++++++++++++++++++++++++++++------------ 1 files changed, 44 insertions(+), 13 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/couchdb/blob/9c966cb0/INSTALL.Unix ---------------------------------------------------------------------- diff --git a/INSTALL.Unix b/INSTALL.Unix index becbf06..baf9d06 100644 --- a/INSTALL.Unix +++ b/INSTALL.Unix @@ -3,10 +3,27 @@ Apache CouchDB README.Unix A high-level guide to Unix-like systems, inc. Mac OS X and Ubuntu. +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 will need the following installed: +You should have the following installed: * Erlang OTP (>=R12B5) (http://erlang.org/) * ICU (http://icu.sourceforge.net/) @@ -14,24 +31,21 @@ You will need the following installed: * Mozilla SpiderMonkey (1.7) (http://www.mozilla.org/js/spidermonkey/) * GNU Make (http://www.gnu.org/software/make/) * GNU Compiler Collection (http://gcc.gnu.org/) - -It is recommended that you install Erlang OTP R12B-5 or above where possible. - -Optional dependencies: - * libcurl (http://curl.haxx.se/libcurl/) + * help2man (http://www.gnu.org/s/help2man/) -This only affects the command line JavaScript test suite which -most users do not use. +It is recommended that you install Erlang OTP R12B-5 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. Ubuntu ~~~~~~ -See +For up to date instructions, please see: http://wiki.apache.org/couchdb/Installing_on_Ubuntu -for updated instructions on how to install on Ubuntu. +Unfortunately, it seems that installing dependancies on Ubuntu is troublesome. Debian-based Systems ~~~~~~~~~~~~~~~~~~~~ @@ -55,9 +69,26 @@ You can install the build tools by running: You can install the other dependencies by running: - sudo port install icu erlang spidermonkey curl + brew install erlang icu4c spidermonkey curl + +You may want to link ICU so that CouchDB can find the header files automatically: + + brew link icu4c + +The same is true for recent versions of Erlang: + + brew link erlang + +You will need Homebrew installed to use the `brew` command. + +Learn more about Homebrew at: + + http://mxcl.github.com/homebrew/ -You will need MacPorts installed to use the `port` command. +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. Installing ---------- @@ -109,7 +140,7 @@ 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. +From here you should run the test suite in Firefox. Security Considerations -----------------------
