summaryrefslogtreecommitdiff
path: root/INSTALL.Unix
diff options
context:
space:
mode:
authorNoah Slater <nslater@apache.org>2010-03-13 15:44:55 +0000
committerNoah Slater <nslater@apache.org>2010-03-13 15:44:55 +0000
commitf3303f24d376860a63ec735a1bc96c406473ad4f (patch)
tree98638c3b2fc84676a4c07daf6eb561ce07013aa0 /INSTALL.Unix
parent3eb752a9624cbfa6b99fae4358af03dd0853e887 (diff)
documentation improvements
git-svn-id: https://svn.apache.org/repos/asf/couchdb/trunk@922586 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'INSTALL.Unix')
-rw-r--r--INSTALL.Unix43
1 files changed, 32 insertions, 11 deletions
diff --git a/INSTALL.Unix b/INSTALL.Unix
index e6495eb3..93b4803d 100644
--- a/INSTALL.Unix
+++ b/INSTALL.Unix
@@ -1,18 +1,20 @@
-Installing on Unix-like Systems
-===============================
+Apache CouchDB README.Unix
+==========================
+
+A high-level guide to Unix-like systems, inc. Mac OS X and Ubuntu.
Dependencies
------------
You will need the following installed:
- * Erlang OTP (>=R12B5) (http://erlang.org/)
- * ICU (http://icu.sourceforge.net/)
- * OpenSSL (http://www.openssl.org/)
- * Mozilla SpiderMonkey (>=1.7) (http://www.mozilla.org/js/spidermonkey/)
- * libcurl (http://curl.haxx.se/libcurl/)
- * GNU Make (http://www.gnu.org/software/make/)
- * GNU Compiler Collection (http://gcc.gnu.org/)
+ * 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/)
+ * libcurl (http://curl.haxx.se/libcurl/)
+ * 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.
@@ -45,8 +47,6 @@ You will need MacPorts installed to use the `port` command.
Installing
----------
-Skip to the
-
Once you have satisfied the dependencies you should run:
./configure
@@ -75,6 +75,27 @@ If everything was successful you should see the following message:
Relax.
+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.
+
Security Considerations
-----------------------