couchdb-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From kxe...@apache.org
Subject [13/26] documentation commit: updated refs/heads/master to 5a81ace
Date Fri, 20 Feb 2015 00:26:46 GMT
http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/71a4fc90/src/config/replicator.rst
----------------------------------------------------------------------
diff --git a/src/config/replicator.rst b/src/config/replicator.rst
index 388491c..4644a0f 100644
--- a/src/config/replicator.rst
+++ b/src/config/replicator.rst
@@ -23,178 +23,155 @@ Replicator Database Configuration
 
 .. config:section:: replicator :: Replicator Database Configuration
 
-  .. versionadded:: 1.2
+    .. versionadded:: 1.2
 
+    .. config:option:: db
 
-  .. config:option:: db
+        Specifies replicator database name::
 
-    Specifies replicator database name::
+            [replicator]
+            db = _replicator
 
-      [replicator]
-      db = _replicator
+    .. config:option:: max_replication_retry_count
 
+        Maximum replication retry count can be a non-negative integer or
+        "infinity"::
 
+            [replicator]
+            max_replication_retry_count = 10
 
-  .. config:option:: max_replication_retry_count
+    .. config:option:: worker_batch_size
 
-    Maximum replication retry count can be a non-negative integer or "infinity"
-    ::
+        With lower batch sizes checkpoints are done more frequently. Lower
+        batch sizes also reduce the total amount of used RAM memory::
 
-      [replicator]
-      max_replication_retry_count = 10
+            [replicator]
+            worker_batch_size = 500
 
+    .. config:option:: worker_processes
 
+        More worker processes can give higher network throughput but can also
+        imply more disk and network IO::
 
-  .. config:option:: worker_batch_size
+            [replicator]
+            worker_processes = 4
 
-    With lower batch sizes checkpoints are done more frequently. Lower batch
-    sizes also reduce the total amount of used RAM memory::
+    .. config:option:: http_connections
 
-      [replicator]
-      worker_batch_size = 500
+        Maximum number of HTTP connections per replication::
 
+            [replicator]
+            http_connections = 20
 
+    .. config:option:: connection_timeout
 
-  .. config:option:: worker_processes
+        HTTP connection timeout per replication.
+        Even for very fast/reliable networks it might need to be increased if
+        a remote database is too busy::
 
-    More worker processes can give higher network throughput but can also imply
-    more disk and network IO::
+            [replicator]
+            connection_timeout = 30000
 
-      [replicator]
-      worker_processes = 4
+    .. config:option:: retries_per_request
 
+        If a request fails, the replicator will retry it up to N times::
 
+            [replicator]
+            retries_per_request = 10
 
-  .. config:option:: http_connections
+    .. config:option:: socket_options
 
-    Maximum number of HTTP connections per replication::
+        Some socket options that might boost performance in some scenarios:
 
-      [replicator]
-      http_connections = 20
+        - ``{nodelay, boolean()}``
+        - ``{sndbuf, integer()}``
+        - ``{recbuf, integer()}``
+        - ``{priority, integer()}``
 
+        See the `inet`_ Erlang module's man page for the full list of options::
 
+            [replicator]
+            socket_options = [{keepalive, true}, {nodelay, false}]
 
-  .. config:option:: connection_timeout
+        .. _inet: http://www.erlang.org/doc/man/inet.html#setopts-2
 
-    HTTP connection timeout per replication.
-    Even for very fast/reliable networks it might need to be increased if
-    a remote database is too busy::
+    .. config:option:: checkpoint_interval
 
-      [replicator]
-      connection_timeout = 30000
+        .. versionadded:: 1.6
 
+        Defines replication checkpoint interval in milliseconds.
+        :ref:`Replicator <replicator>` will :get:`requests </{db}>` from the
+        Source database at the specified interval::
 
+            [replicator]
+            checkpoint_interval = 5000
 
-  .. config:option:: retries_per_request
+        Lower intervals may be useful for frequently changing data, while
+        higher values will lower bandwidth and make fewer requests for
+        infrequently updated databases.
 
-    If a request fails, the replicator will retry it up to N times::
+    .. config:option:: use_checkpoints
 
-      [replicator]
-      retries_per_request = 10
+        .. versionadded:: 1.6
 
+        If ``use_checkpoints`` is set to ``true``, CouchDB will make
+        checkpoints during replication and at the completion of replication.
+        CouchDB can efficiently resume replication from any of these
+        checkpoints::
 
+            [replicator]
+            use_checkpoints = true
 
