From 4b7d642fcf755878575dd24260254d1cf519ba85 Mon Sep 17 00:00:00 2001 From: Raoul Date: Thu, 2 Sep 2021 05:27:16 +0200 Subject: [PATCH] Update readme --- README.md | 35 +++++++++++++++++++++++++++-------- 1 file changed, 27 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 3675de6..69cbfe4 100644 --- a/README.md +++ b/README.md @@ -7,18 +7,37 @@ Avahi provides local hostname resolution using a "hostname.local" naming scheme. This ansible role installs the required dependencies and configures the DNS resolver accordingly. -You can opt-out from deploying a new ``/etc/nsswitch.conf`` config by setting ``avahi__configure_nsswitch`` to ``false``. +You can opt-out from deploying a new ``/etc/nsswitch.conf`` config by setting ``avahi_client__configure_nsswitch`` to ``false``. You can opt-in in a simple versionscheck that can prevent you from running a older version of this role by setting ``submodules_versioncheck`` to ``true``. + +Configuring nsswitch +-------------------- + If you want only IPv4 or IPv6 names resolved, change ``mdns`` to ``mdns4`` or ``mdns6`` in these variables: + ```yaml -avahi__mdns_name: 'mdns' -avahi__mdns_minimal_name: 'mdns_minimal' +avahi_client__mdns_name: 'mdns' +avahi_client__mdns_minimal_name: 'mdns_minimal' ``` - Learn more ------------- -+ [/etc/nsswitch.conf](https://man7.org/linux/man-pages/man5/nsswitch.conf.5.html) -+ Avahi [wiki.archlinux.org](https://wiki.archlinux.org/title/Avahi) -+ nss-mdns [0pointer.de](https://0pointer.de/lennart/projects/nss-mdns/#documentation) +From the documentation of [nss-mdns](https://github.com/lathiat/nss-mdns) + +> `mdns` resolves both IPv6 and IPv4 addresses, `mdns4` only IPv4 addresses and `mdns6` only IPv6 addresses. +> `mdns{4,6,}_minimal` is mostly identical to the versions without `_minimal`. However, they differ in one way. The minimal versions will always deny to resolve host names that don't end in `.local` or addresses that aren't in the range `169.254.x.x` (the range used by IPV4LL/APIPA/RFC3927.) +> Combining the `_minimal` and the normal NSS modules allows us to make mDNS authoritative for Zeroconf host names and addresses and use it as fallback for everything else. + + +Learn more +---------- + +* DNS-SD [http://dns-sd.org/](http://dns-sd.org/) +* mDNS [http://www.multicastdns.org/](http://www.multicastdns.org/) + +* Avahi [https://www.avahi.org/](https://www.avahi.org/) +* Avahi git [https://github.com/lathiat/avahi](https://github.com/lathiat/avahi) +* Avahi [wiki.archlinux.org](https://wiki.archlinux.org/title/Avahi) + +* [NSS mdns plugin](https://github.com/lathiat/nss-mdns) +* [/etc/nsswitch.conf](https://manpages.debian.org/unstable/manpages/nsswitch.conf.5.en.html)