1 <?xml version="1.0"?><!--*-nxml-*-->
2 <!DOCTYPE manpage SYSTEM "xmltoman.dtd">
3 <?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?>
8 This file is part of avahi.
10 avahi is free software; you can redistribute it and/or modify it
11 under the terms of the GNU Lesser General Public License as
12 published by the Free Software Foundation; either version 2.1 of the
13 License, or (at your option) any later version.
15 avahi is distributed in the hope that it will be useful, but WITHOUT
16 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
17 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
18 Public License for more details.
20 You should have received a copy of the GNU Lesser General Public
21 License along with avahi; if not, write to the Free Software
22 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
26 <manpage name="avahi-daemon.conf" section="5" desc="avahi-daemon configuration file">
29 <cmd>@pkgsysconfdir@/avahi-daemon.conf</cmd>
33 <p><file>avahi-daemon.conf</file> is the configuration file for avahi-daemon.</p>
36 <section name="Section [Server]">
39 <p><opt>host-name=</opt> Set the host name avahi-daemon tries
40 to register on the LAN. If omited defaults to the system host
41 name as set with the sethostname() system call.</p>
45 <p><opt>domain-name=</opt> Set the default domain name avahi-daemon
46 tries to register its host name and services on the LAN in. If
47 omitted defaults to ".local".</p>
51 <p><opt>browse-domains=</opt> Set a comma separated list of
52 browsing domains (in addition to the default one and those
53 announced inside the default browsing domain). Please note
54 that the user may specify additional browsing domains on the
55 client side, either by setting $AVAHI_BROWSE_DOMAINS to a list
56 of colon separated domains or by adding them to the XDG config
57 file <file>~/.config/avahi/browse-domains</file> (separated by
63 <p><opt>use-ipv4=</opt> Takes a boolean value ("yes" or
64 "no"). If set to "no" avahi-daemon will not use IPv4
65 sockets. Default is "yes".</p>
69 <p><opt>use-ipv6=</opt> Takes a boolean value ("yes" or
70 "no"). If set to "no" avahi-daemon will not use IPv6
71 sockets. Default is "yes".</p>
75 <p><opt>allow-interfaces=</opt> Set a comma separated list of
76 allowed network interfaces that should be used by the
77 avahi-daemon. Other interfaces will be ignored. If set to the
78 empty list all local interfaces except loopback and
79 point-to-point will be used.</p>
83 <p><opt>deny-interfaces=</opt> Set a comma separated list of
84 network interfaces that should be ignored by avahi-daemon.
85 Other not specified interfaces will be used, unless
86 <opt>allow-interfaces</opt> is set. This option takes
87 precedence over <opt>deny-interfaces</opt>.</p>
91 <p><opt>check-response-ttl=</opt> Takes a boolean value ("yes"
92 or "no"). If set to "yes", an additional security check is
93 activated: incoming IP packets will be ignored unless the IP
94 TTL is 255. Earlier mDNS specifications required this
95 check. Since this feature may be incompatible with newer
96 implementations of mDNS it defaults to "no". On the other hand
97 it provides extra security.</p>
101 <p><opt>use-iff-running=</opt> Takes a boolean value ("yes" or
102 "no"). If set to "yes" avahi-daemon monitors the IFF_RUNNING
103 flag bit which is used by some (modern) network drivers to
104 tell user space if a network cable is plugged in (in case of
105 copper ethernet), or the network card is associated with some
106 kind of network (in case of WLAN). If IFF_RUNNING is set
107 avahi-daemon will automatically announce its services on that
108 network. Unfortunately far too many network drivers do not
109 support this flag or support it in a broken way. Therefore
110 this option defaults to "no".</p>
114 <p><opt>enable-dbus=</opt> Takes either "yes", "no" or
115 "warn". If set to "yes" avahi-daemon connects to D-Bus,
116 offering an object oriented client API. It is only available
117 if Avahi has been compiled with <opt>--enable-dbus</opt> in
118 which case it defaults to "yes". "warn" behaves like "yes",
119 but the daemon starts up even when it fails to connect to a
120 D-Bus daemon. In addition, if the connection to the D-Bus
121 daemon is terminated we try to reconnect. (Unless we are in a
122 chroot() environment where this definitely will fail.) </p>
126 <p><opt>disallow-other-stacks=</opt> Takes a boolean value
127 ("yes" or "no"). If set to "yes" no other process is allowed
128 to bind to UDP port 5353. This effectively impedes other mDNS
129 stacks from running on the host. Use this as a security
130 measure to make sure that only Avahi is responsible for mDNS
131 traffic. Please note that we do not recommend running multiple
132 mDNS stacks on the same host simultaneously. This hampers
133 reliability and is a waste of resources. However, to not annoy
134 people this option defaults to "no".</p>
138 <p><opt>allow-point-to-point=</opt> Takes a boolean value
139 ("yes" or "no"). If set to "yes" avahi-daemon will make use of
140 interfaces with the POINTOPOINT flag set. This option defaults
141 to "no" as it might make mDNS unreliable due to usually large
142 latencies with such links and opens a potential security hole
143 by allowing mDNS access from Internet connections. Use with
149 <section name="Section [wide-area]">
151 <p><opt>enable-wide-area=</opt> Takes a boolean value
152 ("yes" or "no"). Enable wide-area DNS-SD, aka
153 DNS-SD over unicast DNS. If this is enabled only domains
154 ending in .local will be resolved on mDNS, all other domains
155 are resolved via unicast DNS. If you want to maintain multiple
156 different multicast DNS domains even with this option enabled
157 we encourage you to use subdomains of .local, such as
158 "kitchen.local". This option defaults to "yes".</p>
163 <section name="Section [publish]">
165 <option><p><opt>disable-publishing=</opt> Takes a boolean value
166 ("yes" or "no"). If set to "yes", no record will be published by
167 Avahi, not even address records for the local host. Avahi will
168 be started in a querying-only mode. Use this is a security
169 measure. This option defaults to "no"</p></option>
171 <option><p><opt>disable-user-service-publishing=</opt> Takes a boolean value
172 ("yes" or "no"). If set to "yes", Avahi will still publish
173 address records and suchlike but will not allow user
174 applications to publish services. Use this is a security
175 measure. This option defaults to "no"</p></option>
178 <p><opt>add-service-cookie=</opt> Takes a boolean value ("yes"
179 or "no"). If set to "yes" an implicit TXT entry will be added
180 to all locally registered services, containing a cookie value
181 which is chosen randomly on daemon startup. This can be used
182 to detect if two services on two different
183 interfaces/protocols are actually identical. Defaults to
188 <p><opt>publish-addresses=</opt> Takes a boolean value ("yes"
189 or "no"). If set to "yes" avahi-daemon will register mDNS
190 address records for all local IP addresses. Unless you want to
191 use avahi-daemon exclusively for browsing it's recommended to
192 enable this. If you plan to register local services you need
193 to enable this option. Defaults to "yes".</p>
197 <p><opt>publish-hinfo=</opt> Takes a boolean value ("yes" or
198 "no"). If set to "yes" avahi-daemon will register an mDNS
199 HINFO record on all interfaces which contains information
200 about the local operating system and CPU, which might be
201 useful for administrative purposes. This is recommended by the
202 mDNS specification but not required. For the sake of privacy
203 you might choose to disable this feature. Defaults to
208 <p><opt>publish-workstation=</opt> Takes a boolean value
209 ("yes" or "no"). If set to "yes" avahi-daemon will register a
210 service of type "_workstation._tcp" on the local LAN. This
211 might be useful for administrative purposes (i.e. browse for
212 all PCs on the LAN), but is not required or recommended by any
213 specification. Newer MacOS X releases register a service of
214 this type. Defaults to "yes".</p>
218 <p><opt>publish-domain=</opt> Takes a boolean value ("yes" or
219 "no"). If set to "yes" avahi-daemon will announce the locally
220 used domain name (see above) for browsing by other
221 hosts. Defaults to "yes".</p>
225 <p><opt>publish-dns-servers=</opt> Takes a comma separated
226 list of IP addresses for unicast DNS servers. You can use this
227 to announce unicast DNS servers via mDNS. When used in
228 conjunction with avahi-dnsconfd on the client
229 side this allows DHCP-like configuration of unicast DNS
234 <p><opt>publish-resolv-conf-dns-servers=</opt> Takes a boolean
235 value ("yes" or "no"). If set to "yes" avahi-daemon will
236 publish the unicast DNS servers specified in
237 <file>/etc/resolv.conf</file> in addition to those specified
238 with <opt>publish-dns-servers</opt>. Send avahi-daemon a
239 SIGHUP to have it reload this file. Defaults to "no".</p>
243 <p><opt>publish-aaaa-on-ipv4=</opt> Takes a boolean value
244 ("yes" or "no"). If set to "yes" avahi-daemon will publish an
245 IPv6 AAAA record via IPv4, i.e. the local IPv6 addresses can be
246 resolved using an IPv4 transport. Only useful when IPv4 is
247 enabled with <opt>use-ipv4=true</opt>. Defaults to "yes".</p>
251 <p><opt>publish-a-on-ipv6=</opt> Takes a boolean value
252 ("yes" or "no"). If set to "yes" avahi-daemon will publish an
253 IPv4 A record via IPv6, i.e. the local IPv4 addresses can be
254 resolved using an IPv6 transport. Only useful when IPv6 is
255 enabled with <opt>use-ipv6=true</opt>. Defaults to "no".</p>
260 <section name="Section [reflector]">
262 <p><opt>enable-reflector=</opt> Takes a boolean value ("yes"
263 or "no"). If set to "yes" avahi-daemon will reflect incoming
264 mDNS requests to all local network interfaces, effectively
265 allowing clients to browse mDNS/DNS-SD services on all
266 networks connected to the gateway. The gateway is somewhat
267 intelligent and should work with all kinds of mDNS traffic,
268 though some functionality is lost (specifically the unicast
269 reply bit, which is used rarely anyway). Make sure to not run
270 multiple reflectors between the same networks, this might
271 cause them to play Ping Pong with mDNS packets. Defaults to
276 <p><opt>reflect-ipv=</opt> Takes a boolean value ("yes" or
277 "no"). If set to "yes" and <opt>enable-reflector</opt> is
278 enabled, avahi-daemon will forward mDNS traffic between IPv4
279 and IPv6, which is usually not recommended. Defaults to "no".</p>
283 <section name="Section [rlimits]">
284 <p>This section is used to define system resource limits for the
285 daemon. See <manref section="2" name="setrlimit"/> for more
286 information. If any of the options is not specified in the configuration
287 file, avahi-daemon does not change it from the system
292 <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>
296 <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>
300 <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>
304 <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>
308 <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>
312 <p><opt>rlimit-stack=</opt> Value in bytes for RLIMIT_STACK (maximum size of the process stack). Sensible values are heavily system dependent.</p>
316 <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>
321 <section name="Authors">
322 <p>The Avahi Developers <@PACKAGE_BUGREPORT@>; Avahi is
323 available from <url href="@PACKAGE_URL@"/></p>
326 <section name="See also">
328 <manref name="avahi-daemon" section="8"/>, <manref name="avahi-dnsconfd" section="8"/>
332 <section name="Comments">
333 <p>This man page was written using <manref name="xml2man" section="1"
334 href="http://masqmail.cx/xml2man/"/> by Oliver Kurth.</p>