summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoan Touzet <joant@atypical.net>2017-08-01 18:37:22 -0400
committerJoan Touzet <joant@atypical.net>2017-08-01 18:37:22 -0400
commitf728209102a84d669f81431dea0bd0d60655a12f (patch)
treeeffe45c2344c932e600ac23b6dd01a041b08b92e
parent1053aee707753e072cc2b7b5ca9d64297124d9e2 (diff)
downloadcouchdb-f728209102a84d669f81431dea0bd0d60655a12f.tar.gz
Update advice on the use of -name (and NOT -sname)
Closes #729. See the ticket for additional information.
-rw-r--r--rel/overlay/etc/vm.args20
1 files changed, 16 insertions, 4 deletions
diff --git a/rel/overlay/etc/vm.args b/rel/overlay/etc/vm.args
index b69ad829b..acb4571b8 100644
--- a/rel/overlay/etc/vm.args
+++ b/rel/overlay/etc/vm.args
@@ -10,10 +10,22 @@
# License for the specific language governing permissions and limitations under
# the License.
-# Each node in the system must have a unique name. A name can be short
-# (specified using -sname) or it can by fully qualified (-name). There can be
-# no communication between nodes running with the -sname flag and those running
-# with the -name flag.
+# Each node in the system must have a unique name. These are specified through
+# the Erlang -name flag, which takes the form nodename@hostname. CouchDB
+# recommends the following values for this flag:
+#
+# 1. If this is a single node, not in a cluster, use:
+# -name couchdb@127.0.0.1
+# 2. If DNS is configured for this host, use the FQDN, such as:
+# -name couchdb@my.host.domain.com
+# 3. If DNS isn't configured for this host, use IP addresses only, such as:
+# -name couchdb@192.168.0.1
+#
+# Do not rely on tricks with /etc/hosts or libresolv to handle anything
+# other than the above 3 approaches correctly.
+#
+# Multiple CouchDBs running on the same machine can use couchdb1@, couchdb2@,
+# etc.
{{node_name}}
# All nodes must share the same magic cookie for distributed Erlang to work.