[couchdb-documentation] branch master updated: Document improvements to setup API (#480)

[wo...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

wohali pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/couchdb-documentation.git


The following commit(s) were added to refs/heads/master by this push:
     new 56a24cd  Document improvements to setup API (#480)
56a24cd is described below

commit 56a24cd8e9f9e872a365a7704f48c1398a994c96
Author: Joan Touzet <wo...@users.noreply.github.com>
AuthorDate: Fri Jan 17 22:08:52 2020 +0000

    Document improvements to setup API (#480)
---
 src/setup/cluster.rst     |  4 ++++
 src/setup/single-node.rst | 12 ++++++++----
 2 files changed, 12 insertions(+), 4 deletions(-)

diff --git a/src/setup/cluster.rst b/src/setup/cluster.rst
index c460236..2cb0a43 100644
--- a/src/setup/cluster.rst
+++ b/src/setup/cluster.rst
@@ -196,6 +196,9 @@ are:
    is used in calculating and evaluating cookie and proxy authentication, and should
    be set consistently to avoid unnecessary repeated session cookie requests.
 
+As of CouchDB 3.0, steps 4 and 5 above are automatically performed for you when
+using the setup API endpoints described below.
+
 If you use a configuration management tool, such as Chef, Ansible, Puppet, etc.,
 then you can place these settings in a ``.ini`` file and distribute them to all
 nodes ahead of time. Be sure to pre-encrypt the password (cutting and pasting
@@ -225,6 +228,7 @@ locally on each node; if so, replace ``<server-IP|FQDN>`` below with ``127.0.0.1
     # Now, bind the clustered interface to all IP addresses availble on this machine
     curl -X PUT http://<server-IP|FQDN>:5984/_node/_local/_config/chttpd/bind_address -d '"0.0.0.0"'
 
+    # If not using the setup wizard / API endpoint, the following 2 steps are required:
     # Set the UUID of the node to the first UUID you previously obtained:
     curl -X PUT http://<server-IP|FQDN>:5984/_node/_local/_config/couchdb/uuid -d '"FIRST-UUID-GOES-HERE"'
 
diff --git a/src/setup/single-node.rst b/src/setup/single-node.rst
index 5a42ab3..30af61a 100644
--- a/src/setup/single-node.rst
+++ b/src/setup/single-node.rst
@@ -34,10 +34,14 @@ installation private by binding only to 127.0.0.1 (localhost). Binding to
 username and password and creates the three system databases ``_users``,
 ``_replicator`` and ``_global_changes`` for you.
 
-Alternatively, if you don't want to use the Setup Wizard, and run 2.x as a
-single node with a server administrator already configured via
-:ref:`config file<config/admins>`, make sure to
-create the three system databases manually on startup:
+Another option is to set the configuration parameter ``[couchdb] single_node=true``
+in your ``local.ini`` file. When doing this, CouchDB will create the system
+database for you on restart.
+
+Alternatively, if you don't want to use the Setup Wizard or set that value, and
+run 3.x as a single node with a server administrator already configured via
+:ref:`config file<config/admins>`, make sure to create the three system
+databases manually on startup:
 
 .. code-block:: sh