1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
|
<?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
-->
<refentry id="systemd.dnssd" conditional='ENABLE_RESOLVE'>
<refentryinfo>
<title>systemd.dnssd</title>
<productname>systemd</productname>
</refentryinfo>
<refmeta>
<refentrytitle>systemd.dnssd</refentrytitle>
<manvolnum>5</manvolnum>
</refmeta>
<refnamediv>
<refname>systemd.dnssd</refname>
<refpurpose>DNS-SD configuration</refpurpose>
</refnamediv>
<refsynopsisdiv>
<para><filename><replaceable>network_service</replaceable>.dnssd</filename></para>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>DNS-SD setup is performed by
<citerefentry><refentrytitle>systemd-resolved</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para>
<para>The main network service file must have the extension <filename>.dnssd</filename>; other
extensions are ignored.</para>
<para>The <filename>.dnssd</filename> files are read from the files located in the system
network directory <filename>/usr/lib/systemd/dnssd</filename>, the volatile runtime network
directory <filename>/run/systemd/dnssd</filename> and the local administration network
directory <filename>/etc/systemd/dnssd</filename>. All configuration files are collectively
sorted and processed in lexical order, regardless of the directories in which they live.
However, files with identical filenames replace each other. Files in <filename>/etc</filename>
have the highest priority, files in <filename>/run</filename> take precedence over files with
the same name in <filename>/usr/lib</filename>. This can be used to override a system-supplied
configuration file with a local file if needed.</para>
<para>Along with the network service file <filename>foo.dnssd</filename>, a "drop-in" directory
<filename>foo.dnssd.d/</filename> may exist. All files with the suffix
<literal>.conf</literal> from this directory will be parsed after the file itself is
parsed. This is useful to alter or add configuration settings, without having to modify the main
configuration file. Each drop-in file must have appropriate section headers.</para>
<para>In addition to <filename>/etc/systemd/dnssd</filename>, drop-in <literal>.d</literal>
directories can be placed in <filename>/usr/lib/systemd/dnssd</filename> or
<filename>/run/systemd/dnssd</filename> directories. Drop-in files in
<filename>/etc</filename> take precedence over those in <filename>/run</filename> which in turn
take precedence over those in <filename>/usr/lib</filename>. Drop-in files under any of these
directories take precedence over the main network service file wherever located. (Of course, since
<filename>/run</filename> is temporary and <filename>/usr/lib</filename> is for vendors, it is
unlikely drop-ins should be used in either of those places.)</para>
</refsect1>
<refsect1>
<title>[Service] Section Options</title>
<para>The network service file contains a <literal>[Service]</literal>
section, which specifies a discoverable network service announced in a
local network with Multicast DNS broadcasts.</para>
<variablelist class='network-directives'>
<varlistentry>
<term><varname>Name=</varname></term>
<listitem>
<para>An instance name of the network service as defined in the section 4.1.1 of <ulink
url="https://tools.ietf.org/html/rfc6763">RFC 6763</ulink>, e.g. <literal>webserver</literal>.</para>
<para>The option supports simple specifier expansion. The following expansions are understood:</para>
<table>
<title>Specifiers available</title>
<tgroup cols='3' align='left' colsep='1' rowsep='1'>
<colspec colname="spec" />
<colspec colname="mean" />
<colspec colname="detail" />
<thead>
<row>
<entry>Specifier</entry>
<entry>Meaning</entry>
<entry>Details</entry>
</row>
</thead>
<tbody>
<row>
<entry><literal>%m</literal></entry>
<entry>Machine ID</entry>
<entry>The machine ID of the running system, formatted as string. See <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry> for more information.</entry>
</row>
<row>
<entry><literal>%b</literal></entry>
<entry>Boot ID</entry>
<entry>The boot ID of the running system, formatted as string. See <citerefentry><refentrytitle>random</refentrytitle><manvolnum>4</manvolnum></citerefentry> for more information.</entry>
</row>
<row>
<entry><literal>%H</literal></entry>
<entry>Host name</entry>
<entry>The hostname of the running system.</entry>
</row>
<row>
<entry><literal>%v</literal></entry>
<entry>Kernel release</entry>
<entry>Identical to <command>uname -r</command> output.</entry>
</row>
</tbody>
</tgroup>
</table>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>Type=</varname></term>
<listitem>
<para>A type of the network service as defined in the section 4.1.2 of <ulink
url="https://tools.ietf.org/html/rfc6763">RFC 6763</ulink>, e.g. <literal>_http._tcp</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>Port=</varname></term>
<listitem>
<para>An IP port number of the network service.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>Priority=</varname></term>
<listitem>
<para>A priority number set in SRV resource records corresponding to the network service.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>Weight=</varname></term>
<listitem>
<para>A weight number set in SRV resource records corresponding to the network service.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>TxtText=</varname></term>
<listitem>
<para>A whitespace-separated list of arbitrary key/value pairs
conveying additional information about the named service in the corresponding TXT resource record,
e.g. <literal>path=/portal/index.html</literal>. Keys and values can contain C-style escape
sequences which get translated upon reading configuration files.
</para>
<para>This option together with <varname>TxtData=</varname> may be specified more than once, in which
case multiple TXT resource records will be created for the service. If the empty string is assigned to
this option, the list is reset and all prior assignments will have no effect.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>TxtData=</varname></term>
<listitem>
<para>A whitespace-separated list of arbitrary key/value pairs
conveying additional information about the named service in the corresponding TXT resource record
where values are base64-encoded string representing any binary data,
e.g. <literal>data=YW55IGJpbmFyeSBkYXRhCg==</literal>. Keys can contain C-style escape
sequences which get translated upon reading configuration files.
</para>
<para>This option together with <varname>TxtText=</varname> may be specified more than once, in which
case multiple TXT resource records will be created for the service. If the empty string is assigned to
this option, the list is reset and all prior assignments will have no effect.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Examples</title>
<example>
<title>HTTP service</title>
<programlisting># /etc/systemd/dnssd/http.dnssd
[Service]
Name=%H
Type=_http._tcp
Port=80
TxtText=path=/stats/index.html t=temperature_sensor</programlisting>
<para>This makes the http server running on the host discoverable in the local network
given MulticastDNS is enabled on the network interface.</para>
<para>Now the utility <literal>resolvectl</literal> should be able to resolve the
service to the host's name:</para>
<programlisting>$ resolvectl service meteo._http._tcp.local
meteo._http._tcp.local: meteo.local:80 [priority=0, weight=0]
169.254.208.106%senp0s21f0u2u4
fe80::213:3bff:fe49:8aa%senp0s21f0u2u4
path=/stats/index.html
t=temperature_sensor
(meteo/_http._tcp/local)
-- Information acquired via protocol mDNS/IPv6 in 4.0ms.
-- Data is authenticated: yes</programlisting>
<para><literal>Avahi</literal> running on a different host in the same local network should see the service as well:</para>
<programlisting>$ avahi-browse -a -r
+ enp3s0 IPv6 meteo Web Site local
+ enp3s0 IPv4 meteo Web Site local
= enp3s0 IPv6 meteo Web Site local
hostname = [meteo.local]
address = [fe80::213:3bff:fe49:8aa]
port = [80]
txt = ["path=/stats/index.html" "t=temperature_sensor"]
= enp3s0 IPv4 meteo Web Site local
hostname = [meteo.local]
address = [169.254.208.106]
port = [80]
txt = ["path=/stats/index.html" "t=temperature_sensor"]</programlisting>
</example>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>resolvectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
</para>
</refsect1>
</refentry>
|
