1 <?xml version="1.0"?><!--*-nxml-*-->
2 <!DOCTYPE manpage SYSTEM "xmltoman.dtd">
3 <?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?>
6 This file is part of avahi.
8 avahi is free software; you can redistribute it and/or modify it
9 under the terms of the GNU Lesser General Public License as
10 published by the Free Software Foundation; either version 2.1 of the
11 License, or (at your option) any later version.
13 avahi is distributed in the hope that it will be useful, but WITHOUT
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
15 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
16 Public License for more details.
18 You should have received a copy of the GNU Lesser General Public
19 License along with avahi; if not, write to the Free Software
20 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
24 <manpage name="avahi-daemon.conf" section="5" desc="avahi-daemon configuration file">
27 <cmd>@pkgsysconfdir@/avahi-daemon.conf</cmd>
31 <p><file>avahi-daemon.conf</file> is the configuration file for avahi-daemon.</p>
34 <section name="Section [Server]">
37 <p><opt>host-name=</opt> Set the host name avahi-daemon tries
38 to register on the LAN. If omited defaults to the system host
39 name as set with the sethostname() system call.</p>
43 <p><opt>host-name-from-machine-id=</opt> Takes a boolean
44 value ("yes" or "no"). If set to "yes" avahi-daemon
45 will use the machine-id as name on the LAN.</p>
49 <p><opt>domain-name=</opt> Set the default domain name avahi-daemon
50 tries to register its host name and services on the LAN in. If
51 omitted defaults to ".local".</p>
55 <p><opt>browse-domains=</opt> Set a comma separated list of
56 browsing domains (in addition to the default one and those
57 announced inside the default browsing domain). Please note
58 that the user may specify additional browsing domains on the
59 client side, either by setting $AVAHI_BROWSE_DOMAINS to a list
60 of colon separated domains or by adding them to the XDG config
61 file <file>~/.config/avahi/browse-domains</file> (separated by
67 <p><opt>use-ipv4=</opt> Takes a boolean value ("yes" or
68 "no"). If set to "no" avahi-daemon will not use IPv4
69 sockets. Default is "yes".</p>
73 <p><opt>use-ipv6=</opt> Takes a boolean value ("yes" or
74 "no"). If set to "no" avahi-daemon will not use IPv6
75 sockets. Default is "yes".</p>
79 <p><opt>allow-interfaces=</opt> Set a comma separated list of
80 allowed network interfaces that should be used by the
81 avahi-daemon. Traffic on other interfaces will be ignored. If
82 set to an empty list all local interfaces except loopback and
83 point-to-point will be used.</p>
87 <p><opt>deny-interfaces=</opt> Set a comma separated list of
88 network interfaces that should be ignored by avahi-daemon.
89 Other not specified interfaces will be used, unless
90 <opt>allow-interfaces=</opt> is set. This option takes
91 precedence over <opt>allow-interfaces=</opt>.</p>
95 <p><opt>check-response-ttl=</opt> Takes a boolean value ("yes"
96 or "no"). If set to "yes", an additional security check is
97 activated: incoming IP packets will be ignored unless the IP
98 TTL is 255. Earlier mDNS specifications required this
99 check. Since this feature may be incompatible with newer
100 implementations of mDNS it defaults to "no". On the other hand
101 it provides extra security.</p>
105 <p><opt>use-iff-running=</opt> Takes a boolean value ("yes" or
106 "no"). If set to "yes" avahi-daemon monitors the IFF_RUNNING
107 flag bit which is used by some (modern) network drivers to
108 tell user space if a network cable is plugged in (in case of
109 copper ethernet), or the network card is associated with some
110 kind of network (in case of WLAN). If IFF_RUNNING is set
111 avahi-daemon will automatically announce its services on that
112 network. Unfortunately far too many network drivers do not
113 support this flag or support it in a broken way. Therefore
114 this option defaults to "no".</p>
118 <p><opt>enable-dbus=</opt> Takes either "yes", "no" or
119 "warn". If set to "yes" avahi-daemon connects to D-Bus,
120 offering an object oriented client API. It is only available
121 if Avahi has been compiled with <opt>--enable-dbus</opt> in
122 which case it defaults to "yes". "warn" behaves like "yes",
123 but the daemon starts up even when it fails to connect to a
124 D-Bus daemon. In addition, if the connection to the D-Bus
125 daemon is terminated we try to reconnect. (Unless we are in a
126 chroot() environment where this definitely will fail.) </p>
130 <p><opt>disallow-other-stacks=</opt> Takes a boolean value
131 ("yes" or "no"). If set to "yes" no other process is allowed
132 to bind to UDP port 5353. This effectively impedes other mDNS
133 stacks from running on the host. Use this as a security
134 measure to make sure that only Avahi is responsible for mDNS
135 traffic. Please note that we do not recommend running multiple
136 mDNS stacks on the same host simultaneously. This hampers
137 reliability and is a waste of resources. However, to not annoy
138 people this option defaults to "no".</p>
142 <p><opt>allow-point-to-point=</opt> Takes a boolean value
143 ("yes" or "no"). If set to "yes" avahi-daemon will make use of
144 interfaces with the POINTOPOINT flag set. This option defaults
145 to "no" as it might make mDNS unreliable due to usually large
146 latencies with such links and opens a potential security hole
147 by allowing mDNS access from Internet connections. Use with
152 <p><opt>cache-entries-max=</opt> Takes an unsigned integer
153 specifying how many resource records are cached per
154 interface. Bigger values allow mDNS work correctly in large LANs
155 but also increase memory consumption.</p>
159 <p><opt>clients-max=</opt> Takes an unsigned integer. The
160 maximum number of concurrent D-Bus clients allowed. If the
161 maximum number is reached further clients will be refused until
162 at least one existing client disconnects.</p>
166 <p><opt>objects-per-client-max=</opt> Takes an unsigned
167 integer. The maximum number of objects (entry groups, browsers,
168 resolvers) that may be registered per D-Bus client at a time. If the
169 maximum number is reached further object creation will be
170 refused until at least one object is freed.</p>
174 <p><opt>entries-per-entry-group-max=</opt> Takes an unsigned
175 integer. The maximum number of entries (resource records) per
176 entry group registered by a D-Bus client at a time. If the
177 maximum number is reached further resource records may not be
178 added to an entry group.</p>
182 <p><opt>ratelimit-interval-usec=</opt> Takes an unsigned
183 integer. Sets the per-interface packet rate-limiting interval
184 parameter. Together with <opt>ratelimit-burst=</opt> this may be
185 used to control the maximum number of packets Avahi will
186 generated in a specific period of time on an interface.</p>
190 <p><opt>ratelimit-burst=</opt> Takes an unsigned
191 integer. Sets the per-interface packet rate-limiting burst
192 parameter. Together with <opt>ratelimit-interval-usec=</opt> this may be
193 used to control the maximum number of packets Avahi will
194 generated in a specific period of time on an interface.</p>
198 <section name="Section [wide-area]">
200 <p><opt>enable-wide-area=</opt> Takes a boolean value
201 ("yes" or "no"). Enable wide-area DNS-SD, aka
202 DNS-SD over unicast DNS. If this is enabled only domains
203 ending in .local will be resolved on mDNS, all other domains
204 are resolved via unicast DNS. If you want to maintain multiple
205 different multicast DNS domains even with this option enabled
206 we encourage you to use subdomains of .local, such as
207 "kitchen.local". This option defaults to "yes".</p>
212 <section name="Section [publish]">
214 <option><p><opt>disable-publishing=</opt> Takes a boolean value
215 ("yes" or "no"). If set to "yes", no record will be published by
216 Avahi, not even address records for the local host. Avahi will
217 be started in a querying-only mode. Use this is a security
218 measure. This option defaults to "no"</p></option>
220 <option><p><opt>disable-user-service-publishing=</opt> Takes a boolean value
221 ("yes" or "no"). If set to "yes", Avahi will still publish
222 address records and suchlike but will not allow user
223 applications to publish services. Use this is a security
224 measure. This option defaults to "no"</p></option>
227 <p><opt>add-service-cookie=</opt> Takes a boolean value ("yes"
228 or "no"). If set to "yes" an implicit TXT entry will be added
229 to all locally registered services, containing a cookie value
230 which is chosen randomly on daemon startup. This can be used
231 to detect if two services on two different
232 interfaces/protocols are actually identical. Defaults to
237 <p><opt>publish-addresses=</opt> Takes a boolean value ("yes"
238 or "no"). If set to "yes" avahi-daemon will register mDNS
239 address records for all local IP addresses. Unless you want to
240 use avahi-daemon exclusively for browsing it's recommended to
241 enable this. If you plan to register local services you need
242 to enable this option. Defaults to "yes".</p>
246 <p><opt>publish-hinfo=</opt> Takes a boolean value ("yes" or
247 "no"). If set to "yes" avahi-daemon will register an mDNS
248 HINFO record on all interfaces which contains information
249 about the local operating system and CPU, which might be
250 useful for administrative purposes. This is recommended by the
251 mDNS specification but not required. For the sake of privacy
252 you might choose to disable this feature. Defaults to
257 <p><opt>publish-workstation=</opt> Takes a boolean value
258 ("yes" or "no"). If set to "yes" avahi-daemon will register a
259 service of type "_workstation._tcp" on the local LAN. This
260 might be useful for administrative purposes (i.e. browse for
261 all PCs on the LAN), but is not required or recommended by any
262 specification. Newer MacOS X releases register a service of
263 this type. Defaults to "no".</p>
267 <p><opt>publish-domain=</opt> Takes a boolean value ("yes" or
268 "no"). If set to "yes" avahi-daemon will announce the locally
269 used domain name (see above) for browsing by other
270 hosts. Defaults to "yes".</p>
274 <p><opt>publish-dns-servers=</opt> Takes a comma separated
275 list of IP addresses for unicast DNS servers. You can use this
276 to announce unicast DNS servers via mDNS. When used in
277 conjunction with avahi-dnsconfd on the client
278 side this allows DHCP-like configuration of unicast DNS
283 <p><opt>publish-resolv-conf-dns-servers=</opt> Takes a boolean
284 value ("yes" or "no"). If set to "yes" avahi-daemon will
285 publish the unicast DNS servers specified in
286 <file>/etc/resolv.conf</file> in addition to those specified
287 with <opt>publish-dns-servers</opt>. Send avahi-daemon a
288 SIGHUP to have it reload this file. Defaults to "no".</p>
292 <p><opt>publish-aaaa-on-ipv4=</opt> Takes a boolean value
293 ("yes" or "no"). If set to "yes" avahi-daemon will publish an
294 IPv6 AAAA record via IPv4, i.e. the local IPv6 addresses can be
295 resolved using an IPv4 transport. Only useful when IPv4 is
296 enabled with <opt>use-ipv4=true</opt>. Defaults to "yes".</p>
300 <p><opt>publish-a-on-ipv6=</opt> Takes a boolean value
301 ("yes" or "no"). If set to "yes" avahi-daemon will publish an
302 IPv4 A record via IPv6, i.e. the local IPv4 addresses can be
303 resolved using an IPv6 transport. Only useful when IPv6 is
304 enabled with <opt>use-ipv6=true</opt>. Defaults to "no".</p>
309 <section name="Section [reflector]">
311 <p><opt>enable-reflector=</opt> Takes a boolean value ("yes"
312 or "no"). If set to "yes" avahi-daemon will reflect incoming
313 mDNS requests to all local network interfaces, effectively
314 allowing clients to browse mDNS/DNS-SD services on all
315 networks connected to the gateway. The gateway is somewhat
316 intelligent and should work with all kinds of mDNS traffic,
317 though some functionality is lost (specifically the unicast
318 reply bit, which is used rarely anyway). Make sure to not run
319 multiple reflectors between the same networks, this might
320 cause them to play Ping Pong with mDNS packets. Defaults to
325 <p><opt>reflect-ipv=</opt> Takes a boolean value ("yes" or
326 "no"). If set to "yes" and <opt>enable-reflector</opt> is
327 enabled, avahi-daemon will forward mDNS traffic between IPv4
328 and IPv6, which is usually not recommended. Defaults to "no".</p>
332 <section name="Section [rlimits]">
333 <p>This section is used to define system resource limits for the
334 daemon. See <manref section="2" name="setrlimit"/> for more
335 information. If any of the options is not specified in the configuration
336 file, avahi-daemon does not change it from the system
340 <p><opt>rlimit-as=</opt> Value in bytes for RLIMIT_AS (maximum size of the process's virtual memory). Sensible values are heavily system dependent.</p>
344 <p><opt>rlimit-core=</opt> Value in bytes for RLIMIT_CORE (maximum core file size). Unless you want to debug avahi-daemon, it is safe to set this to 0.</p>
348 <p><opt>rlimit-data=</opt> Value in bytes for RLIMIT_DATA (maximum size of the process's data segment). Sensible values are heavily system dependent.</p>
352 <p><opt>rlimit-fsize=</opt> Value for RLIMIT_FSIZE (maximum size of files the process may create). Since avahi-daemon shouldn't write any files to disk, it is safe to set this to 0.</p>
356 <p><opt>rlimit-nofile=</opt> Value for RLIMIT_NOFILE (open file descriptors). avahi-daemon shouldn't need more than 15 to 20 open file descriptors concurrently.</p>
360 <p><opt>rlimit-stack=</opt> Value in bytes for RLIMIT_STACK (maximum size of the process stack). Sensible values are heavily system dependent.</p>
364 <p><opt>rlimit-nproc=</opt> Value for RLIMIT_NPROC (number of process of user). avahi-daemon forks of a helper process on systems where <manref name="chroot" section="2"/> is available. Therefore this value should not be set below 2.</p>
369 <section name="Authors">
370 <p>The Avahi Developers <@PACKAGE_BUGREPORT@>; Avahi is
371 available from <url href="@PACKAGE_URL@"/></p>
374 <section name="See also">
376 <manref name="avahi-daemon" section="8"/>, <manref name="avahi-dnsconfd" section="8"/>
380 <section name="Comments">
381 <p>This man page was written using <manref name="xml2man" section="1"
382 href="http://masqmail.cx/xml2man/"/> by Oliver Kurth.</p>