Skip to content
Browse files

improved documentation with regard to troublshooting, wiki, and maili…

…ng lists
  • Loading branch information...
1 parent 0585879 commit cc486419b7d2e6758c85278331208871d61f75d9 @nslater nslater committed Oct 29, 2011
Showing with 51 additions and 13 deletions.
  1. +33 −12 INSTALL.Unix
  2. +18 −1 INSTALL.Windows
View
45 INSTALL.Unix
@@ -3,35 +3,49 @@ 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/)
* OpenSSL (http://www.openssl.org/)
* Mozilla SpiderMonkey (1.8) (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
~~~~~~~~~~~~~~~~~~~~
@@ -59,7 +73,14 @@ You can install the other dependencies by running:
You will need Homebrew installed to use the `brew` command.
-Learn more about Homebrew at http://mxcl.github.com/homebrew/
+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.
Installing
----------
@@ -111,7 +132,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
-----------------------
View
19 INSTALL.Windows
@@ -3,6 +3,23 @@ Apache CouchDB README.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/
+
+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
------------
@@ -150,4 +167,4 @@ 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 either Firefox 3.6+ or Safari 4+.
+From here you should run the test suite in Firefox.

0 comments on commit cc48641

Please sign in to comment.
Something went wrong with that request. Please try again.