-  .. config:option:: socket_options
+        .. note::
+            Checkpoints are stored in :ref:`local documents <api/local>`
+            on both the source and target databases (which requires write
+            access).
 
-    Some socket options that might boost performance in some scenarios:
+        .. warning::
+            Disabling checkpoints is **not recommended** as CouchDB will scan
+            the Source database's changes feed from the beginning.
 
-    - ``{nodelay, boolean()}``
-    - ``{sndbuf, integer()}``
-    - ``{recbuf, integer()}``
-    - ``{priority, integer()}``
+    .. config:option:: cert_file
 
-    See the `inet`_ Erlang module's man page for the full list of options::
+        Path to a file containing the user's certificate::
 
-      [replicator]
-      socket_options = [{keepalive, true}, {nodelay, false}]
+            [replicator]
+            cert_file = /full/path/to/server_cert.pem
 
-    .. _inet: http://www.erlang.org/doc/man/inet.html#setopts-2
+    .. config:option:: key_file
 
+        Path to file containing user's private PEM encoded key::
 
-  .. config:option:: checkpoint_interval
+            [replicator]
+            key_file = /full/path/to/server_key.pem
 
-    .. versionadded:: 1.6
+    .. config:option:: password
 
-    Defines replication checkpoint interval in milliseconds. :ref:`Replicator
-    <replicator>` will :get:`requests </{db}>` from the Source database at
-    the specified interval::
+        String containing the user's password. Only used if the private keyfile
+        is  password protected::
 
-      [replicator]
-      checkpoint_interval = 5000
+            [replicator]
+            password = somepassword
 
-    Lower intervals may be useful for frequently changing data, while higher
-    values will lower bandwidth and make fewer requests for infrequently
-    updated databases.
+    .. config:option:: verify_ssl_certificates
 
+        Set to true to validate peer certificates::
 
-  .. config:option:: use_checkpoints
+            [replicator]
+            verify_ssl_certificates = false
 
-     .. versionadded:: 1.6
+    .. config:option:: ssl_trusted_certificates_file
 
-     If ``use_checkpoints`` is set to ``true``, CouchDB will make checkpoints
-     during replication and at the completion of replication. CouchDB can
-     efficiently resume replication from any of these checkpoints::
+        File containing a list of peer trusted certificates (in the PEM
+        format)::
 
-      [replicator]
-      use_checkpoints = true
+            [replicator]
+            ssl_trusted_certificates_file = /etc/ssl/certs/ca-certificates.crt
 
-     .. note:: Checkpoints are stored in :ref:`local documents <api/local>`
-        on both the source and target databases (which requires write access).
+    .. config:option:: ssl_certificate_max_depth
 
-     .. warning:: Disabling checkpoints is **not recommended** as CouchDB
-        will scan the Source database's changes feed from the beginning.
+        Maximum peer certificate depth (must be set even if certificate
+        validation is off)::
 
-
-  .. config:option:: cert_file
-
-    Path to a file containing the user's certificate::
-
-      [replicator]
-      cert_file = /full/path/to/server_cert.pem
-
-
-
-  .. config:option:: key_file
-
-    Path to file containing user's private PEM encoded key::
-
-      [replicator]
-      key_file = /full/path/to/server_key.pem
-
-
-
-  .. config:option:: password
-
-    String containing the user's password. Only used if the private keyfile is
-    password protected::
-
-      [replicator]
-      password = somepassword
-
-
-
-  .. config:option:: verify_ssl_certificates
-
-    Set to true to validate peer certificates::
-
-      [replicator]
-      verify_ssl_certificates = false
-
-
-
-  .. config:option:: ssl_trusted_certificates_file
-
-    File containing a list of peer trusted certificates (in the PEM format)::
-
-      [replicator]
-      ssl_trusted_certificates_file = /etc/ssl/certs/ca-certificates.crt
-
-
-
-  .. config:option:: ssl_certificate_max_depth
-
-    Maximum peer certificate depth (must be set even if certificate validation
-    is off)::
-
-      [replicator]
-      ssl_certificate_max_depth = 3
+            [replicator]
+            ssl_certificate_max_depth = 3

http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/71a4fc90/src/config/services.rst
----------------------------------------------------------------------
diff --git a/src/config/services.rst b/src/config/services.rst
index 9e06e03..24d07af 100644
--- a/src/config/services.rst
+++ b/src/config/services.rst
@@ -16,7 +16,6 @@
 CouchDB Internal Services
 =========================
 
-
 .. _config/daemons:
 
 CouchDB Daemonized Mini Apps
@@ -24,127 +23,101 @@ CouchDB Daemonized Mini Apps
 
 .. config:section:: daemons :: CouchDB Daemonized Mini Apps
 
