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/07/24 14:25:08 UTC
[31/50] [abbrv] git commit: updated
refs/heads/1781-reorganize-and-improve-docs to fa11c25
Add Gentoo and FreeBSD install guides.
Feel free to contribute more guides for your OS!
Project: http://git-wip-us.apache.org/repos/asf/couchdb/repo
Commit: http://git-wip-us.apache.org/repos/asf/couchdb/commit/18ee5e62
Tree: http://git-wip-us.apache.org/repos/asf/couchdb/tree/18ee5e62
Diff: http://git-wip-us.apache.org/repos/asf/couchdb/diff/18ee5e62
Branch: refs/heads/1781-reorganize-and-improve-docs
Commit: 18ee5e62eb72aadd93bc07d11f20810a6f6fc53d
Parents: 3abdf0e
Author: Alexander Shorin <kx...@apache.org>
Authored: Wed Jul 24 04:56:21 2013 +0400
Committer: Alexander Shorin <kx...@apache.org>
Committed: Wed Jul 24 10:56:32 2013 +0400
----------------------------------------------------------------------
share/doc/build/Makefile.am | 6 +++
share/doc/src/install/freebsd.rst | 80 ++++++++++++++++++++++++++++++++++
share/doc/src/install/gentoo.rst | 29 ++++++++++++
share/doc/src/install/index.rst | 2 +
4 files changed, 117 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/couchdb/blob/18ee5e62/share/doc/build/Makefile.am
----------------------------------------------------------------------
diff --git a/share/doc/build/Makefile.am b/share/doc/build/Makefile.am
index 589fe95..4d198e7 100644
--- a/share/doc/build/Makefile.am
+++ b/share/doc/build/Makefile.am
@@ -84,6 +84,8 @@ html_files = \
html/_sources/config/intro.txt \
html/_sources/config/proxying.txt \
html/_sources/install/index.html \
+ html/_sources/install/freebsd.html \
+ html/_sources/install/gentoo.html \
html/_sources/install/unix.html \
html/_sources/install/windows.html \
html/_sources/query-server/index.txt \
@@ -162,6 +164,8 @@ html_files = \
html/config/intro.html \
html/config/proxying.html \
html/install/index.html \
+ html/install/freebsd.html \
+ html/install/gentoo.html \
html/install/unix.html \
html/install/windows.html \
html/query-server/index.html \
@@ -238,6 +242,8 @@ src_files = \
../src/config/intro.rst \
../src/config/proxying.rst \
../src/install/index.rst \
+ ../src/install/freebsd.rst \
+ ../src/install/gentoo.rst \
../src/install/unix.rst \
../src/install/windows.rst \
../src/query-server/index.rst \
http://git-wip-us.apache.org/repos/asf/couchdb/blob/18ee5e62/share/doc/src/install/freebsd.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/install/freebsd.rst b/share/doc/src/install/freebsd.rst
new file mode 100644
index 0000000..b82edd1
--- /dev/null
+++ b/share/doc/src/install/freebsd.rst
@@ -0,0 +1,80 @@
+.. 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/freebsd:
+
+=======================
+Installation on FreeBSD
+=======================
+
+Installation from ports
+=======================
+
+.. code-block:: text
+
+ cd /usr/ports/databases/couchdb
+ make install clean
+
+This will install CouchDB from the ports collection.
+
+Start script
+------------
+
+The following options for ``/etc/rc.conf`` or ``/etc/rc.conf.local`` are
+supported by the start script (defaults shown)::
+
+ couchdb_enable="NO"
+ couchdb_enablelogs="YES"
+ couchdb_user="couchdb"
+
+After enabling couchdb rc service use the following to start CouchDB::
+
+ /usr/local/etc/rc.d/couchdb start
+
+This script responds to the arguments `start`, `stop`, `status`, `rcvar` etc..
+
+The start script will also use settings from the following config files:
+
+- /usr/local/etc/couchdb/default.ini
+- /usr/local/etc/couchdb/local.ini
+
+Administrators should use ``default.ini`` as reference and only modify the
+``local.ini`` file.
+
+Post install
+------------
+In case the install script fails to install a noninteractive user "couchdb" to
+be used for the database, the user needs to be created manually:
+
+I used the ``pw`` command to add a user "couchdb" in group "couchdb":
+
+.. code-block:: text
+
+ pw user add couchdb
+ pw user mod couchdb -c 'CouchDB, time to relax' -s /usr/sbin/nologin -d /var/lib/couchdb
+ pw group add couchdb
+
+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
+
+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
+shell, but instead uses ``/usr/sbin/nologin``. The '*' in the second field means
+that this user can not login via password authorization. For details use
+`man 5 passwd`_.
+
+.. _man 5 passwd: http://linux.die.net/man/5/passwd
http://git-wip-us.apache.org/repos/asf/couchdb/blob/18ee5e62/share/doc/src/install/gentoo.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/install/gentoo.rst b/share/doc/src/install/gentoo.rst
new file mode 100644
index 0000000..13d1f33
--- /dev/null
+++ b/share/doc/src/install/gentoo.rst
@@ -0,0 +1,29 @@
+.. 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/gentoo:
+
+Installation on Gentoo
+======================
+
+The simplest way is to use an the `ebuild`_ and install via `portage`_
+(``emerge``). This takes care of dependencies, creating the `couchdb` user,
+basically everything you need to get up and running.
+
+.. code-block:: text
+
+ emerge --ask --verbose couchdb
+
+
+.. _ebuild: http://devmanual.gentoo.org/quickstart/index.html
+.. _portage: http://www.gentoo.org/doc/en/handbook/handbook-x86.xml?part=2&chap=1
http://git-wip-us.apache.org/repos/asf/couchdb/blob/18ee5e62/share/doc/src/install/index.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/install/index.rst b/share/doc/src/install/index.rst
index 6d8082c..45ca9de 100644
--- a/share/doc/src/install/index.rst
+++ b/share/doc/src/install/index.rst
@@ -22,5 +22,7 @@ Installation
unix
windows
+ freebsd
+ gentoo