Skip to content
Permalink
Browse files
Add missing Quick-Reference descriptions
  • Loading branch information
big-r81 committed May 17, 2022
1 parent 862f8a3 commit feacf8a509eeea785e4ba39a1067d7282b75de64
Showing 4 changed files with 43 additions and 36 deletions.
@@ -22,9 +22,9 @@ Configuring Clustering
Cluster Options
===============

.. config:section:: cluster :: cluster Options
.. config:section:: cluster :: Cluster Options
.. config:option:: q
.. config:option:: q :: Default number of shards for newly created database
Sets the default number of shards for newly created databases. The
default value, ``2``, splits a database into 2 separate partitions. ::
@@ -42,7 +42,7 @@ Cluster Options
.. seealso::
:http:put:`PUT /{db} </{db}>`

.. config:option:: n
.. config:option:: n :: Number of replicas of each document
Sets the number of replicas of each document in a cluster. CouchDB will
only place one replica per node in a cluster. When set up through the
@@ -54,7 +54,7 @@ Cluster Options
[cluster]
n = 3

.. config:option:: placement
.. config:option:: placement :: Sets the cluster-wide replica placement policy
.. warning::

@@ -75,7 +75,8 @@ Cluster Options
.. seealso::
:ref:`cluster/databases/placement`

.. config:option:: seedlist
.. config:option:: seedlist:: Optional, comma-delimited list of nodes that should \
be contacted to join cluster

An optional, comma-delimited list of node names that this node should
contact in order to join a cluster. If a seedlist is configured the ``_up``
@@ -96,20 +97,22 @@ RPC Performance Tuning
communication channel. There are a few configuration knobs for this system,
although in general the defaults work well.

.. config:option:: buffer_count
.. config:option:: buffer_count :: Number of buffered messages before dropping
The local RPC server will buffer messages if a remote node goes unavailable.
This flag determines how many messages will be buffered before the local
server starts dropping messages. Default value is ``2000``.

.. config:option:: server_per_node
.. config:option:: server_per_node :: Enable or disable one local `gen_server` \
process per node

By default, rexi will spawn one local gen_server process for each node in
the cluster. Disabling this flag will cause CouchDB to use a single process
for all RPC communication, which is not recommended in high throughput
deployments.

.. config:option:: stream_limit
.. config:option:: stream_limit :: Number of send messages without waiting \
for acknowledgement from the coordinator

.. versionadded:: 3.0

@@ -24,7 +24,7 @@ Database Per User Options

.. config:section:: couch_peruser :: Database Per User Options
.. config:option:: enable
.. config:option:: enable :: Enable private per-user database pattern
If set to ``true``, couch_peruser ensures that a private per-user
database exists for each document in ``_users``. These databases are
@@ -37,7 +37,7 @@ Database Per User Options
.. note::
The ``_users`` database must exist before couch_peruser can be enabled.

.. config:option:: delete_dbs
.. config:option:: delete_dbs :: Enable deleting user-db after user delete
If set to ``true`` and a user is deleted, the respective database gets
deleted as well. ::
@@ -49,7 +49,7 @@ Database Per User Options
``_couchdb.roles=['_admin']`` claim to for the peruser database to be properly
created and accessible for the user provided in the ``sub=`` claim.

.. config:option:: q
.. config:option:: q :: Sharding value for per-user databases
If set, specify the sharding value for per-user databases. If unset, the
cluster default value will be used.
@@ -490,7 +490,7 @@ Cross-Origin Resource Sharing
[chttpd]
enable_cors = true

.. config:option:: credentials
.. config:option:: credentials :: Enable credentials support in CouchDB
By default, neither authentication headers nor cookies are included in
requests and responses. To do so requires both setting
@@ -503,7 +503,7 @@ Cross-Origin Resource Sharing
CouchDB will respond to a credentials-enabled CORS request with an
additional header, ``Access-Control-Allow-Credentials=true``.

.. config:option:: origins
.. config:option:: origins :: List of allowed origins
List of origins separated by a comma, ``*`` means accept all. You can’t
set ``origins = *`` and ``credentials = true`` option at the same
@@ -521,21 +521,21 @@ Cross-Origin Resource Sharing
Note that by default, no origins are accepted. You must define them
explicitly.

.. config:option:: headers
.. config:option:: headers :: List of accepted headers
List of accepted headers separated by a comma::

[cors]
headers = X-Couch-Id, X-Couch-Rev

.. config:option:: methods
.. config:option:: methods :: List of accepted methods
List of accepted methods::

[cors]
methods = GET,POST

.. config:option:: max_age
.. config:option:: max_age :: Set Access-Control-Max-Age header
Sets the ``Access-Control-Max-Age`` header in seconds. Use it to
avoid repeated ``OPTIONS`` requests.
@@ -24,7 +24,7 @@ Configuration of Attachment Storage

