Skip to content

Commit

Permalink
mdns: T5227, T5615, T5719: Update mDNS documentation for additional o…
Browse files Browse the repository at this point in the history
…ptions

Add mdns repeater docs for additional conf-mode and op-mode options.
  • Loading branch information
indrajitr committed Nov 10, 2023
1 parent e478577 commit 8605c84
Showing 1 changed file with 50 additions and 5 deletions.
55 changes: 50 additions & 5 deletions docs/configuration/service/mdns.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Starting with VyOS 1.2 a :abbr:`mDNS (Multicast DNS)` repeater functionality is
provided. Additional information can be obtained from
https://en.wikipedia.org/wiki/Multicast_DNS.

Multicast DNS uses the 224.0.0.251 address, which is "administratively scoped"
Multicast DNS uses the ``224.0.0.251`` address, which is `"administratively scoped"`

Check warning on line 8 in docs/configuration/service/mdns.rst

View workflow job for this annotation

GitHub Actions / lint

Line too long: len=84
and does not leave the subnet. It retransmits mDNS packets from one interface
to other interfaces. This enables support for e.g. Apple Airplay devices across
multiple VLANs.
Expand All @@ -19,19 +19,34 @@ Configuration

.. cfgcmd:: set service mdns repeater interface <interface>

To enable mDNS repeater you need to configure at least two interfaces. To
re-broadcast all incoming mDNS packets from any interface configured here to
any other interface configured under this section.
To enable mDNS repeater you need to configure at least two interfaces so that
all incoming mDNS packets from one interface configured here can be
re-broadcasted to any other interface(s) configured under this section.

.. cfgcmd:: set service mdns repeater disable

mDNS repeater can be temporarily disabled without deleting the service using

.. cfgcmd:: set service mdns repeater ip-version <ipv4 | ipv6 | both>

mDNS repeater can be enabled either on IPv4 socket or on IPv6 socket or both
to re-broadcast. By default, mDNS repeater will listen on both IPv4 and IPv6.

.. cfgcmd:: set service mdns repeater allow-service <service>

mDNS repeater can be configured to re-broadcast only specific services. By
default, all services are re-broadcasted.

.. cfgcmd:: set service mdns repeater browse-domain <domain>

Allow listing additional custom domains to be browsed (in addition to the
default ``local``) so that they can be reflected.

.. note:: You can not run this in a VRRP setup, if multiple mDNS repeaters
are launched in a subnet you will experience the mDNS packet storm death!

Example
=======
-------

To listen on both `eth0` and `eth1` mDNS packets and also repeat packets
received on `eth0` to `eth1` (and vice-versa) use the following commands:
Expand All @@ -41,4 +56,34 @@ received on `eth0` to `eth1` (and vice-versa) use the following commands:
set service mdns repeater interface 'eth0'
set service mdns repeater interface 'eth1'
To allow only specific services, for example ``_airplay._tcp`` and ``_ipp._tcp``,

Check warning on line 59 in docs/configuration/service/mdns.rst

View workflow job for this annotation

GitHub Actions / lint

Line too long: len=81
(instead of all services) to be re-broadcasted, use the following command:

.. code-block:: none
set service mdns repeater allow-service '_airplay._tcp'
set service mdns repeater allow-service '_ipp._tcp'
To allow listing additional custom domain, for example ``openthread.thread.home.arpa``,

Check warning on line 67 in docs/configuration/service/mdns.rst

View workflow job for this annotation

GitHub Actions / lint

Line too long: len=87
so that it can reflected in addition to the default ``local``, use the following command:

Check warning on line 68 in docs/configuration/service/mdns.rst

View workflow job for this annotation

GitHub Actions / lint

Line too long: len=89

.. code-block:: none
set service mdns repeater browse-domain 'openthread.thread.home.arpa'
.. _`Multicast DNS`: https://en.wikipedia.org/wiki/Multicast_DNS

Operation
=========

.. opcmd:: restart mdns repeater

Restart mDNS repeater service.

.. opcmd:: show log mdns repeater

Show logs for mDNS repeater service.

.. opcmd:: monitor log mdns repeater

Follow the logs for mDNS repeater service.

0 comments on commit 8605c84

Please sign in to comment.