docs: explain that invalid interface roles are removed

This commit is contained in:
lemoer 2022-12-16 00:44:48 +01:00
parent a31a802e85
commit e7da501442

View File

@ -448,13 +448,8 @@ interfaces \: optional
The ``client`` role requires exclusive control over an interface. When The ``client`` role requires exclusive control over an interface. When
the ``client`` role is assigned to an interface at the same time as other the ``client`` role is assigned to an interface at the same time as other
roles (like ``'client', 'mesh'`` in the above example), the other roles take roles (like ``'client', 'mesh'`` in the above example), the other roles take
precedence (enabling ``mesh``, but not ``client`` in the example). precedence (enabling ``mesh``, but not ``client`` in the example). In that
case, the ``client`` role is removed from the config of the interface.
Such a default configuration still fulfills a purpose (and is in fact the
recommended way to enable "Mesh-on-LAN" by default): The "LAN interface
meshing" checkbox in the advanced network settings will only add or remove
the ``mesh`` role, so the ``client`` role must already be in the configuration
to make the LAN port a regular client interface when the checkbox is disabled.
All interface settings are optional. If unset, the following defaults are All interface settings are optional. If unset, the following defaults are
used: used: