couchdb-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From kxe...@apache.org
Subject [13/32] git commit: updated refs/heads/1781-reorganize-and-improve-docs to 11fd32a
Date Fri, 14 Jun 2013 08:25:10 GMT
Describe daemons config section.


Project: http://git-wip-us.apache.org/repos/asf/couchdb/repo
Commit: http://git-wip-us.apache.org/repos/asf/couchdb/commit/50c4d85d
Tree: http://git-wip-us.apache.org/repos/asf/couchdb/tree/50c4d85d
Diff: http://git-wip-us.apache.org/repos/asf/couchdb/diff/50c4d85d

Branch: refs/heads/1781-reorganize-and-improve-docs
Commit: 50c4d85d9dfcbf2f79ebcc7e39b9f8c287f3980f
Parents: a0ea376
Author: Alexander Shorin <kxepal@apache.org>
Authored: Tue Jun 11 20:51:49 2013 +0400
Committer: Alexander Shorin <kxepal@apache.org>
Committed: Tue Jun 11 21:30:11 2013 +0400

----------------------------------------------------------------------
 share/doc/build/Makefile.am      |   3 +
 share/doc/src/config/daemons.rst | 174 ++++++++++++++++++++++++++++++++++
 share/doc/src/config/index.rst   |   1 +
 share/doc/src/config/ssl.rst     |   2 +-
 4 files changed, 179 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/couchdb/blob/50c4d85d/share/doc/build/Makefile.am
----------------------------------------------------------------------
diff --git a/share/doc/build/Makefile.am b/share/doc/build/Makefile.am
index 2a78dee..6cb63eb 100644
--- a/share/doc/build/Makefile.am
+++ b/share/doc/build/Makefile.am
@@ -58,6 +58,7 @@ html_files = \
     html/_sources/config/cors.txt \
     html/_sources/config/couch-httpd-auth.txt \
     html/_sources/config/couchdb.txt \
+    html/_sources/config/daemons.txt \
     html/_sources/config/httpd.txt \
     html/_sources/config/index.txt \
     html/_sources/config/os-daemons.txt \
@@ -115,6 +116,7 @@ html_files = \
     html/config/cors.html \
     html/config/couch-httpd-auth.html \
     html/config/couchdb.html \
+    html/config/daemons.html \
     html/config/httpd.html \
     html/config/index.html \
     html/config/os-daemons.html \
@@ -170,6 +172,7 @@ src_files = \
     ../src/config/cors.rst \
     ../src/config/couch-httpd-auth.rst \
     ../src/config/couchdb.rst \
+    ../src/config/daemons.rst \
     ../src/config/httpd.rst \
     ../src/config/index.rst \
     ../src/config/os-daemons.rst \

