You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@couchdb.apache.org by kx...@apache.org on 2015/02/20 01:26:42 UTC
[09/26] documentation commit: updated refs/heads/master to 5a81ace
/src/install now follows the style
Project: http://git-wip-us.apache.org/repos/asf/couchdb-documentation/repo
Commit: http://git-wip-us.apache.org/repos/asf/couchdb-documentation/commit/805c32e4
Tree: http://git-wip-us.apache.org/repos/asf/couchdb-documentation/tree/805c32e4
Diff: http://git-wip-us.apache.org/repos/asf/couchdb-documentation/diff/805c32e4
Branch: refs/heads/master
Commit: 805c32e4dfb943c353e043a41ae9da2315b214d7
Parents: daf7fc5
Author: Maria Andersson <ma...@dualpose.com>
Authored: Fri Feb 6 22:20:53 2015 +0100
Committer: Maria Andersson <ma...@dualpose.com>
Committed: Fri Feb 6 22:20:53 2015 +0100
----------------------------------------------------------------------
src/install/freebsd.rst | 5 ++---
src/install/index.rst | 11 +++++------
src/install/mac.rst | 29 +++++++++++------------------
src/install/unix.rst | 33 +++++++++++++--------------------
src/install/windows.rst | 40 +++++++++++++++++++---------------------
5 files changed, 50 insertions(+), 68 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/805c32e4/src/install/freebsd.rst
----------------------------------------------------------------------
diff --git a/src/install/freebsd.rst b/src/install/freebsd.rst
index 85b74b5..dc749bf 100644
--- a/src/install/freebsd.rst
+++ b/src/install/freebsd.rst
@@ -10,7 +10,6 @@
.. License for the specific language governing permissions and limitations under
.. the License.
-
.. _install/freebsd:
=======================
@@ -68,8 +67,8 @@ The user is added to ``/etc/passwd`` and should look similar to the following:
.. code-block:: text
- shell# grep couchdb /etc/passwd
- couchdb:*:1013:1013:Couchdb, time to relax:/var/lib/couchdb/:/usr/sbin/nologin
+ shell# grep couchdb /etc/passwd
+ couchdb:*:1013:1013:Couchdb, time to relax:/var/lib/couchdb/:/usr/sbin/nologin
To change any of these settings, please refrain from editing `/etc/passwd` and
instead use ``pw user mod ...`` or ``vipw``. Make sure that the user has no
http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/805c32e4/src/install/index.rst
----------------------------------------------------------------------
diff --git a/src/install/index.rst b/src/install/index.rst
index 6703f9d..419ce63 100644
--- a/src/install/index.rst
+++ b/src/install/index.rst
@@ -10,7 +10,6 @@
.. License for the specific language governing permissions and limitations under
.. the License.
-
.. _install:
============
@@ -18,9 +17,9 @@ Installation
============
.. toctree::
- :maxdepth: 2
+ :maxdepth: 2
- unix
- windows
- mac
- freebsd
+ unix
+ windows
+ mac
+ freebsd
http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/805c32e4/src/install/mac.rst
----------------------------------------------------------------------
diff --git a/src/install/mac.rst b/src/install/mac.rst
index 3b0393b..de786c8 100644
--- a/src/install/mac.rst
+++ b/src/install/mac.rst
@@ -10,14 +10,12 @@
.. License for the specific language governing permissions and limitations under
.. the License.
-
.. _install/mac:
========================
Installation on Mac OS X
========================
-
.. _install/mac/binary:
Installation using the Apache CouchDB native application
@@ -76,12 +74,11 @@ Now it's time to brew CouchDB::
brew install couchdb
-
The above Erlang install will use the bottled (pre-compiled) version if you are:
using `/usr/local` for `homebrew`, and on 10.6 or 10.7. If you're not on one of
these, `homebrew` will build from source, so consider doing::
- brew install erlang --no-docs
+ brew install erlang --no-docs
to trim down compilation time.
@@ -91,18 +88,15 @@ git-based master (head) branch, or the next development release using this
This will allow quick installation of the future release branch when it becomes
active. If you're not sure if you need this, then you probably don't.
In both cases we assume you are comfortable identifying bugs, and handling any
-potential upgrades between commits to the codebase.
+potential upgrades between commits to the codebase. ::
-::
-
- brew install [--devel|--head] couchdb
+ brew install [--devel|--head] couchdb
.. note::
-
- OS X Lion might hang on the final brew.
- See the thread at https://github.com/mxcl/homebrew/issues/7024 it seems in
- most cases to be resolved by breaking out with ``CTRL-C`` and then repeating
- with ``brew install -v couchdb``.
+ OS X Lion might hang on the final brew.
+ See the thread at https://github.com/mxcl/homebrew/issues/7024 it seems in
+ most cases to be resolved by breaking out with ``CTRL-C`` and then repeating
+ with ``brew install -v couchdb``.
If you wish to have CouchDB run as a daemon then, set up the account,
using the "User & Groups" preference pane:
@@ -121,7 +115,6 @@ fault or a bus error, you will need to install your own version of OpenSSL.
.. _Homebrew: http://mxcl.github.com/homebrew/
-
Running as a Daemon
-------------------
@@ -168,20 +161,20 @@ To install CouchDB using MacPorts you have 2 package choices:
::
- $ sudo port install couchdb
+ $ sudo port install couchdb
should be enough. MacPorts takes care of installing all necessary dependencies.
If you have already installed some of the CouchDB dependencies via MacPorts,
run this command to check and upgrade any outdated ones, after installing
CouchDB::
- $ sudo port upgrade couchdb
+ $ sudo port upgrade couchdb
This will upgrade dependencies recursively, if there are more recent versions
available. If you want to run CouchDB as a service controlled by the OS, load
the launchd configuration which comes with the project, with this command::
- $ sudo port load couchdb
+ $ sudo port load couchdb
and it should be up and accessible via Futon at http://127.0.0.1:5984/_utils.
It should also be restarted automatically after reboot.
@@ -189,6 +182,6 @@ It should also be restarted automatically after reboot.
Updating the ports collection. The collection of port files has to be updated
to reflect the latest versions of available packages. In order to do that run::
- $ sudo port selfupdate
+ $ sudo port selfupdate
to update the port tree, and then install just as explained.
http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/805c32e4/src/install/unix.rst
----------------------------------------------------------------------
diff --git a/src/install/unix.rst b/src/install/unix.rst
index 76fe922..8332d63 100644
--- a/src/install/unix.rst
+++ b/src/install/unix.rst
@@ -10,7 +10,6 @@
.. License for the specific language governing permissions and limitations under
.. the License.
-
.. _install/unix:
=================================
@@ -26,13 +25,12 @@ 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.
.. seealso::
-
- `Community installation guides`_
+ `Community installation guides`_
.. _Community installation guides: http://wiki.apache.org/couchdb/Installation
Troubleshooting
----------------
+===============
* There is a `troubleshooting guide`_.
* There is a `wiki`_ for general documentation.
@@ -44,11 +42,10 @@ Please work through these in order if you experience any problems.
.. _wiki: http://wiki.apache.org/couchdb
.. _friendly mailing lists: http://couchdb.apache.org/community/lists.html
-
.. _install/unix/dependencies:
Dependencies
-------------
+============
You should have the following installed:
@@ -69,7 +66,7 @@ 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
-~~~~~~~~~~~~~~~~~~~~
+--------------------
You can install the dependencies by running::
@@ -92,13 +89,11 @@ Be sure to update the version numbers to match your system's available packages.
Unfortunately, it seems that installing dependencies on Ubuntu is troublesome.
.. seealso::
-
- * `Installing on Debian <http://wiki.apache.org/couchdb/Installing_on_Debian>`_
- * `Installing on Ubuntu <http://wiki.apache.org/couchdb/Installing_on_Ubuntu>`_
-
+ * `Installing on Debian <http://wiki.apache.org/couchdb/Installing_on_Debian>`_
+ * `Installing on Ubuntu <http://wiki.apache.org/couchdb/Installing_on_Ubuntu>`_
RedHat-based (Fedora, Centos, RHEL) Systems
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+-------------------------------------------
You can install the dependencies by running::
@@ -121,13 +116,12 @@ 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
-~~~~~~~~
+--------
Follow :ref:`install/mac/homebrew` reference till `brew install couchdb` step.
-
Installing
-----------
+==========
Once you have satisfied the dependencies you should run::
@@ -158,7 +152,7 @@ If everything was successful you should see the following message::
Relax.
First Run
----------
+=========
You can start the CouchDB server by running::
@@ -181,7 +175,7 @@ From here you should verify your installation by pointing your web browser to::
http://localhost:5984/_utils/verify_install.html
Security Considerations
------------------------
+=======================
You should create a special `couchdb` user for CouchDB.
@@ -222,12 +216,11 @@ Change the permission of the CouchDB directories by running::
.. _Workgroup Manager: http://www.apple.com/support/downloads/serveradmintools1047.html
-
Running as a Daemon
--------------------
+===================
SysV/BSD-style Systems
-~~~~~~~~~~~~~~~~~~~~~~
+----------------------
You can use the `couchdb` init script to control the CouchDB daemon.
http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/805c32e4/src/install/windows.rst
----------------------------------------------------------------------
diff --git a/src/install/windows.rst b/src/install/windows.rst
index b7b66af..89513bf 100644
--- a/src/install/windows.rst
+++ b/src/install/windows.rst
@@ -10,7 +10,6 @@
.. License for the specific language governing permissions and limitations under
.. the License.
-
.. _install/windows:
=======================
@@ -44,27 +43,27 @@ This is the simplest way to go.
#. It's time to Relax!
.. note::
- In some cases you might been asked to reboot Windows to complete
- installation process, because of using on different Microsoft Visual C++
- runtimes by CouchDB.
+ In some cases you might been asked to reboot Windows to complete
+ installation process, because of using on different Microsoft Visual C++
+ runtimes by CouchDB.
-.. note:: **Upgrading note**
+.. note::
+ **Upgrading note**
- It's recommended to uninstall previous CouchDB version before upgrading,
- especially if the new one is built against different Erlang release.
- The reason is simple: there may be leftover libraries with alternative or
- incompatible versions from old Erlang release that may create conflicts,
- errors and weird crashes.
+ It's recommended to uninstall previous CouchDB version before upgrading,
+ especially if the new one is built against different Erlang release.
+ The reason is simple: there may be leftover libraries with alternative or
+ incompatible versions from old Erlang release that may create conflicts,
+ errors and weird crashes.
- In this case, make sure you backup of your `local.ini` config and CouchDB
- database/index files.
+ In this case, make sure you backup of your `local.ini` config and CouchDB
+ database/index files.
.. _Open up Futon: http://localhost:5984/_utils
.. _CouchDB web site: http://couchdb.org/
.. _archive: http://archive.apache.org/dist/couchdb/binary/win/
.. _the latest Windows binaries: http://couchdb.org/#download
-
Installation from sources
=========================
@@ -163,21 +162,21 @@ exactly the same version as required by the Erlang/OTP build process.
However, you can skip the GUI tools by running::
- echo "skipping gs" > lib/gs/SKIP
+ echo "skipping gs" > lib/gs/SKIP
- echo "skipping ic" > lib/ic/SKIP
+ echo "skipping ic" > lib/ic/SKIP
- echo "skipping jinterface" > lib/jinterface/SKIP
+ echo "skipping jinterface" > lib/jinterface/SKIP
Follow the rest of the Erlang instructions as described.
After running::
- ./otp_build release -a
+ ./otp_build release -a
You should run::
- ./release/win32/Install.exe -s
+ ./release/win32/Install.exe -s
This will set up the release/win32/bin directory correctly. The CouchDB
installation scripts currently write their data directly into this
@@ -269,7 +268,6 @@ To check that everything has worked, point your web browser to::
From here you should run the verification tests in Firefox.
-
.. seealso::
-
- `Glazier: Automate building of CouchDB from source on Windows <https://github.com/dch/glazier>`_
+ `Glazier: Automate building of CouchDB from source on Windows
+ <https://github.com/dch/glazier>`_