summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoan Touzet <wohali@users.noreply.github.com>2019-01-15 13:36:38 -0500
committerGitHub <noreply@github.com>2019-01-15 13:36:38 -0500
commit38c1ab47446031addc4ace180aa3669a4d0b010a (patch)
tree4fad5cf42bc51823de2919ec0eb8b8258f6ee08d
parentc6b095b2ad716b917d260c8a0a56f3d4676ced7f (diff)
downloadcouchdb-38c1ab47446031addc4ace180aa3669a4d0b010a.tar.gz
Improve vm.args template comments (#1861)
-rw-r--r--rel/overlay/etc/vm.args15
1 files changed, 12 insertions, 3 deletions
diff --git a/rel/overlay/etc/vm.args b/rel/overlay/etc/vm.args
index e9f0737d0..86b51f89e 100644
--- a/rel/overlay/etc/vm.args
+++ b/rel/overlay/etc/vm.args
@@ -11,18 +11,27 @@
# the License.
# 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:
+# the Erlang -name flag, which takes the form:
+#
+# -name nodename@<FQDN>
+#
+# or
+#
+# -name nodename@<IP-ADDRESS>
+#
+# 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.
+# other than the above 3 approaches correctly. They will not work reliably.
#
# Multiple CouchDBs running on the same machine can use couchdb1@, couchdb2@,
# etc.