.. config:section:: attachments :: Configuration of Attachment Storage
.. config:option:: compression_level
.. config:option:: compression_level :: Set zlib compression level
Defines zlib compression level for the attachments from ``1`` (lowest,
fastest) to ``9`` (highest, slowest). A value of ``0`` disables
@@ -33,7 +33,7 @@ Configuration of Attachment Storage
[attachments]
compression_level = 8

.. config:option:: compressible_types
.. config:option:: compressible_types :: List of attachment types for compression
Since compression is ineffective for some types of files, it is
possible to let CouchDB compress only some types of attachments,
@@ -49,7 +49,7 @@ Statistic Calculation

.. config:section:: stats :: Statistic Calculation
.. config:option:: interval
.. config:option:: interval :: Statistics gathering interval
Interval between gathering statistics in seconds::

@@ -218,47 +218,47 @@ Content-Security-Policy

.. config:section:: csp :: Content-Security-Policy
You can configure ``Content-Security-Policy`` header for Fauxton, attachments and
show/list functions separately. See `MDN Content-Security-Policy <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy>`_
for more details on CSP.
You can configure ``Content-Security-Policy`` header for Fauxton, attachments and
show/list functions separately. See `MDN Content-Security-Policy <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy>`_
for more details on CSP.

.. config:option:: utils_enable
.. config:option:: utils_enable :: Enable Content-Security-Policy header (Fauxton)
Enable the sending of the header ``Content-Security-Policy`` for ``/_utils``.
Defaults to ``true``::

[csp]
utils_enable = true

.. config:option:: utils_header_value
.. config:option:: utils_header_value :: Set CSP-Header value (Fauxton)
Specifies the exact header value to send. Defaults to::

[csp]
utils_header_value = default-src 'self'; img-src 'self'; font-src *; script-src 'self' 'unsafe-eval'; style-src 'self' 'unsafe-inline';

.. config:option:: attachments_enable
.. config:option:: attachments_enable :: Enable CSP-Header (attachments)
Enable sending the ``Content-Security-Policy`` header for attachments::

[csp]
attachments_enable = true

.. config:option:: attachments_header_value
.. config:option:: attachments_header_value :: Set CSP-Header value (attachments)
Specifies the exact header value to send. Defaults to::

[csp]
attachments_header_value = sandbox

.. config:option:: showlist_enable
.. config:option:: showlist_enable :: Enable CSP-Header (Show/List-Functions)
Enable sending the ``Content-Security-Policy`` header for show and list functions::

[csp]
showlist_enable = true

.. config:option:: showlist_header_value
.. config:option:: showlist_header_value :: Set CSP-Header value (Show/List-Functions)
Specifies the exact header value to send. Defaults to::

@@ -270,14 +270,14 @@ Content-Security-Policy

Experimental support of CSP headers for ``/_utils`` (Fauxton).

.. config:option:: enable
.. config:option:: enable :: Enable CSP-Header (deprecated)
Enable the sending of the Header ``Content-Security-Policy``::

[csp]
enable = true

.. config:option:: header_value
.. config:option:: header_value :: Set CSP-Header value (deprecated)
You can change the default value for the Header which is sent::

@@ -291,7 +291,8 @@ Configuration of Database Purge

.. config:section:: purge :: Configuration of Database Purge
.. config:option:: max_document_id_number
.. config:option:: max_document_id_number :: Allowed number of documents \
per Delete-Request

.. versionadded:: 3.0

@@ -300,7 +301,8 @@ Configuration of Database Purge
[purge]
max_document_id_number = 100

.. config:option:: max_revisions_number
.. config:option:: max_revisions_number :: Allowed number of accumulated \
revisions per Purge-Request

.. versionadded:: 3.0

@@ -310,7 +312,8 @@ Configuration of Database Purge
[purge]
max_revisions_number = 1000

.. config:option:: index_lag_warn_seconds
.. config:option:: index_lag_warn_seconds :: Allowed duration for purge \
checkpoint document

.. versionadded:: 3.0

@@ -327,7 +330,8 @@ Configuration of Prometheus Endpoint

.. config:section:: prometheus :: Configuration of Prometheus Options
.. config:option:: additional_port
.. config:option:: additional_port :: Enable a separate, non-authenticated port \
for prometheus data

.. versionadded:: 3.2

@@ -336,7 +340,7 @@ Configuration of Prometheus Endpoint
[prometheus]
additional_port = true

.. config:option:: bind_address
.. config:option:: bind_address :: IP address binding
.. versionadded:: 3.2

@@ -345,7 +349,7 @@ Configuration of Prometheus Endpoint
[prometheus]
bind_address = 127.0.0.1

.. config:option:: port
.. config:option:: port :: Port for querying Prometheus data without authentication
.. versionadded:: 3.2

0 comments on commit feacf8a

Please sign in to comment.