Debian Codegraph @

upstream/debian-unstable/man5/systemd.socket.5

raw
1 '\" t
2 .TH "SYSTEMD\&.SOCKET" "5" "" "systemd 261~rc3" "systemd.socket"
3 .\" -----------------------------------------------------------------
4 .\" * Define some portability stuff
5 .\" -----------------------------------------------------------------
6 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7 .\" http://bugs.debian.org/507673
8 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
9 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10 .ie \n(.g .ds Aq \(aq
11 .el .ds Aq '
12 .\" -----------------------------------------------------------------
13 .\" * set default formatting
14 .\" -----------------------------------------------------------------
15 .\" disable hyphenation
16 .nh
17 .\" disable justification (adjust text to left margin only)
18 .ad l
19 .\" -----------------------------------------------------------------
20 .\" * MAIN CONTENT STARTS HERE *
21 .\" -----------------------------------------------------------------
22 .SH "NAME"
23 systemd.socket \- Socket unit configuration
24 .SH "SYNOPSIS"
25 .PP
26 \fIsocket\fR\&.socket
27 .SH "DESCRIPTION"
28 .PP
29 A unit configuration file whose name ends in
30 "\&.socket"
31 encodes information about an IPC or network socket or a file system FIFO controlled and supervised by systemd, for socket\-based activation\&.
32 .PP
33 This man page lists the configuration options specific to this unit type\&. See
34 \fBsystemd.unit\fR(5)
35 for the common options of all unit configuration files\&. The common configuration items are configured in the generic [Unit] and [Install] sections\&. The socket specific configuration options are configured in the [Socket] section\&.
36 .PP
37 Additional options are listed in
38 \fBsystemd.exec\fR(5), which define the execution environment the
39 \fBExecStartPre=\fR,
40 \fBExecStartPost=\fR,
41 \fBExecStopPre=\fR
42 and
43 \fBExecStopPost=\fR
44 commands are executed in, and in
45 \fBsystemd.kill\fR(5), which define the way the processes are terminated, and in
46 \fBsystemd.resource-control\fR(5), which configure resource control settings for the processes of the socket\&.
47 .PP
48 For each socket unit, a matching service unit must exist, describing the service to start on incoming traffic on the socket (see
49 \fBsystemd.service\fR(5)
50 for more information about \&.service units)\&. The name of the \&.service unit is by default the same as the name of the \&.socket unit, but can be altered with the
51 \fBService=\fR
52 option described below\&. Depending on the setting of the
53 \fBAccept=\fR
54 option described below, this \&.service unit must either be named like the \&.socket unit, but with the suffix replaced, unless overridden with
55 \fBService=\fR; or it must be a template unit named the same way\&. Example: a socket file
56 foo\&.socket
57 needs a matching service
58 foo\&.service
59 if
60 \fBAccept=no\fR
61 is set\&. If
62 \fBAccept=yes\fR
63 is set, a service template
64 foo@\&.service
65 must exist from which services are instantiated for each incoming connection\&.
66 .PP
67 No implicit
68 \fIWantedBy=\fR
69 or
70 \fIRequiredBy=\fR
71 dependency from the socket to the service is added\&. This means that the service may be started without the socket, in which case it must be able to open sockets by itself\&. To prevent this, an explicit
72 \fIRequires=\fR
73 dependency may be added\&.
74 .PP
75 Socket units may be used to implement on\-demand starting of services, as well as parallelized starting of services\&. See the blog stories linked at the end for an introduction\&.
76 .PP
77 Note that the daemon software configured for socket activation with socket units needs to be able to accept sockets from systemd, either via systemd\*(Aqs native socket passing interface (see
78 \fBsd_listen_fds\fR(3)
79 for details about the precise protocol used and the order in which the file descriptors are passed) or via traditional
80 \fBinetd\fR(8)\-style socket passing (i\&.e\&. sockets passed in via standard input and output, using
81 \fIStandardInput=socket\fR
82 in the service file)\&.
83 .PP
84 By default, network sockets allocated through
85 \&.socket
86 units are allocated in the host\*(Aqs network namespace (see
87 \fBnetwork_namespaces\fR(7))\&. This does not mean however that the service activated by a configured socket unit has to be part of the host\*(Aqs network namespace as well\&. It is supported and even good practice to run services in their own network namespace (for example through
88 \fIPrivateNetwork=\fR, see
89 \fBsystemd.exec\fR(5)), receiving only the sockets configured through socket\-activation from the host\*(Aqs namespace\&. In such a set\-up communication within the host\*(Aqs network namespace is only permitted through the activation sockets passed in while all sockets allocated from the service code itself will be associated with the service\*(Aqs own namespace, and thus possibly subject to a restrictive configuration\&.
90 .PP
91 Alternatively, it is possible to run a
92 \&.socket
93 unit in another network namespace by setting
94 \fBPrivateNetwork=yes\fR
95 in combination with
96 \fIJoinsNamespaceOf=\fR, see
97 \fBsystemd.exec\fR(5)
98 and
99 \fBsystemd.unit\fR(5)
100 for details\&.
101 .SH "AUTOMATIC DEPENDENCIES"
102 .SS "Implicit Dependencies"
103 .PP
104 The following dependencies are implicitly added:
105 .sp
106 .RS 4
107 .ie n \{\
108 \h'-04'\(bu\h'+03'\c
109 .\}
110 .el \{\
111 .sp -1
112 .IP \(bu 2.3
113 .\}
114 Socket units automatically gain a
115 \fIBefore=\fR
116 dependency on the service units they activate\&.
117 .RE
118 .sp
119 .RS 4
120 .ie n \{\
121 \h'-04'\(bu\h'+03'\c
122 .\}
123 .el \{\
124 .sp -1
125 .IP \(bu 2.3
126 .\}
127 Socket units referring to file system paths (such as
128 \fBAF_UNIX\fR
129 sockets or FIFOs) implicitly gain
130 \fIRequires=\fR
131 and
132 \fIAfter=\fR
133 dependencies on all mount units necessary to access those paths\&.
134 .RE
135 .sp
136 .RS 4
137 .ie n \{\
138 \h'-04'\(bu\h'+03'\c
139 .\}
140 .el \{\
141 .sp -1
142 .IP \(bu 2.3
143 .\}
144 Socket units using the
145 \fIBindToDevice=\fR
146 setting automatically gain a
147 \fIBindsTo=\fR
148 and
149 \fIAfter=\fR
150 dependency on the device unit encapsulating the specified network interface\&.
151 .RE
152 .PP
153 Additional implicit dependencies may be added as result of execution and resource control parameters as documented in
154 \fBsystemd.exec\fR(5)
155 and
156 \fBsystemd.resource-control\fR(5)\&.
157 .SS "Default Dependencies"
158 .PP
159 The following dependencies are added unless
160 \fIDefaultDependencies=no\fR
161 is set:
162 .sp
163 .RS 4
164 .ie n \{\
165 \h'-04'\(bu\h'+03'\c
166 .\}
167 .el \{\
168 .sp -1
169 .IP \(bu 2.3
170 .\}
171 Socket units automatically gain a
172 \fIBefore=\fR
173 dependency on
174 sockets\&.target\&.
175 .RE
176 .sp
177 .RS 4
178 .ie n \{\
179 \h'-04'\(bu\h'+03'\c
180 .\}
181 .el \{\
182 .sp -1
183 .IP \(bu 2.3
184 .\}
185 Socket units automatically gain a pair of
186 \fIAfter=\fR
187 and
188 \fIRequires=\fR
189 dependency on
190 sysinit\&.target, and a pair of
191 \fIBefore=\fR
192 and
193 \fIConflicts=\fR
194 dependencies on
195 shutdown\&.target\&. These dependencies ensure that the socket unit is started before normal services at boot, and is stopped on shutdown\&. Only sockets involved with early boot or late system shutdown should disable
196 \fIDefaultDependencies=\fR
197 option\&.
198 .RE
199 .SH "OPTIONS"
200 .PP
201 Socket unit files may include [Unit] and [Install] sections, which are described in
202 \fBsystemd.unit\fR(5)\&.
203 .PP
204 Socket unit files must include a [Socket] section, which carries information about the socket or FIFO it supervises\&. A number of options that may be used in this section are shared with other unit types\&. These options are documented in
205 \fBsystemd.exec\fR(5),
206 \fBsystemd.kill\fR(5)
207 and
208 \fBsystemd.resource-control\fR(5)\&. The options specific to the [Socket] section of socket units are the following:
209 .PP
210 \fIListenStream=\fR, \fIListenDatagram=\fR, \fIListenSequentialPacket=\fR
211 .RS 4
212 Specifies an address to listen on for a stream (\fBSOCK_STREAM\fR), datagram (\fBSOCK_DGRAM\fR), or sequential packet (\fBSOCK_SEQPACKET\fR) socket, respectively\&. The address can be written in various formats:
213 .sp
214 If the address starts with a slash ("/"), it is read as file system socket in the
215 \fBAF_UNIX\fR
216 socket family\&.
217 .sp
218 If the address starts with an at symbol ("@"), it is read as abstract namespace socket in the
219 \fBAF_UNIX\fR
220 family\&. The
221 "@"
222 is replaced with a
223 \fBNUL\fR
224 character before binding\&. For details, see
225 \fBunix\fR(7)\&.
226 .sp
227 If the address string is a single number, it is read as port number to listen on via IPv6\&. Depending on the value of
228 \fIBindIPv6Only=\fR
229 (see below) this might result in the service being available via both IPv6 and IPv4 (default) or just via IPv6\&.
230 .sp
231 If the address string is a string in the format
232 "\fIv\&.w\&.x\&.y\fR:\fIz\fR", it is interpreted as IPv4 address
233 \fIv\&.w\&.x\&.y\fR
234 and port
235 \fIz\fR\&.
236 .sp
237 If the address string is a string in the format
238 "[\fIx\fR]:\fIy\fR", it is interpreted as IPv6 address
239 \fIx\fR
240 and port
241 \fIy\fR\&. An optional interface scope (interface name or number) may be specified after a
242 "%"
243 symbol:
244 "[\fIx\fR]:\fIy\fR%\fIdev\fR"\&. Interface scopes are only useful with link\-local addresses, because the kernel ignores them in other cases\&. Note that if an address is specified as IPv6, it might still make the service available via IPv4 too, depending on the
245 \fIBindIPv6Only=\fR
246 setting (see below)\&.
247 .sp
248 If the address string is a string in the format
249 "vsock:\fIx\fR:\fIy\fR", it is read as CID
250 \fIx\fR
251 on a port
252 \fIy\fR
253 address in the
254 \fBAF_VSOCK\fR
255 family\&. The CID is a unique 32\-bit integer identifier in
256 \fBAF_VSOCK\fR
257 analogous to an IP address\&. Specifying the CID is optional, and may be set to the empty string\&.
258 "vsock"
259 may be replaced with
260 "vsock\-stream",
261 "vsock\-dgram"
262 or
263 "vsock\-seqpacket"
264 to force usage of the corresponding socket type\&.
265 .sp
266 Note that
267 \fBSOCK_SEQPACKET\fR
268 (i\&.e\&.
269 \fIListenSequentialPacket=\fR) is only available for
270 \fBAF_UNIX\fR
271 sockets\&.
272 \fBSOCK_STREAM\fR
273 (i\&.e\&.
274 \fIListenStream=\fR) when used for IP sockets refers to TCP sockets,
275 \fBSOCK_DGRAM\fR
276 (i\&.e\&.
277 \fIListenDatagram=\fR) to UDP\&.
278 .sp
279 These options may be specified more than once, in which case incoming traffic on any of the sockets will trigger service activation, and all listed sockets will be passed to the service, regardless of whether there is incoming traffic on them or not\&. If the empty string is assigned to any of these options, the list of addresses to listen on is reset, all prior uses of any of these options will have no effect\&.
280 .sp
281 It is also possible to have more than one socket unit for the same service when using
282 \fIService=\fR, and the service will receive all the sockets configured in all the socket units\&. Sockets configured in one unit are passed in the order of configuration, but no ordering between socket units is specified\&.
283 .sp
284 If an IP address is used here, it is often desirable to listen on it before the interface it is configured on is up and running, and even regardless of whether it will be up and running at any point\&. To deal with this, it is recommended to set the
285 \fIFreeBind=\fR
286 option described below\&.
287 .RE
288 .PP
289 \fIListenFIFO=\fR
290 .RS 4
291 Specifies a file system FIFO (see
292 \fBfifo\fR(7)
293 for details) to listen on\&. This expects an absolute file system path as argument\&. Behavior otherwise is very similar to the
294 \fIListenDatagram=\fR
295 directive above\&.
296 .RE
297 .PP
298 \fIListenSpecial=\fR
299 .RS 4
300 Specifies a special file in the file system to listen on\&. This expects an absolute file system path as argument\&. Behavior otherwise is very similar to the
301 \fIListenFIFO=\fR
302 directive above\&. Use this to open character device nodes as well as special files in
303 /proc/
304 and
305 /sys/\&.
306 .RE
307 .PP
308 \fIListenNetlink=\fR
309 .RS 4
310 Specifies a Netlink family to create a socket for to listen on\&. This expects a short string referring to the
311 \fBAF_NETLINK\fR
312 family name (such as
313 \fIaudit\fR
314 or
315 \fIkobject\-uevent\fR) as argument, optionally suffixed by a whitespace followed by a multicast group integer\&. Behavior otherwise is very similar to the
316 \fIListenDatagram=\fR
317 directive above\&.
318 .RE
319 .PP
320 \fIListenMessageQueue=\fR
321 .RS 4
322 Specifies a POSIX message queue name to listen on (see
323 \fBmq_overview\fR(7)
324 for details)\&. This expects a valid message queue name (i\&.e\&. beginning with
325 "/")\&. Behavior otherwise is very similar to the
326 \fIListenFIFO=\fR
327 directive above\&. On Linux message queue descriptors are actually file descriptors and can be inherited between processes\&.
328 .RE
329 .PP
330 \fIListenUSBFunction=\fR
331 .RS 4
332 Specifies a
333 \m[blue]\fBUSB FunctionFS\fR\m[]\&\s-2\u[1]\d\s+2
334 endpoints location to listen on, for implementation of USB gadget functions\&. This expects an absolute file system path of a FunctionFS mount point as the argument\&. Behavior otherwise is very similar to the
335 \fIListenFIFO=\fR
336 directive above\&. Use this to open the FunctionFS endpoint
337 ep0\&. When using this option, the activated service has to have the
338 \fIUSBFunctionDescriptors=\fR
339 and
340 \fIUSBFunctionStrings=\fR
341 options set\&.
342 .sp
343 Added in version 227\&.
344 .RE
345 .PP
346 \fISocketProtocol=\fR
347 .RS 4
348 Takes one of
349 \fBudplite\fR,
350 \fBsctp\fR
351 or
352 \fBmptcp\fR\&. The socket will use the UDP\-Lite (\fBIPPROTO_UDPLITE\fR), SCTP (\fBIPPROTO_SCTP\fR) or MPTCP (\fBIPPROTO_MPTCP\fR) protocol, respectively\&.
353 .sp
354 Added in version 229\&.
355 .RE
356 .PP
357 \fIBindIPv6Only=\fR
358 .RS 4
359 Takes one of
360 \fBdefault\fR,
361 \fBboth\fR
362 or
363 \fBipv6\-only\fR\&. Controls the IPV6_V6ONLY socket option (see
364 \fBipv6\fR(7)
365 for details)\&. If
366 \fBboth\fR, IPv6 sockets bound will be accessible via both IPv4 and IPv6\&. If
367 \fBipv6\-only\fR, they will be accessible via IPv6 only\&. If
368 \fBdefault\fR
369 (which is the default, surprise!), the system wide default setting is used, as controlled by
370 /proc/sys/net/ipv6/bindv6only, which in turn defaults to the equivalent of
371 \fBboth\fR\&.
372 .RE
373 .PP
374 \fIBacklog=\fR
375 .RS 4
376 Takes an unsigned 32\-bit integer argument\&. Specifies the number of connections to queue that have not been accepted yet\&. This setting matters only for stream and sequential packet sockets\&. See
377 \fBlisten\fR(2)
378 for details\&. Defaults to 4294967295\&. Note that this value is silently capped by the
379 "net\&.core\&.somaxconn"
380 sysctl, which typically defaults to 4096, so typically the sysctl is the setting that actually matters\&.
381 .RE
382 .PP
383 \fIBindToDevice=\fR
384 .RS 4
385 Specifies a network interface name to bind this socket to\&. If set, traffic will only be accepted from the specified network interfaces\&. This controls the
386 \fBSO_BINDTODEVICE\fR
387 socket option (see
388 \fBsocket\fR(7)
389 for details)\&. If this option is used, an implicit dependency from this socket unit on the network interface device unit is created (see
390 \fBsystemd.device\fR(5))\&. Note that setting this parameter might result in additional dependencies to be added to the unit (see above)\&.
391 .RE
392 .PP
393 \fISocketUser=\fR, \fISocketGroup=\fR
394 .RS 4
395 Takes a UNIX user/group name\&. When specified, all
396 \fBAF_UNIX\fR
397 sockets, FIFO nodes, and message queues are owned by the specified user and group\&. If unset (the default), the nodes are owned by the root user/group (if run in system context) or the invoking user/group (if run in user context)\&. If only a user is specified but no group, then the group is derived from the user\*(Aqs default group\&.
398 .sp
399 Added in version 214\&.
400 .RE
401 .PP
402 \fISocketMode=\fR
403 .RS 4
404 If listening on a file system socket, FIFO, or message queue, this option specifies the file system access mode used when creating the file node\&. Takes an access mode in octal notation\&. Defaults to 0666\&.
405 .RE
406 .PP
407 \fIDirectoryMode=\fR
408 .RS 4
409 If listening on a file system socket or FIFO, the parent directories are automatically created if needed\&. This option specifies the file system access mode used when creating these directories\&. Takes an access mode in octal notation\&. Defaults to 0755\&.
410 .RE
411 .PP
412 \fIAccept=\fR
413 .RS 4
414 Takes a boolean argument\&. If yes, a service instance is spawned for each incoming connection and only the connection socket is passed to it\&. If no, all listening sockets themselves are passed to the started service unit, and only one service unit is spawned for all connections (also see above)\&. This value is ignored for datagram sockets and FIFOs where a single service unit unconditionally handles all incoming traffic\&. Defaults to
415 \fBno\fR\&.
416 .sp
417 Typically, for performance sensitive services, a choice of
418 \fBAccept=no\fR
419 is preferable, since that way only the first connection will have to pay the activation resource cost\&. On the other hand, for sporadically used services
420 \fBAccept=yes\fR
421 can be preferable as it simplifies the implementation (as the service program code only has to process a single connection instead of handling multiple) and enables stronger security (since the various sandboxing options can be used to isolate parallel connections from each other, as each is serviced by a separate service instance and process)\&.
422 .sp
423 A service listening on an
424 \fBAF_UNIX\fR
425 socket may, but does not need to, call
426 \fBclose\fR(2)
427 on the received socket before exiting\&. However, it must not unlink the socket from a file system\&. It should not invoke
428 \fBshutdown\fR(2)
429 on sockets it got with
430 \fIAccept=no\fR, but it may do so for sockets it got with
431 \fIAccept=yes\fR
432 set\&.
433 .sp
434 Setting
435 \fIAccept=yes\fR
436 is in particular useful for allowing daemons designed for usage with
437 \fBinetd\fR(8)
438 to work unmodified with systemd socket activation\&.
439 .sp
440 Note that depending on this setting the services activated by units of this type are either regular services (in case of
441 \fIAccept=\fR\fBno\fR) or instances of templated services (in case of
442 \fIAccept=\fR\fByes\fR)\&. See the Description section above for a more detailed discussion of the naming rules of triggered services\&.
443 .sp
444 For IPv4 and IPv6 connections, the
445 \fI$REMOTE_ADDR\fR
446 environment variable will contain the remote IP address, and
447 \fI$REMOTE_PORT\fR
448 will contain the remote port number\&. These two variables correspond to those defined by the CGI interface for web services (see
449 \m[blue]\fBRFC 3875\fR\m[]\&\s-2\u[2]\d\s+2)\&.
450 .sp
451 For
452 \fBAF_UNIX\fR
453 socket connections, the
454 \fI$REMOTE_ADDR\fR
455 environment variable will contain either the remote socket\*(Aqs file system path starting with a slash ("/") or its address in the abstract namespace starting with an at symbol ("@")\&. If the socket is unnamed,
456 \fI$REMOTE_ADDR\fR
457 will not be set\&.
458 .sp
459 If
460 \fIAccept=yes\fR
461 is used, the activated service process will have set the
462 \fI$SO_COOKIE\fR
463 environment variable to the Linux socket cookie, formatted as decimal integer\&. The socket cookie can otherwise be acquired via
464 \fBgetsockopt\fR(7)\&.
465 .sp
466 It is recommended to set
467 \fICollectMode=inactive\-or\-failed\fR
468 for service instances activated via
469 \fIAccept=yes\fR, to ensure that failed connection services are cleaned up and released from memory, and do not accumulate\&.
470 .RE
471 .PP
472 \fIWritable=\fR
473 .RS 4
474 Takes a boolean argument\&. May only be used in conjunction with
475 \fIListenSpecial=\fR\&. If true, the specified special file is opened in read\-write mode, if false, in read\-only mode\&. Defaults to false\&.
476 .sp
477 Added in version 227\&.
478 .RE
479 .PP
480 \fIFlushPending=\fR
481 .RS 4
482 Takes a boolean argument\&. May only be used when
483 \fBAccept=no\fR\&. If yes, the socket\*(Aqs buffers are cleared after the triggered service exited\&. This causes any pending data to be flushed and any pending incoming connections to be rejected\&. If no, the socket\*(Aqs buffers will not be cleared, permitting the service to handle any pending connections after restart, which is the usually expected behaviour\&. Defaults to
484 \fBno\fR\&.
485 .sp
486 Added in version 247\&.
487 .RE
488 .PP
489 \fIMaxConnections=\fR
490 .RS 4
491 The maximum number of connections to simultaneously run services instances for, when
492 \fBAccept=yes\fR
493 is set\&. If more concurrent connections are coming in, they will be refused until at least one existing connection is terminated\&. This setting has no effect on sockets configured with
494 \fBAccept=no\fR
495 or datagram sockets\&. Defaults to 64\&.
496 .RE
497 .PP
498 \fIMaxConnectionsPerSource=\fR
499 .RS 4
500 The maximum number of connections for a service per source IP address (in case of IPv4/IPv6), per source CID (in case of
501 \fBAF_VSOCK\fR), or source UID (in case of
502 \fBAF_UNIX\fR)\&. This is very similar to the
503 \fIMaxConnections=\fR
504 directive above\&. Defaults to 0, i\&.e\&. disabled\&.
505 .sp
506 Added in version 232\&.
507 .RE
508 .PP
509 \fIKeepAlive=\fR
510 .RS 4
511 Takes a boolean argument\&. If true, the TCP/IP stack will send a keep alive message after 2h (depending on the configuration of
512 /proc/sys/net/ipv4/tcp_keepalive_time) for all TCP streams accepted on this socket\&. This controls the
513 \fBSO_KEEPALIVE\fR
514 socket option (see
515 \fBsocket\fR(7)
516 and the
517 \m[blue]\fBTCP Keepalive HOWTO\fR\m[]\&\s-2\u[3]\d\s+2
518 for details\&.) Defaults to
519 \fBfalse\fR\&.
520 .RE
521 .PP
522 \fIKeepAliveTimeSec=\fR
523 .RS 4
524 Takes time (in seconds) as argument\&. The connection needs to remain idle before TCP starts sending keepalive probes\&. This controls the TCP_KEEPIDLE socket option (see
525 \fBsocket\fR(7)
526 and the
527 \m[blue]\fBTCP Keepalive HOWTO\fR\m[]\&\s-2\u[3]\d\s+2
528 for details\&.) Default value is 7200 seconds (2 hours)\&.
529 .sp
530 Added in version 216\&.
531 .RE
532 .PP
533 \fIKeepAliveIntervalSec=\fR
534 .RS 4
535 Takes time (in seconds) as argument between individual keepalive probes, if the socket option
536 \fBSO_KEEPALIVE\fR
537 has been set on this socket\&. This controls the
538 \fBTCP_KEEPINTVL\fR
539 socket option (see
540 \fBsocket\fR(7)
541 and the
542 \m[blue]\fBTCP Keepalive HOWTO\fR\m[]\&\s-2\u[3]\d\s+2
543 for details\&.) Default value is 75 seconds\&.
544 .sp
545 Added in version 216\&.
546 .RE
547 .PP
548 \fIKeepAliveProbes=\fR
549 .RS 4
550 Takes an integer as argument\&. It is the number of unacknowledged probes to send before considering the connection dead and notifying the application layer\&. This controls the TCP_KEEPCNT socket option (see
551 \fBsocket\fR(7)
552 and the
553 \m[blue]\fBTCP Keepalive HOWTO\fR\m[]\&\s-2\u[3]\d\s+2
554 for details\&.) Default value is 9\&.
555 .sp
556 Added in version 216\&.
557 .RE
558 .PP
559 \fINoDelay=\fR
560 .RS 4
561 Takes a boolean argument\&. TCP Nagle\*(Aqs algorithm works by combining a number of small outgoing messages, and sending them all at once\&. This controls the TCP_NODELAY socket option (see
562 \fBtcp\fR(7))\&. Defaults to
563 \fBfalse\fR\&.
564 .sp
565 Added in version 216\&.
566 .RE
567 .PP
568 \fIPriority=\fR
569 .RS 4
570 Takes an integer argument controlling the priority for all traffic sent from this socket\&. This controls the
571 \fBSO_PRIORITY\fR
572 socket option (see
573 \fBsocket\fR(7)
574 for details\&.)\&.
575 .RE
576 .PP
577 \fIDeferAcceptSec=\fR
578 .RS 4
579 Takes time (in seconds) as argument\&. If set, the listening process will be awakened only when data arrives on the socket, and not immediately when connection is established\&. When this option is set, the
580 \fBTCP_DEFER_ACCEPT\fR
581 socket option will be used (see
582 \fBtcp\fR(7)), and the kernel will ignore initial ACK packets without any data\&. The argument specifies the approximate amount of time the kernel should wait for incoming data before falling back to the normal behavior of honoring empty ACK packets\&. This option is beneficial for protocols where the client sends the data first (e\&.g\&. HTTP, in contrast to SMTP), because the server process will not be woken up unnecessarily before it can take any action\&.
583 .sp
584 If the client also uses the
585 \fBTCP_DEFER_ACCEPT\fR
586 option, the latency of the initial connection may be reduced, because the kernel will send data in the final packet establishing the connection (the third packet in the "three\-way handshake")\&.
587 .sp
588 Disabled by default\&.
589 .sp
590 Added in version 216\&.
591 .RE
592 .PP
593 \fIReceiveBuffer=\fR, \fISendBuffer=\fR
594 .RS 4
595 Takes an integer argument controlling the receive or send buffer sizes of this socket, respectively\&. This controls the
596 \fBSO_RCVBUF\fR
597 and
598 \fBSO_SNDBUF\fR
599 socket options (see
600 \fBsocket\fR(7)
601 for details\&.)\&. The usual suffixes K, M, G are supported and are understood to the base of 1024\&.
602 .RE
603 .PP
604 \fIIPTOS=\fR
605 .RS 4
606 Takes an integer argument controlling the IP Type\-Of\-Service field for packets generated from this socket\&. This controls the
607 \fBIP_TOS\fR
608 socket option (see
609 \fBip\fR(7)
610 for details\&.)\&. Either a numeric string or one of
611 \fBlow\-delay\fR,
612 \fBthroughput\fR,
613 \fBreliability\fR
614 or
615 \fBlow\-cost\fR
616 may be specified\&.
617 .RE
618 .PP
619 \fIIPTTL=\fR
620 .RS 4
621 Takes an integer argument controlling the IPv4 Time\-To\-Live/IPv6 Hop\-Count field for packets generated from this socket\&. This sets the
622 \fBIP_TTL\fR/\fBIPV6_UNICAST_HOPS\fR
623 socket options (see
624 \fBip\fR(7)
625 and
626 \fBipv6\fR(7)
627 for details\&.)
628 .RE
629 .PP
630 \fIMark=\fR
631 .RS 4
632 Takes an integer value\&. Controls the firewall mark of packets generated by this socket\&. This can be used in the firewall logic to filter packets from this socket\&. This sets the
633 \fBSO_MARK\fR
634 socket option\&. See
635 \fBiptables\fR(8)
636 for details\&.
637 .RE
638 .PP
639 \fIReusePort=\fR
640 .RS 4
641 Takes a boolean value\&. If true, allows multiple
642 \fBbind\fR(2)s to this TCP or UDP port\&. This controls the
643 \fBSO_REUSEPORT\fR
644 socket option\&. See
645 \fBsocket\fR(7)
646 for details\&.
647 .sp
648 Added in version 206\&.
649 .RE
650 .PP
651 \fISmackLabel=\fR, \fISmackLabelIPIn=\fR, \fISmackLabelIPOut=\fR
652 .RS 4
653 Takes a string value\&. Controls the extended attributes
654 "security\&.SMACK64",
655 "security\&.SMACK64IPIN"
656 and
657 "security\&.SMACK64IPOUT", respectively, i\&.e\&. the security label of the FIFO, or the security label for the incoming or outgoing connections of the socket, respectively\&. See
658 \m[blue]\fBSmack\fR\m[]\&\s-2\u[4]\d\s+2
659 for details\&.
660 .sp
661 Added in version 196\&.
662 .RE
663 .PP
664 \fISELinuxContextFromNet=\fR
665 .RS 4
666 Takes a boolean argument\&. When true, systemd will attempt to figure out the SELinux label used for the instantiated service from the information handed by the peer over the network\&. Note that only the security level is used from the information provided by the peer\&. Other parts of the resulting SELinux context originate from either the target binary that is effectively triggered by socket unit or from the value of the
667 \fISELinuxContext=\fR
668 option\&. This configuration option applies only when activated service is passed in single socket file descriptor, i\&.e\&. service instances that have standard input connected to a socket or services triggered by exactly one socket unit\&. Also note that this option is useful only when MLS/MCS SELinux policy is deployed\&. Defaults to
669 "false"\&.
670 .sp
671 Added in version 217\&.
672 .RE
673 .PP
674 \fIPipeSize=\fR
675 .RS 4
676 Takes a size in bytes\&. Controls the pipe buffer size of FIFOs configured in this socket unit\&. See
677 \fBfcntl\fR(2)
678 for details\&. The usual suffixes K, M, G are supported and are understood to the base of 1024\&.
679 .RE
680 .PP
681 \fIMessageQueueMaxMessages=\fR, \fIMessageQueueMessageSize=\fR
682 .RS 4
683 These two settings take integer values and control the mq_maxmsg field or the mq_msgsize field, respectively, when creating the message queue\&. Note that either none or both of these variables need to be set\&. See
684 \fBmq_setattr\fR(3)
685 for details\&.
686 .RE
687 .PP
688 \fIFreeBind=\fR
689 .RS 4
690 Takes a boolean value\&. Controls whether the socket can be bound to non\-local IP addresses\&. This is useful to configure sockets listening on specific IP addresses before those IP addresses are successfully configured on a network interface\&. This sets the
691 \fBIP_FREEBIND\fR/\fBIPV6_FREEBIND\fR
692 socket option\&. For robustness reasons it is recommended to use this option whenever you bind a socket to a specific IP address\&. Defaults to
693 \fBfalse\fR\&.
694 .RE
695 .PP
696 \fITransparent=\fR
697 .RS 4
698 Takes a boolean value\&. Controls the
699 \fBIP_TRANSPARENT\fR/\fBIPV6_TRANSPARENT\fR
700 socket option\&. Defaults to
701 \fBfalse\fR\&.
702 .RE
703 .PP
704 \fIBroadcast=\fR
705 .RS 4
706 Takes a boolean value\&. This controls the
707 \fBSO_BROADCAST\fR
708 socket option, which allows broadcast datagrams to be sent from this socket\&. Defaults to
709 \fBfalse\fR\&.
710 .RE
711 .PP
712 \fIPassCredentials=\fR
713 .RS 4
714 Takes a boolean value\&. This controls the
715 \fBSO_PASSCRED\fR
716 socket option, which allows
717 \fBAF_UNIX\fR
718 sockets to receive the credentials of the sending process in an ancillary message\&. Defaults to
719 \fBfalse\fR\&.
720 .RE
721 .PP
722 \fIPassPIDFD=\fR
723 .RS 4
724 Takes a boolean value\&. This controls the
725 \fBSO_PASSPIDFD\fR
726 socket option, which allows
727 \fBAF_UNIX\fR
728 sockets to receive the pidfd of the sending process in an ancillary message\&. Defaults to
729 \fBfalse\fR\&.
730 .sp
731 Added in version 258\&.
732 .RE
733 .PP
734 \fIPassSecurity=\fR
735 .RS 4
736 Takes a boolean value\&. This controls the
737 \fBSO_PASSSEC\fR
738 socket option, which allows
739 \fBAF_UNIX\fR
740 sockets to receive the security context of the sending process in an ancillary message\&. Defaults to
741 \fBfalse\fR\&.
742 .RE
743 .PP
744 \fIPassPacketInfo=\fR
745 .RS 4
746 Takes a boolean value\&. This controls the
747 \fBIP_PKTINFO\fR,
748 \fBIPV6_RECVPKTINFO\fR,
749 \fBNETLINK_PKTINFO\fR
750 or
751 \fBPACKET_AUXDATA\fR
752 socket options, which enable reception of additional per\-packet metadata as ancillary message, on
753 \fBAF_INET\fR,
754 \fBAF_INET6\fR,
755 \fBAF_UNIX\fR
756 and
757 \fBAF_PACKET\fR
758 sockets\&. Defaults to
759 \fBfalse\fR\&.
760 .sp
761 Added in version 246\&.
762 .RE
763 .PP
764 \fIAcceptFileDescriptors=\fR
765 .RS 4
766 Takes a boolean value\&. This controls the
767 \fBSO_PASSRIGHTS\fR
768 socket option, which when disabled prohibits the peer from sending
769 \fBSCM_RIGHTS\fR
770 ancillary messages (aka file descriptors) via
771 \fBAF_UNIX\fR
772 sockets\&. Defaults to
773 \fBtrue\fR\&.
774 .sp
775 Added in version 258\&.
776 .RE
777 .PP
778 \fITimestamping=\fR
779 .RS 4
780 Takes one of
781 "off",
782 "us"
783 (alias:
784 "usec",
785 "μs") or
786 "ns"
787 (alias:
788 "nsec")\&. This controls the
789 \fBSO_TIMESTAMP\fR
790 or
791 \fBSO_TIMESTAMPNS\fR
792 socket options, and enables whether ingress network traffic shall carry timestamping metadata\&. Defaults to
793 \fBoff\fR\&.
794 .sp
795 Added in version 247\&.
796 .RE
797 .PP
798 \fITCPCongestion=\fR
799 .RS 4
800 Takes a string value\&. Controls the TCP congestion algorithm used by this socket\&. Should be one of
801 "westwood",
802 "reno",
803 "cubic",
804 "lp"
805 or any other available algorithm supported by the IP stack\&. This setting applies only to stream sockets\&.
806 .RE
807 .PP
808 \fIExecStartPre=\fR, \fIExecStartPost=\fR
809 .RS 4
810 Takes one or more command lines, which are executed before or after the listening sockets/FIFOs are created and bound, respectively\&. The first token of the command line must be an absolute filename, then followed by arguments for the process\&. Multiple command lines may be specified following the same scheme as used for
811 \fIExecStartPre=\fR
812 of service unit files\&.
813 .RE
814 .PP
815 \fIExecStopPre=\fR, \fIExecStopPost=\fR
816 .RS 4
817 Additional commands that are executed before or after the listening sockets/FIFOs are closed and removed, respectively\&. Multiple command lines may be specified following the same scheme as used for
818 \fIExecStartPre=\fR
819 of service unit files\&.
820 .RE
821 .PP
822 \fITimeoutSec=\fR
823 .RS 4
824 Configures the time to wait for the commands specified in
825 \fIExecStartPre=\fR,
826 \fIExecStartPost=\fR,
827 \fIExecStopPre=\fR
828 and
829 \fIExecStopPost=\fR
830 to finish\&. If a command does not exit within the configured time, the socket will be considered failed and be shut down again\&. All commands still running will be terminated forcibly via
831 \fBSIGTERM\fR, and after another delay of this time with
832 \fBSIGKILL\fR\&. (See
833 \fBKillMode=\fR
834 in
835 \fBsystemd.kill\fR(5)\&.) Takes a unit\-less value in seconds, or a time span value such as "5min 20s"\&. Pass
836 "0"
837 to disable the timeout logic\&. Defaults to
838 \fIDefaultTimeoutStartSec=\fR
839 from the manager configuration file (see
840 \fBsystemd-system.conf\fR(5))\&.
841 .RE
842 .PP
843 \fIService=\fR
844 .RS 4
845 Specifies the service unit name to activate on incoming traffic\&. This setting is only allowed for sockets with
846 \fIAccept=no\fR\&. It defaults to the service that bears the same name as the socket (with the suffix replaced)\&. In most cases, it should not be necessary to use this option\&. Note that setting this parameter might result in additional dependencies to be added to the unit (see above)\&.
847 .RE
848 .PP
849 \fIRemoveOnStop=\fR
850 .RS 4
851 Takes a boolean argument\&. If enabled, any file nodes created by this socket unit are removed when it is stopped\&. This applies to
852 \fBAF_UNIX\fR
853 sockets in the file system, POSIX message queues, FIFOs, as well as any symlinks to them configured with
854 \fISymlinks=\fR\&. Normally, it should not be necessary to use this option, and is not recommended as services might continue to run after the socket unit has been terminated and it should still be possible to communicate with them via their file system node\&. Defaults to off\&.
855 .sp
856 Added in version 214\&.
857 .RE
858 .PP
859 \fISymlinks=\fR
860 .RS 4
861 Takes a list of file system paths\&. The specified paths will be created as symlinks to the
862 \fBAF_UNIX\fR
863 socket path or FIFO path of this socket unit\&. If this setting is used, only one
864 \fBAF_UNIX\fR
865 socket in the file system or one FIFO may be configured for the socket unit\&. Use this option to manage one or more symlinked alias names for a socket, binding their lifecycle together\&. Note that if creation of a symlink fails this is not considered fatal for the socket unit, and the socket unit may still start\&. If an empty string is assigned, the list of paths is reset\&. Defaults to an empty list\&.
866 .sp
867 Added in version 214\&.
868 .RE
869 .PP
870 \fIFileDescriptorName=\fR
871 .RS 4
872 Assigns a name to all file descriptors this socket unit encapsulates\&. This is useful to help activated services identify specific file descriptors, if multiple fds are passed\&. Services may use the
873 \fBsd_listen_fds_with_names\fR(3)
874 call to acquire the names configured for the received file descriptors\&. Names may contain any ASCII character, but must exclude control characters and
875 ":", and must be at most 255 characters in length\&. If this setting is not used, the file descriptor name defaults to the name of the socket unit (including its
876 \&.socket
877 suffix) when
878 \fIAccept=no\fR,
879 "connection"
880 otherwise\&.
881 .sp
882 Added in version 227\&.
883 .RE
884 .PP
885 \fITriggerLimitIntervalSec=\fR, \fITriggerLimitBurst=\fR
886 .RS 4
887 Configures a limit on how often this socket unit may be activated within a specific time interval\&. The
888 \fITriggerLimitIntervalSec=\fR
889 setting may be used to configure the length of the time interval in the usual time units
890 "us",
891 "ms",
892 "s",
893 "min",
894 "h", \&... and defaults to 2s (See
895 \fBsystemd.time\fR(7)
896 for details on the various time units understood)\&. The
897 \fITriggerLimitBurst=\fR
898 setting takes a positive integer value and specifies the number of permitted activations per time interval, and defaults to 200 for
899 \fIAccept=yes\fR
900 sockets (thus by default permitting 200 activations per 2s), and 20 otherwise (20 activations per 2s)\&. Set either to 0 to disable any form of trigger rate limiting\&.
901 .sp
902 If the limit is hit, the socket unit is placed into a failure mode, and will not be connectible anymore until restarted\&. Note that this limit is enforced before the service activation is enqueued\&.
903 .sp
904 Compare with
905 \fIPollLimitIntervalSec=\fR/\fIPollLimitBurst=\fR
906 described below, which implements a temporary slowdown if a socket unit is flooded with incoming traffic, as opposed to the permanent failure state
907 \fITriggerLimitIntervalSec=\fR/\fITriggerLimitBurst=\fR
908 results in\&.
909 .sp
910 Added in version 230\&.
911 .RE
912 .PP
913 \fIPollLimitIntervalSec=\fR, \fIPollLimitBurst=\fR
914 .RS 4
915 Configures a limit on how often polling events on the file descriptors backing this socket unit will be considered\&. This pair of settings is similar to
916 \fITriggerLimitIntervalSec=\fR/\fITriggerLimitBurst=\fR
917 but instead of putting a (fatal) limit on the activation frequency puts a (transient) limit on the polling frequency\&. The expected parameter syntax and range are identical to that of the aforementioned options, and can be disabled the same way\&.
918 .sp
919 If the polling limit is hit polling is temporarily disabled on it until the specified time window passes\&. The polling limit hence slows down connection attempts if hit, but unlike the trigger limit will not cause permanent failures\&. It\*(Aqs the recommended mechanism to deal with DoS attempts through packet flooding\&.
920 .sp
921 The polling limit is enforced per file descriptor to listen on, as opposed to the trigger limit which is enforced for the entire socket unit\&. This distinction matters for socket units that listen on multiple file descriptors (i\&.e\&. have multiple
922 \fIListenXYZ=\fR
923 stanzas)\&.
924 .sp
925 These setting defaults to 150 (in case of
926 \fIAccept=yes\fR) and 15 (otherwise) polling events per 2s\&. This is considerably lower than the default values for the trigger limit (see above) and means that the polling limit should typically ensure the trigger limit is never hit, unless one of them is reconfigured or disabled\&.
927 .sp
928 Added in version 255\&.
929 .RE
930 .PP
931 \fIDeferTrigger=\fR
932 .RS 4
933 Takes a boolean argument, or
934 "patient"\&. May only be used when
935 \fIAccept=no\fR\&. If enabled, job mode
936 "lenient"
937 instead of
938 "replace"
939 is used when triggering the service, which means currently activating/running units that conflict with the service won\*(Aqt be disturbed/brought down\&. Furthermore, if a conflict exists, the socket unit will wait for current job queue to complete and potentially defer the activation by then\&. An upper limit of total time to wait can be configured via
940 \fIDeferTriggerMaxSec=\fR\&. If set to
941 \fByes\fR, the socket unit will fail if all jobs have finished or the timeout has been reached but the conflict remains\&. If
942 \fBpatient\fR, always wait until
943 \fIDeferTriggerMaxSec=\fR
944 elapses\&. Defaults to no\&.
945 .sp
946 This setting is particularly useful if the socket unit should stay active across switch\-root/soft\-reboot operations while the triggered service is stopped\&.
947 .sp
948 Added in version 258\&.
949 .RE
950 .PP
951 \fIDeferTriggerMaxSec=\fR
952 .RS 4
953 Configures the maximum time to defer the triggering when
954 \fIDeferTrigger=\fR
955 is enabled\&. If the service cannot be activated within the specified time, the socket will be considered failed and get terminated\&. Takes a unit\-less value in seconds, or a time span value such as "5min 20s"\&. Pass
956 "0"
957 or
958 "infinity"
959 to disable the timeout logic (the default)\&.
960 .sp
961 Added in version 258\&.
962 .RE
963 .PP
964 \fIPassFileDescriptorsToExec=\fR
965 .RS 4
966 Takes a boolean argument\&. Defaults to off\&. If enabled, file descriptors created by the socket unit are passed to
967 \fIExecStartPost=\fR,
968 \fIExecStopPre=\fR, and
969 \fIExecStopPost=\fR
970 commands from the socket unit\&. The passed file descriptors can be accessed with
971 \fBsd_listen_fds\fR(3)
972 as if the commands were invoked from the associated service units\&. Note that
973 \fIExecStartPre=\fR
974 command cannot access socket file descriptors\&.
975 .sp
976 Added in version 256\&.
977 .RE
978 .PP
979 Check
980 \fBsystemd.unit\fR(5),
981 \fBsystemd.exec\fR(5), and
982 \fBsystemd.kill\fR(5)
983 for more settings\&.
984 .SH "SEE ALSO"
985 .PP
986 \fBsystemd\fR(1), \fBsystemctl\fR(1), \fBsystemd-system.conf\fR(5), \fBsystemd.unit\fR(5), \fBsystemd.exec\fR(5), \fBsystemd.kill\fR(5), \fBsystemd.resource-control\fR(5), \fBsystemd.service\fR(5), \fBsystemd.directives\fR(7), \fBsd_listen_fds\fR(3), \fBsd_listen_fds_with_names\fR(3)
987 .PP
988 For more extensive descriptions see the "systemd for Developers" series:
989 \m[blue]\fBSocket Activation\fR\m[]\&\s-2\u[5]\d\s+2, \m[blue]\fBSocket Activation, part II\fR\m[]\&\s-2\u[6]\d\s+2, \m[blue]\fBConverting inetd Services\fR\m[]\&\s-2\u[7]\d\s+2, \m[blue]\fBSocket Activated Internet Services and OS Containers\fR\m[]\&\s-2\u[8]\d\s+2\&.
990 .SH "NOTES"
991 .IP " 1." 4
992 USB FunctionFS
993 .RS 4
994 \%https://docs.kernel.org/usb/functionfs.html
995 .RE
996 .IP " 2." 4
997 RFC 3875
998 .RS 4
999 \%https://datatracker.ietf.org/doc/html/rfc3875
1000 .RE
1001 .IP " 3." 4
1002 TCP Keepalive HOWTO
1003 .RS 4
1004 \%http://www.tldp.org/HOWTO/html_single/TCP-Keepalive-HOWTO/
1005 .RE
1006 .IP " 4." 4
1007 Smack
1008 .RS 4
1009 \%https://docs.kernel.org/admin-guide/LSM/Smack.html
1010 .RE
1011 .IP " 5." 4
1012 Socket Activation
1013 .RS 4
1014 \%https://0pointer.de/blog/projects/socket-activation.html
1015 .RE
1016 .IP " 6." 4
1017 Socket Activation, part II
1018 .RS 4
1019 \%https://0pointer.de/blog/projects/socket-activation2.html
1020 .RE
1021 .IP " 7." 4
1022 Converting inetd Services
1023 .RS 4
1024 \%https://0pointer.de/blog/projects/inetd.html
1025 .RE
1026 .IP " 8." 4
1027 Socket Activated Internet Services and OS Containers
1028 .RS 4
1029 \%https://0pointer.de/blog/projects/socket-activated-containers.html
1030 .RE