diff options
author | Dirkjan Ochtman <djc@apache.org> | 2013-05-20 08:48:53 +0200 |
---|---|---|
committer | Dirkjan Ochtman <djc@apache.org> | 2013-05-20 08:48:53 +0200 |
commit | 7ba4c738114c025e245bc95ea61ba9779c1f3985 (patch) | |
tree | a17d7d5328a06b4673f0ebf869ffb401f38c107e | |
parent | 79bfcce8dfbd0d2147ef89ace1ba4723a7b8aa1a (diff) | |
download | couchdb-7ba4c738114c025e245bc95ea61ba9779c1f3985.tar.gz |
docs: move section on OS daemons into configuration chapter
-rw-r--r-- | share/doc/src/configuring.rst | 39 | ||||
-rw-r--r-- | share/doc/src/index.rst | 1 | ||||
-rw-r--r-- | share/doc/src/os-daemons.rst | 50 |
3 files changed, 39 insertions, 51 deletions
diff --git a/share/doc/src/configuring.rst b/share/doc/src/configuring.rst index 58240d7ab..168a51f8e 100644 --- a/share/doc/src/configuring.rst +++ b/share/doc/src/configuring.rst @@ -146,3 +146,42 @@ work factor for ``PBKDF2``, and the algorithm itself at .. versionadded:: 1.3.0 ``PBKDF2`` server-side hashed salted password support added, now as a synchronous call for the ``_config/admins`` API. + +OS Daemons +========== + +CouchDB now supports starting external processes. The support is simple +and enables CouchDB to start each configured OS daemon. If the daemon +stops at any point, CouchDB will restart it (with protection to ensure +regularly failing daemons are not repeatedly restarted). + +The daemon starting process is one-to-one; for each each configured +daemon in the configuration file, CouchDB will start exactly one +instance. If you need to run multiple instances, then you must create +separate individual configurations. Daemons are configured within the +``[os_daemons]`` section of your configuration file (``local.ini``). The +format of each configured daemon is: + +.. code-block:: ini + + NAME = PATH ARGS + +Where ``NAME`` is an arbitrary (and unique) name to identify the daemon; +``PATH`` is the full path to the daemon to be executed; ``ARGS`` are any +required arguments to the daemon. + +For example: + +.. code-block:: ini + + [os_daemons] + basic_responder = /usr/local/bin/responder.js + +There is no interactivity between CouchDB and the running process, but +you can use the OS Daemons service to create new HTTP servers and +responders and then use the new proxy service to redirect requests and +output to the CouchDB managed service. For more information on proxying, +see :ref:`http-proxying`. For further background on the OS Daemon service, see +`CouchDB Externals API`_. + +.. _CouchDB Externals API: http://davispj.com/2010/09/26/new-couchdb-externals-api.html diff --git a/share/doc/src/index.rst b/share/doc/src/index.rst index efc4286e2..63cc94f05 100644 --- a/share/doc/src/index.rst +++ b/share/doc/src/index.rst @@ -32,7 +32,6 @@ Contents pretty_urls configuring ssl - os-daemons http-proxying config_reference replication diff --git a/share/doc/src/os-daemons.rst b/share/doc/src/os-daemons.rst deleted file mode 100644 index 5ff850c15..000000000 --- a/share/doc/src/os-daemons.rst +++ /dev/null @@ -1,50 +0,0 @@ -.. 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. - -OS Daemons -========== - -CouchDB now supports starting external processes. The support is simple -and enables CouchDB to start each configured OS daemon. If the daemon -stops at any point, CouchDB will restart it (with protection to ensure -regularly failing daemons are not repeatedly restarted). - -The daemon starting process is one-to-one; for each each configured -daemon in the configuration file, CouchDB will start exactly one -instance. If you need to run multiple instances, then you must create -separate individual configurations. Daemons are configured within the -``[os_daemons]`` section of your configuration file (``local.ini``). The -format of each configured daemon is: - -.. code-block:: ini - - NAME = PATH ARGS - -Where ``NAME`` is an arbitrary (and unique) name to identify the daemon; -``PATH`` is the full path to the daemon to be executed; ``ARGS`` are any -required arguments to the daemon. - -For example: - -.. code-block:: ini - - [os_daemons] - basic_responder = /usr/local/bin/responder.js - -There is no interactivity between CouchDB and the running process, but -you can use the OS Daemons service to create new HTTP servers and -responders and then use the new proxy service to redirect requests and -output to the CouchDB managed service. For more information on proxying, -see :ref:`http-proxying`. For further background on the OS Daemon service, see -`CouchDB Externals API`_. - -.. _CouchDB Externals API: http://davispj.com/2010/09/26/new-couchdb-externals-api.html |