honeymoose/OpenSearch
1
0
Fork 0
mirror of https://github.com/honeymoose/OpenSearch.git synced 2025-02-06 04:58:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clarify network interface setting (#66013)

Browse Source 
Today we document the use of `_[networkInterface]_` to specify the
addresses of a network interface but do not spell out which parts of
this syntax should be taken literally and which are part of the
placeholder for the interface name.

This commit clarifies the docs.

NB this is a backport of just the docs changes from #66013.

Closes #65978.
This commit is contained in:
David Turner 2020-12-09 08:41:34 +00:00
parent 8cbb9612d0
commit 9dbfd66731
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/reference/modules/network.asciidoc
View File

@ -65,9 +65,6 @@ Defaults to `9300-9400`.
The following special values may be passed to `network.host`:
`_[networkInterface]_`::
Addresses of a network interface, for example `_en0_`.
`_local_`::
Any loopback addresses on the system, for example `127.0.0.1`.
@ -77,6 +74,11 @@ The following special values may be passed to `network.host`:
`_global_`::
Any globally-scoped addresses on the system, for example `8.8.8.8`.
`_[networkInterface]_`::
Use the addresses of the network interface called `[networkInterface]`. For
example if you wish to use the addresses of an interface called `en0` then
set `network.host: _en0_`.
[[network-interface-values-ipv4-vs-ipv6]]
===== IPv4 vs IPv6