+    .. config:option:: auth_cache
 
-  .. config:option:: 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:option:: compaction_daemon
-
-    :ref:`Automatic compaction <config/compactions>` daemon::
-
-      [daemons]
-      compaction_daemon={couch_compaction_daemon, start_link, []}
-
-
-
-  .. config:option:: external_manager
-
-    `External` processes manager::
-
-      [daemons]
-      external_manager={couch_external_manager, start_link, []}
-
-
-
-  .. config:option:: httpd
-
-    HTTP server daemon::
-
-      [daemons]
-      httpd={couch_httpd, start_link, []}
-
-
-
-  .. config:option:: httpsd
-
-    Provides :ref:`SSL support <config/ssl>`. The default ssl port CouchDB
-    listens on is `6984`::
-
-      [daemons]
-      httpsd = {couch_httpd, start_link, [https]}
-
-
-
-
-  .. config:option:: 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::
+        This daemon provides authentication caching to avoid repeated opening
+        and closing of the `_users` database for each request requiring
+        authentication::
 
-      [daemons]
-      index_server={couch_index_server, start_link, []}
+            [daemons]
+            auth_cache={couch_auth_cache, start_link, []}
 
+    .. config:option:: compaction_daemon
 
+        :ref:`Automatic compaction <config/compactions>` daemon::
 
-  .. config:option:: os_daemons
+            [daemons]
+            compaction_daemon={couch_compaction_daemon, start_link, []}
 
-    :ref:`OS Daemons <config/os_daemons>` manager::
+    .. config:option:: external_manager
 
-      [daemons]
-      os_daemons={couch_os_daemons, start_link, []}
+        `External` processes manager::
 
+            [daemons]
+            external_manager={couch_external_manager, start_link, []}
 
+    .. config:option:: httpd
 
-  .. config:option:: query_servers
+        HTTP server daemon::
 
-    :ref:`Query servers <config/query_servers>` manager::
+            [daemons]
+            httpd={couch_httpd, start_link, []}
 
-      [daemons]
-      query_servers={couch_query_servers, start_link, []}
+    .. config:option:: httpsd
 
+        Provides :ref:`SSL support <config/ssl>`. The default ssl port CouchDB
+        listens on is `6984`::
 
+            [daemons]
+            httpsd = {couch_httpd, start_link, [https]}
 
-  .. config:option:: replicator_manager
+    .. config:option:: index_server
 
-    Replications manager::
+        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]
-      replicator_manager={couch_replicator_manager, start_link, []}
+            [daemons]
+            index_server={couch_index_server, start_link, []}
 
+    .. config:option:: os_daemons
 
+        :ref:`OS Daemons <config/os_daemons>` manager::
 
-  .. config:option:: stats_aggregator
+            [daemons]
+            os_daemons={couch_os_daemons, start_link, []}
 
-    Runtime statistics aggregator::
+    .. config:option:: query_servers
 
-      [daemons]
-      stats_aggregator={couch_stats_aggregator, start, []}
+        :ref:`Query servers <config/query_servers>` manager::
 
+            [daemons]
+            query_servers={couch_query_servers, start_link, []}
 
+    .. config:option:: replicator_manager
 
-  .. config:option:: stats_collector
+        Replications manager::
 
-    Runtime statistics collector::
+            [daemons]
+            replicator_manager={couch_replicator_manager, start_link, []}
 
-      [daemons]
-      stats_collector={couch_stats_collector, start, []}
+    .. config:option:: stats_aggregator
 
+        Runtime statistics aggregator::
 
+            [daemons]
+            stats_aggregator={couch_stats_aggregator, start, []}
 
-  .. config:option:: uuids
+    .. config:option:: stats_collector
 
-    :ref:`UUIDs <config/uuids>` generator daemon::
+        Runtime statistics collector::
 
-      [daemons]
-      uuids={couch_uuids, start, []}
+            [daemons]
+            stats_collector={couch_stats_collector, start, []}
 
+    .. config:option:: uuids
 
+        :ref:`UUIDs <config/uuids>` generator daemon::
 
-  .. config:option:: vhosts
+            [daemons]
+            uuids={couch_uuids, start, []}
 
-    :ref:`Virtual hosts <config/vhosts>` manager. Provides dynamic add of vhosts
-    without restart, wildcards support and dynamic routing via pattern matching
-    ::
+    .. config:option:: vhosts
 
-      [daemons]
-      vhosts={couch_httpd_vhost, start_link, []}
+        :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, []}


Mime
View raw message