Skip to content

Commit

Permalink
Add note regarding quoting values for network.host
Browse files Browse the repository at this point in the history
Values for the network.host setting can often contain a colon which is a
character that is considered special by YAML (these arise in IPv6
addresses and some of the special tags like ":ipv4"). As such, these
values need to be quoted or a YAML parser will be unhappy with
them. This commit adds a note to the docs regarding this.
  • Loading branch information
jasontedor committed Feb 27, 2018
1 parent 266da70 commit 26405a9
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions docs/reference/modules/network.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,12 @@ Never expose an unprotected node to the public internet.

`network.host`::

The node will bind to this hostname or IP address and _publish_ (advertise)
this host to other nodes in the cluster. Accepts an IP address, hostname, a
<<network-interface-values,special value>>, or an array of any combination
of these.
The node will bind to this hostname or IP address and _publish_ (advertise) this
host to other nodes in the cluster. Accepts an IP address, hostname, a
<<network-interface-values,special value>>, or an array of any combination of
these. Note that any values containing a `:` (e.g., an IPv6 address or
containing one of the <<network-interface-values,special value>>) must be quoted
because `:` is a special character in YAML.
+
Defaults to `_local_`.

Expand Down

0 comments on commit 26405a9

Please sign in to comment.