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 2013/08/09 10:57:21 UTC
[9/9] git commit: updated refs/heads/1781-reorganize-and-improve-docs
to f2a0c93
Add MacOS installation guide.
Project: http://git-wip-us.apache.org/repos/asf/couchdb/repo
Commit: http://git-wip-us.apache.org/repos/asf/couchdb/commit/f2a0c936
Tree: http://git-wip-us.apache.org/repos/asf/couchdb/tree/f2a0c936
Diff: http://git-wip-us.apache.org/repos/asf/couchdb/diff/f2a0c936
Branch: refs/heads/1781-reorganize-and-improve-docs
Commit: f2a0c93693ced8b0e96920aa46718489879cae68
Parents: 925913e
Author: Alexander Shorin <kx...@apache.org>
Authored: Fri Aug 9 12:55:07 2013 +0400
Committer: Alexander Shorin <kx...@apache.org>
Committed: Fri Aug 9 12:55:07 2013 +0400
----------------------------------------------------------------------
share/doc/build/Makefile.am | 3 +
share/doc/src/install/index.rst | 3 +-
share/doc/src/install/mac.rst | 188 +++++++++++++++++++++++++++++++++++
share/doc/src/install/unix.rst | 67 +------------
4 files changed, 196 insertions(+), 65 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/couchdb/blob/f2a0c936/share/doc/build/Makefile.am
----------------------------------------------------------------------
diff --git a/share/doc/build/Makefile.am b/share/doc/build/Makefile.am
index ccbd9bd..ad10df9 100644
--- a/share/doc/build/Makefile.am
+++ b/share/doc/build/Makefile.am
@@ -100,6 +100,7 @@ html_files = \
html/_sources/install/index.txt \
html/_sources/install/freebsd.txt \
html/_sources/install/gentoo.txt \
+ html/_sources/install/mac.txt \
html/_sources/install/unix.txt \
html/_sources/install/windows.txt \
html/_sources/query-server/index.txt \
@@ -200,6 +201,7 @@ html_files = \
html/install/index.html \
html/install/freebsd.html \
html/install/gentoo.html \
+ html/install/mac.html \
html/install/unix.html \
html/install/windows.html \
html/query-server/index.html \
@@ -298,6 +300,7 @@ src_files = \
../src/install/index.rst \
../src/install/freebsd.rst \
../src/install/gentoo.rst \
+ ../src/install/mac.rst \
../src/install/unix.rst \
../src/install/windows.rst \
../src/query-server/index.rst \
http://git-wip-us.apache.org/repos/asf/couchdb/blob/f2a0c936/share/doc/src/install/index.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/install/index.rst b/share/doc/src/install/index.rst
index 45ca9de..7ab87fd 100644
--- a/share/doc/src/install/index.rst
+++ b/share/doc/src/install/index.rst
@@ -22,7 +22,6 @@ Installation
unix
windows
+ mac
freebsd
gentoo
-
-
http://git-wip-us.apache.org/repos/asf/couchdb/blob/f2a0c936/share/doc/src/install/mac.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/install/mac.rst b/share/doc/src/install/mac.rst
new file mode 100644
index 0000000..5cfeab0
--- /dev/null
+++ b/share/doc/src/install/mac.rst
@@ -0,0 +1,188 @@
+.. Licensed under the Apache License, Version 2.0 (the "License"); you may not
+.. use this file except in compliance with the License. You may obtain a copy of
+.. the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+.. WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+.. License for the specific language governing permissions and limitations under
+.. the License.
+
+
+.. _install/mac:
+
+=====================
+Installation on MacOS
+=====================
+
+.. _install/mac/binary:
+
+Install from binaries
+=====================
+
+#. Get `the latest MacOS binaries`_ from `CouchDB web site`_.
+ Old releases are available at `archive`_.
+#. Unzip it and place CouchDB Server into the Applications directory
+#. Run CouchDB
+#. `Open up Futon`_
+#. It's time to Relax!
+
+.. _Open up Futon: http://localhost:5984/_utils
+.. _CouchDB web site: http://couchdb.org/
+.. _archive: http://archive.apache.org/dist/couchdb/binary/mac/
+.. _the latest MacOS binaries: http://couchdb.org/#download
+
+
+.. _install/mac/homebrew:
+
+Installation with HomeBrew
+==========================
+
+You can install the build tools by running::
+
+ open /Applications/Installers/Xcode\ Tools/XcodeTools.mpkg
+
+You will need `Homebrew`_ installed to use the `brew` command. To install the
+other :ref:`dependencies <install/unix/dependencies>` run next commands::
+
+ brew install autoconf
+ brew install autoconf-archive
+ brew install automake
+ brew install libtool
+ brew install erlang
+ brew install icu4c
+ brew install spidermonkey
+ brew install curl
+
+You may want to link ICU so that CouchDB can find the header files
+automatically::
+
+ brew link icu4c
+
+The same is true for recent versions of Erlang::
+
+ brew link erlang
+
+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
+
+to trim down compilation time.
+
+If you're hacking on CouchDB, and we hope you will, you may try the current
+git-based master (head) branch, or the next development release using this
+``couchdb`` recipe, using either ``--head`` or ``--devel`` options respectively.
+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.
+
+::
+
+ 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``.
+
+If you wish to have CouchDB run as a daemon then, set up the account,
+using the "User & Groups" preference pane:
+
+- Create a standard user `couchdb` with home directory as
+ `/usr/local/var/lib/couchdb`
+
+- Create a group called `couchdb` and add yourself, the `couchdb` user, and any
+ others you want to be able to edit config or db files directly to it.
+ Use the `advanced` group options to ensure the internal name is also correctly
+ called `couchdb`.
+
+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.
+
+.. _Homebrew: http://mxcl.github.com/homebrew/
+
+
+Running as a Daemon
+-------------------
+
+You can use the `launchctl` command to control the CouchDB daemon.
+
+You can load the configuration by running::
+
+ sudo launchctl load \
+ /usr/local/Library/LaunchDaemons/org.apache.couchdb.plist
+
+You can stop the CouchDB daemon by running::
+
+ sudo launchctl unload \
+ /usr/local/Library/LaunchDaemons/org.apache.couchdb.plist
+
+You can start CouchDB by running::
+
+ sudo launchctl start org.apache.couchdb
+
+You can restart CouchDB by running::
+
+ sudo launchctl stop org.apache.couchdb
+
+You can edit the launchd configuration by running::
+
+ open /usr/local/Library/LaunchDaemons/org.apache.couchdb.plist
+
+To start the daemon on boot, copy the configuration file to::
+
+ /Library/LaunchDaemons
+
+Consult your system documentation for more information.
+
+.. _install/mac/macports:
+
+Installation from MacPorts
+==========================
+
+To install CouchDB using MacPorts you have 2 package choices:
+
+- ``couchdb`` - the latest release version
+- ``couchdb-devel`` - updated every few weeks with the latest from the master
+ branch
+
+::
+
+ $ 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
+
+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
+
+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.
+
+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
+
+to update the port tree, and then install just as explained.
+
http://git-wip-us.apache.org/repos/asf/couchdb/blob/f2a0c936/share/doc/src/install/unix.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/install/unix.rst b/share/doc/src/install/unix.rst
index 3cd5902..da4e5bd 100644
--- a/share/doc/src/install/unix.rst
+++ b/share/doc/src/install/unix.rst
@@ -44,6 +44,9 @@ 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
------------
@@ -119,37 +122,8 @@ distributions, it's recommended to use a more recent js-devel-1.8.5.
Mac OS X
~~~~~~~~
-You can install the build tools by running::
-
- open /Applications/Installers/Xcode\ Tools/XcodeTools.mpkg
-
-You can install the other dependencies by running::
-
- brew install autoconf
- brew install autoconf-archive
- brew install automake
- brew install libtool
- brew install erlang
- brew install icu4c
- brew install spidermonkey
- brew install curl
-
-You may want to link ICU so that CouchDB can find the header files automatically::
-
- brew link icu4c
+Follow :ref:`install/mac/homebrew` reference till `brew install couchdb` step.
-The same is true for recent versions of Erlang::
-
- brew link erlang
-
-You will need `Homebrew`_ installed to use the `brew` command.
-
-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.
-
-.. _Homebrew: http://mxcl.github.com/homebrew/
Installing
----------
@@ -293,36 +267,3 @@ 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.
-
-Mac OS X
-~~~~~~~~
-
-You can use the `launchctl` command to control the CouchDB daemon.
-
-You can load the configuration by running::
-
- sudo launchctl load \
- /usr/local/Library/LaunchDaemons/org.apache.couchdb.plist
-
-You can stop the CouchDB daemon by running::
-
- sudo launchctl unload \
- /usr/local/Library/LaunchDaemons/org.apache.couchdb.plist
-
-You can start CouchDB by running::
-
- sudo launchctl start org.apache.couchdb
-
-You can restart CouchDB by running::
-
- sudo launchctl stop org.apache.couchdb
-
-You can edit the launchd configuration by running::
-
- open /usr/local/Library/LaunchDaemons/org.apache.couchdb.plist
-
-To start the daemon on boot, copy the configuration file to::
-
- /Library/LaunchDaemons
-
-Consult your system documentation for more information.