diff options
author | Joan Touzet <wohali@users.noreply.github.com> | 2020-10-09 12:49:34 -0400 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-10-09 12:49:34 -0400 |
commit | 0dc3e237914da9085b398806ac201e1571302043 (patch) | |
tree | 47596f8ea32fef5d78eac8a097acd0f708f18818 | |
parent | d263a7521489b3c5e958e2b15930ecebad0ae6db (diff) | |
download | couchdb-0dc3e237914da9085b398806ac201e1571302043.tar.gz |
minor INSTALL.Unix.md patches (#2536) (#3207)
-rw-r--r-- | INSTALL.Unix.md | 42 |
1 files changed, 22 insertions, 20 deletions
diff --git a/INSTALL.Unix.md b/INSTALL.Unix.md index 0c82628be..6a37f3de4 100644 --- a/INSTALL.Unix.md +++ b/INSTALL.Unix.md @@ -36,7 +36,7 @@ Please work through these in order if you experience any problems. You should have the following installed: - * Erlang OTP (>=R16B03-1, =<19.x) (http://erlang.org/) + * Erlang OTP (>= 19.x) (http://erlang.org/) * ICU (http://icu-project.org/) * OpenSSL (http://www.openssl.org/) * Mozilla SpiderMonkey - either 1.8.5 or 60 @@ -45,19 +45,20 @@ You should have the following installed: * https://archive.mozilla.org/pub/firefox/releases/60.9.0esr/source/ (src/js) * GNU Make (http://www.gnu.org/software/make/) * GNU Compiler Collection (http://gcc.gnu.org/) - * Python (>=2.7) (http://python.org/) + * Python (>=3.5) (http://python.org/) To build Fauxton, you should have the following installed: - * Node.JS (>=6.x) (https://nodejs.org/) + * Node.JS (>=10.x) (https://nodejs.org/) -- obtainable from NodeSource (https://github.com/nodesource/distributions) To build the documentation, you should have the following installed: * Python Sphinx (>=1.5) (http://pypi.python.org/pypi/Sphinx) + * Sphinx RT theme (https://github.com/readthedocs/sphinx_rtd_theme) -It is recommended that you install Erlang OTP R16B03-1 or above where possible. -Python and Sphinx are only required for building the online documentation. -Documentation build can be disabled by adding the `--disable-docs` flag to the -`configure` script. +It is recommended that you install Erlang OTP 20.3.8.11 or above where +possible. Sphinx and the RTD theme are only required for building the online +documentation. You can disable Fauxton and/or the documentation builds by +adding the --disable-fauxton and/or --disable-docs flag(s) to the configure script. ### Debian-based Systems @@ -65,17 +66,17 @@ You can install the dependencies by running: sudo apt-get --no-install-recommends -y install \ build-essential pkg-config erlang erlang-reltool \ - libicu-dev libmozjs-60-dev + libicu-dev libmozjs-60-dev python3 Your distribution may have libmozjs-68-dev instead of 60. Both are supported. -You can install the Node.JS dependencies via [NodeSource](https://github.com/nodesource/distributions#installation-instructions). +You can install Node.JS [NodeSource](https://github.com/nodesource/distributions#installation-instructions). You can install the documentation dependencies by running: sudo apt-get --no-install-recommends -y install \ python-sphinx - + sudo pip install --upgrade sphinx_rtd_theme nose requests hypothesis @@ -88,15 +89,16 @@ You can install the dependencies by running: sudo yum install autoconf autoconf-archive automake \ erlang-asn1 erlang-erts erlang-eunit erlang-xmerl \ - libmozjs-60-dev libicu-devel libtool perl-Test-Harness + libmozjs-60-dev libicu-devel libtool perl-Test-Harness \ + python3 -You can install the Node.JS dependencies via [NodeSource](https://github.com/nodesource/distributions#rpminstall). +You can install Node.JS via [NodeSource](https://github.com/nodesource/distributions#rpminstall). The built-in packages for Sphinx in RHEL repositories are too old to run the documentation build process. Instead, use pip: sudo yum install python-pip - sudo pip install sphinx + sudo pip install --upgrade sphinx nose requests hypothesis ### Mac OS X @@ -110,15 +112,15 @@ You can then install the other dependencies by running: brew install autoconf autoconf-archive automake libtool \ erlang icu4c spidermonkey pkg-config -You can install the Node.JS dependencies via the +You can install Node.JS via the [official Macintosh installer](https://nodejs.org/en/download/). You can install the documentation dependencies by running: sudo easy_install pip - sudo pip install sphinx + sudo pip install --upgrade sphinx nose requests hypothesis -You will need Homebrew installed to use the `brew` command. +You will need Homebrew installed to use the brew command. Learn more about Homebrew at: @@ -140,9 +142,9 @@ You can install this by running: You can install the remaining dependencies by running: - pkg install openssl icu git bash \ - autoconf automake libtool node spidermonkey60 \ - erlang node8 npm-node8 lang/python py27-sphinx py27-pip + pkg install openssl icu git bash autoconf \ + www/node npm libtool spidermonkey60 \ + erlang lang/python py37-sphinx py37-pip pip install --upgrade sphinx_rtd_theme nose requests hypothesis ## Installing @@ -243,7 +245,7 @@ From here you should verify your installation by pointing your web browser to: http://localhost:5984/_utils/#/verifyinstall -## Running as a Daemon +## Running as a daemon The couchdb team recommends [runit](http://smarden.org/runit/) to run CouchDB persistently and reliably. Configuration of runit is |