diff options
author | Jan Lehnardt <jan@apache.org> | 2013-10-07 11:38:59 +0200 |
---|---|---|
committer | Jan Lehnardt <jan@apache.org> | 2013-10-07 11:38:59 +0200 |
commit | f7a18d3d5a10b460f4fe4d7d00f86275d5257190 (patch) | |
tree | 478e0adb4a0bf3c27303a752a6648d945d0796a7 | |
parent | cdf852d14e050a62423e28d54e90e4a51c1ad181 (diff) | |
download | couchdb-f7a18d3d5a10b460f4fe4d7d00f86275d5257190.tar.gz |
72 char columns
-rw-r--r-- | INSTALL.Unix | 74 |
1 files changed, 45 insertions, 29 deletions
diff --git a/INSTALL.Unix b/INSTALL.Unix index 47cc863a2..a54204da2 100644 --- a/INSTALL.Unix +++ b/INSTALL.Unix @@ -10,11 +10,12 @@ Community installation guides are available on the wiki: 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. +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 --------------- @@ -49,10 +50,11 @@ You should have the following installed: * 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. +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 ~~~~~~~~~~~~~~~~~~~~ @@ -70,11 +72,13 @@ You can install the dependencies by running: sudo apt-get install libcurl4-openssl-dev sudo apt-get install pkg-config -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. +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. +Be sure to update the version numbers to match your system's available +packages. For up to date instructions, please see: @@ -82,7 +86,8 @@ For up to date instructions, please see: http://wiki.apache.org/couchdb/Installing_on_Ubuntu -Unfortunately, it seems that installing dependencies on Ubuntu is troublesome. +Unfortunately, it seems that installing dependencies on Ubuntu is +troublesome. RedHat-based (Fedora, Centos, RHEL) Systems ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -104,13 +109,15 @@ You can install the dependencies by running: sudo yum install curl-devel sudo yum install pkg-config -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. +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 Xcode. +To build CouchDB from source on Mac OS X, you will need to install +Xcode. You can install the other dependencies by running: @@ -130,10 +137,11 @@ 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. +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 ---------- @@ -142,9 +150,11 @@ Once you have satisfied the dependencies you should run: ./configure -This script will configure CouchDB to be installed into `/usr/local` by default. +This script will configure CouchDB to be installed into `/usr/local` +by default. -If you wish to customise the installation, pass `--help` to this script. +If you wish to customise the installation, pass `--help` to this +script. If everything was successful you should see the following message: @@ -173,9 +183,11 @@ 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. +This uses the `sudo` command to run the `couchdb` command as the +`couchdb` user. -When CouchDB starts it should eventually display the following message: +When CouchDB starts it should eventually display the following +message: Apache CouchDB has started, time to relax. @@ -251,7 +263,8 @@ 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. +We use the `[init.d|rc.d]` notation to refer to both of these +directories. You can control the CouchDB daemon by running: @@ -261,13 +274,15 @@ 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. +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 should then configure your system to run the init script +automatically. You may be able to run: @@ -281,7 +296,8 @@ A `logrotate` configuration is installed into: Consult your `logrotate` documentation for more information. -It is critical that the CouchDB logs are rotated so as not to fill your disk. +It is critical that the CouchDB logs are rotated so as not to fill +your disk. Mac OS X ~~~~~~~~ |