http://git-wip-us.apache.org/repos/asf/couchdb/blob/50c4d85d/share/doc/src/config/daemons.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/config/daemons.rst b/share/doc/src/config/daemons.rst
new file mode 100644
index 0000000..2cfe4f7
--- /dev/null
+++ b/share/doc/src/config/daemons.rst
@@ -0,0 +1,174 @@
+.. 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.
+
+.. highlight:: ini
+
+.. todo:: Add more detailed apps description and guide how to add custom ones.
+
+.. _config/daemons:
+
+``[daemons]`` :: CouchDB Daemonized Mini Apps
+=============================================
+
+These options are under ``[daemons]`` section.
+
+
+.. _config/daemons/auth_cache:
+
+``auth_cache``
+--------------
+
+This daemon provides authentication caching to avoid repeated opening and
+closing of the `_users` database for each request requiring authentication::
+
+  [daemons]
+  auth_cache={couch_auth_cache, start_link, []}
+
+
+.. _config/daemons/compaction_daemon:
+
+``compaction_daemon``
+---------------------
+
+Automatic compaction daemon::
+
+  [daemons]
+  compaction_daemon={couch_compaction_daemon, start_link, []}
+
+
+.. _config/daemons/external_manager:
+
+``external_manager``
+--------------------
+
+`External` processes manager::
+
+  [daemons]
+  external_manager={couch_external_manager, start_link, []}
+
+
+
+.. _config/daemons/httpd:
+
+``httpd``
+---------
+
+HTTP server daemon::
+
+  [daemons]
+  httpd={couch_httpd, start_link, []}
+
+
+.. _config/daemons/httpsd:
+
+``httpsd``
+----------
+
+Provides :ref:`SSL support <config/ssl>`. The default ssl port CouchDB listens
+on is 6984::
+
+  [daemons]
+  httpsd = {couch_httpd, start_link, [https]}
+
+
+
+.. _config/daemons/index_server:
+
+``index_server``
+----------------
+
+The `couch_index` application is responsible for managing all of the
+different types of indexers. This manages the process handling for
+keeping track of the index state as well as managing the updater and
+compactor handling::
+
+  [daemons]
+  index_server={couch_index_server, start_link, []}
+
+
+.. _config/daemons/os_daemons:
+
+``os_daemons``
+--------------
+
+:ref:`OS Daemons <config/os_daemons>` manager::
+
+  [daemons]
+  os_daemons={couch_os_daemons, start_link, []}
+
+
+.. _config/daemons/query_servers:
+
+``query_servers``
+-----------------
+
+`Query servers` manager::
+
+  [daemons]
+  query_servers={couch_query_servers, start_link, []}
+
+
+.. _config/daemons/replicator_manager:
+
+``replicator_manager``
+----------------------
+
+Replications manager::
+
+  [daemons]
+  replicator_manager={couch_replicator_manager, start_link, []}
+
+
+.. _config/daemons/aggregator:
+
+``stats_aggregator``
+--------------------
+
+Runtime statistics aggregator::
+
+  [daemons]
+  stats_aggregator={couch_stats_aggregator, start, []}
+
+
+.. _config/daemons/stats_collector:
+
+``stats_collector``
+-------------------
+
+Runtime statistics collector::
+
+  [daemons]
+  stats_collector={couch_stats_collector, start, []}
+
+
+.. _config/daemons/uuids:
+
+``uuids``
+---------
+
+:ref:`UUIDs <config/uuids>` generator daemon::
+
+  [daemons]
+  uuids={couch_uuids, start, []}
+
+
+.. _config/daemons/vhosts:
+
+``vhosts``
+----------
+
+:ref:`Virtual hosts <config/vhosts>` manager. Provides dynamic add of vhosts
+without restart, wildcards support and dynamic routing via pattern matching::
+
+  [daemons]
+  vhosts={couch_httpd_vhost, start_link, []}
+

http://git-wip-us.apache.org/repos/asf/couchdb/blob/50c4d85d/share/doc/src/config/index.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/config/index.rst b/share/doc/src/config/index.rst
index 56353e2..faf49a3 100644
--- a/share/doc/src/config/index.rst
+++ b/share/doc/src/config/index.rst
@@ -52,6 +52,7 @@ Content:
    cors
    couch-httpd-auth
    couchdb
+   daemons
    httpd
    os-daemons
    ssl

http://git-wip-us.apache.org/repos/asf/couchdb/blob/50c4d85d/share/doc/src/config/ssl.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/config/ssl.rst b/share/doc/src/config/ssl.rst
index a31f7f7..37ff60b 100644
--- a/share/doc/src/config/ssl.rst
+++ b/share/doc/src/config/ssl.rst
@@ -47,7 +47,7 @@ Now, you need to edit CouchDB's configuration, either by editing your
 configuration screen in Futon. Here is what you need to do in
 ``local.ini``, you can infer what needs doing in the other places.
 
-At first, enable HTTPS daemon::
+At first, :ref:`enable HTTPS daemon <config/daemons/httpsd>`::
 
   [daemons]
   httpsd = {couch_httpd, start_link, [https]}


Mime
View raw message