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>domain-name=</opt> Set the default domain name avahi-daemon
44 tries to register its host name and services on the LAN in. If
45 omitted defaults to ".local".</p>
49 <p><opt>browse-domains=</opt> Set a comma separated list of
50 browsing domains (in addition to the default one and those
51 announced inside the default browsing domain). Please note
52 that the user may specify additional browsing domains on the
53 client side, either by setting $AVAHI_BROWSE_DOMAINS to a list
54 of colon separated domains or by adding them to the XDG config
55 file <file>~/.config/avahi/browse-domains</file> (separated by
61 <p><opt>use-ipv4=</opt> Takes a boolean value ("yes" or
62 "no"). If set to "no" avahi-daemon will not use IPv4
63 sockets. Default is "yes".</p>
67 <p><opt>use-ipv6=</opt> Takes a boolean value ("yes" or
68 "no"). If set to "no" avahi-daemon will not use IPv6
69 sockets. Default is "yes".</p>
73 <p><opt>allow-interfaces=</opt> Set a comma separated list of
74 allowed network interfaces that should be used by the
75 avahi-daemon. Other interfaces will be ignored. If set to the
76 empty list all local interfaces except loopback and
77 point-to-point will be used.</p>
81 <p><opt>deny-interfaces=</opt> Set a comma separated list of
82 network interfaces that should be ignored by avahi-daemon.
83 Other not specified interfaces will be used, unless
84 <opt>allow-interfaces</opt> is set. This option takes
85 precedence over <opt>deny-interfaces</opt>.</p>
89 <p><opt>check-response-ttl=</opt> Takes a boolean value ("yes"
90 or "no"). If set to "yes", an additional security check is
91 activated: incoming IP packets will be ignored unless the IP
92 TTL is 255. Earlier mDNS specifications required this
93 check. Since this feature may be incompatible with newer
94 implementations of mDNS it defaults to "no". On the other hand
95 it provides extra security.</p>
99 <p><opt>use-iff-running=</opt> Takes a boolean value ("yes" or
100 "no"). If set to "yes" avahi-daemon monitors the IFF_RUNNING
101 flag bit which is used by some (modern) network drivers to
102 tell user space if a network cable is plugged in (in case of
103 copper ethernet), or the network card is associated with some
104 kind of network (in case of WLAN). If IFF_RUNNING is set
105 avahi-daemon will automatically announce its services on that
106 network. Unfortunately far too many network drivers do not
107 support this flag or support it in a broken way. Therefore
108 this option defaults to "no".</p>
112 <p><opt>enable-dbus=</opt> Takes either "yes", "no" or
113 "warn". If set to "yes" avahi-daemon connects to D-Bus,
114 offering an object oriented client API. It is only available
115 if Avahi has been compiled with <opt>--enable-dbus</opt> in
116 which case it defaults to "yes". "warn" behaves like "yes",
117 but the daemon starts up even when it fails to connect to a
118 D-Bus daemon. In addition, if the connection to the D-Bus
119 daemon is terminated we try to reconnect. (Unless we are in a
120 chroot() environment where this definitely will fail.) </p>
124 <p><opt>disallow-other-stacks=</opt> Takes a boolean value
125 ("yes" or "no"). If set to "yes" no other process is allowed
126 to bind to UDP port 5353. This effectively impedes other mDNS
127 stacks from running on the host. Use this as a security
128 measure to make sure that only Avahi is responsible for mDNS
129 traffic. Please note that we do not recommend running multiple
130 mDNS stacks on the same host simultaneously. This hampers
131 reliability and is a waste of resources. However, to not annoy
132 people this option defaults to "no".</p>
136 <p><opt>allow-point-to-point=</opt> Takes a boolean value
137 ("yes" or "no"). If set to "yes" avahi-daemon will make use of
138 interfaces with the POINTOPOINT flag set. This option defaults
139 to "no" as it might make mDNS unreliable due to usually large
140 latencies with such links and opens a potential security hole
141 by allowing mDNS access from Internet connections. Use with
147 <section name="Section [wide-area]">
149 <p><opt>enable-wide-area=</opt> Takes a boolean value
150 ("yes" or "no"). Enable wide-area DNS-SD, aka
151 DNS-SD over unicast DNS. If this is enabled only domains
152 ending in .local will be resolved on mDNS, all other domains
153 are resolved via unicast DNS. If you want to maintain multiple
154 different multicast DNS domains even with this option enabled
155 we encourage you to use subdomains of .local, such as
156 "kitchen.local". This option defaults to "yes".</p>
161 <section name="Section [publish]">
163 <option><p><opt>disable-publishing=</opt> Takes a boolean value
164 ("yes" or "no"). If set to "yes", no record will be published by
165 Avahi, not even address records for the local host. Avahi will
166 be started in a querying-only mode. Use this is a security
167 measure. This option defaults to "no"</p></option>
169 <option><p><opt>disable-user-service-publishing=</opt> Takes a boolean value
170 ("yes" or "no"). If set to "yes", Avahi will still publish
171 address records and suchlike but will not allow user
172 applications to publish services. Use this is a security
173 measure. This option defaults to "no"</p></option>
176 <p><opt>add-service-cookie=</opt> Takes a boolean value ("yes"
177 or "no"). If set to "yes" an implicit TXT entry will be added
178 to all locally registered services, containing a cookie value
179 which is chosen randomly on daemon startup. This can be used
180 to detect if two services on two different
181 interfaces/protocols are actually identical. Defaults to
186 <p><opt>publish-addresses=</opt> Takes a boolean value ("yes"
187 or "no"). If set to "yes" avahi-daemon will register mDNS
188 address records for all local IP addresses. Unless you want to
189 use avahi-daemon exclusively for browsing it's recommended to
190 enable this. If you plan to register local services you need
191 to enable this option. Defaults to "yes".</p>
195 <p><opt>publish-hinfo=</opt> Takes a boolean value ("yes" or
196 "no"). If set to "yes" avahi-daemon will register an mDNS
197 HINFO record on all interfaces which contains information
198 about the local operating system and CPU, which might be
199 useful for administrative purposes. This is recommended by the
200 mDNS specification but not required. For the sake of privacy
201 you might choose to disable this feature. Defaults to
206 <p><opt>publish-workstation=</opt> Takes a boolean value
207 ("yes" or "no"). If set to "yes" avahi-daemon will register a
208 service of type "_workstation._tcp" on the local LAN. This
209 might be useful for administrative purposes (i.e. browse for
210 all PCs on the LAN), but is not required or recommended by any
211 specification. Newer MacOS X releases register a service of
212 this type. Defaults to "yes".</p>
216 <p><opt>publish-domain=</opt> Takes a boolean value ("yes" or
217 "no"). If set to "yes" avahi-daemon will announce the locally
218 used domain name (see above) for browsing by other
219 hosts. Defaults to "yes".</p>
223 <p><opt>publish-dns-servers=</opt> Takes a comma separated
224 list of IP addresses for unicast DNS servers. You can use this
225 to announce unicast DNS servers via mDNS. When used in
226 conjunction with avahi-dnsconfd on the client
227 side this allows DHCP-like configuration of unicast DNS
232 <p><opt>publish-resolv-conf-dns-servers=</opt> Takes a boolean
233 value ("yes" or "no"). If set to "yes" avahi-daemon will
234 publish the unicast DNS servers specified in
235 <file>/etc/resolv.conf</file> in addition to those specified
236 with <opt>publish-dns-servers</opt>. Send avahi-daemon a
237 SIGHUP to have it reload this file. Defaults to "no".</p>
241 <p><opt>publish-aaaa-on-ipv4=</opt> Takes a boolean value
242 ("yes" or "no"). If set to "yes" avahi-daemon will publish an
243 IPv6 AAAA record via IPv4, i.e. the local IPv6 addresses can be
244 resolved using an IPv4 transport. Only useful when IPv4 is
245 enabled with <opt>use-ipv4=true</opt>. Defaults to "yes".</p>
249 <p><opt>publish-a-on-ipv6=</opt> Takes a boolean value
250 ("yes" or "no"). If set to "yes" avahi-daemon will publish an
251 IPv4 A record via IPv6, i.e. the local IPv4 addresses can be
252 resolved using an IPv6 transport. Only useful when IPv6 is
253 enabled with <opt>use-ipv6=true</opt>. Defaults to "no".</p>
258 <section name="Section [reflector]">
260 <p><opt>enable-reflector=</opt> Takes a boolean value ("yes"
261 or "no"). If set to "yes" avahi-daemon will reflect incoming
262 mDNS requests to all local network interfaces, effectively
263 allowing clients to browse mDNS/DNS-SD services on all
264 networks connected to the gateway. The gateway is somewhat
265 intelligent and should work with all kinds of mDNS traffic,
266 though some functionality is lost (specifically the unicast
267 reply bit, which is used rarely anyway). Make sure to not run
268 multiple reflectors between the same networks, this might
269 cause them to play Ping Pong with mDNS packets. Defaults to
274 <p><opt>reflect-ipv=</opt> Takes a boolean value ("yes" or
275 "no"). If set to "yes" and <opt>enable-reflector</opt> is
276 enabled, avahi-daemon will forward mDNS traffic between IPv4
277 and IPv6, which is usually not recommended. Defaults to "no".</p>
281 <section name="Section [rlimits]">
282 <p>This section is used to define system resource limits for the
283 daemon. See <manref section="2" name="setrlimit"/> for more
284 information. If any of the options is not specified in the configuration
285 file, avahi-daemon does not change it from the system
290 <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>
294 <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>
298 <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>
302 <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>
306 <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>
310 <p><opt>rlimit-stack=</opt> Value in bytes for RLIMIT_STACK (maximum size of the process stack). Sensible values are heavily system dependent.</p>
314 <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>
319 <section name="Authors">
320 <p>The Avahi Developers <@PACKAGE_BUGREPORT@>; Avahi is
321 available from <url href="@PACKAGE_URL@"/></p>
324 <section name="See also">
326 <manref name="avahi-daemon" section="8"/>, <manref name="avahi-dnsconfd" section="8"/>
330 <section name="Comments">
331 <p>This man page was written using <manref name="xml2man" section="1"
332 href="http://masqmail.cx/xml2man/"/> by Oliver Kurth.</p>