{"id":3370,"date":"2022-12-20T17:02:28","date_gmt":"2022-12-20T20:02:28","guid":{"rendered":"http:\/\/lode.uno\/linux-man\/index.php\/2022\/12\/20\/systemdsocketproxyd-man8\/"},"modified":"2022-12-20T17:02:28","modified_gmt":"2022-12-20T20:02:28","slug":"systemdsocketproxyd-man8","status":"publish","type":"post","link":"https:\/\/lode.uno\/linux-man\/2022\/12\/20\/systemdsocketproxyd-man8\/","title":{"rendered":"SYSTEMD−SOCKET−PROXYD (man8)"},"content":{"rendered":"

SYSTEMD\u2212SOCKET\u2212PROXYD<\/h1>\n

NAME<\/a>
SYNOPSIS<\/a>
DESCRIPTION<\/a>
OPTIONS<\/a>
EXIT STATUS<\/a>
EXAMPLES<\/a>
SEE ALSO<\/a> <\/p>\n

\n

NAME <\/a> <\/h2>\n

systemd-socket-proxyd \u2212 Bidirectionally proxy local sockets to another (possibly remote) socket<\/p>\n

SYNOPSIS <\/a> <\/h2>\n\n\n\n
<\/td>\n\n

systemd\u2212socket\u2212proxyd<\/b> [OPTIONS<\/i>…] HOST<\/i>:PORT<\/i><\/p>\n<\/td>\n<\/tr>\n

<\/td>\n\n

systemd\u2212socket\u2212proxyd<\/b> [OPTIONS<\/i>…] UNIX\u2212DOMAIN\u2212SOCKET\u2212PATH<\/i><\/p>\n<\/td>\n<\/tr>\n<\/table>\n

DESCRIPTION <\/a> <\/h2>\n

systemd\u2212socket\u2212proxyd<\/b><\/i> is a generic socket\u2212activated network socket forwarder proxy daemon for IPv4, IPv6 and UNIX stream sockets. It may be used to bi\u2212directionally forward traffic from a local listening socket to a local or remote destination socket.<\/p>\n

One use of this tool is to provide socket activation support for services that do not natively support socket activation. On behalf of the service to activate, the proxy inherits the socket from systemd, accepts each client connection, opens a connection to a configured server for each client, and then bidirectionally forwards data between the two.<\/p>\n

This utility’s behavior is similar to socat<\/b>(1). The main differences for systemd\u2212socket\u2212proxyd<\/b> are support for socket activation with “Accept=no” and an event\u2212driven design that scales better with the number of connections.<\/p>\n

OPTIONS <\/a> <\/h2>\n

The following options are understood:<\/p>\n

\u2212h<\/b>, \u2212\u2212help<\/b><\/p>\n

Print a short help text and exit.<\/p>\n

\u2212\u2212version<\/b><\/p>\n

Print a short version string and exit.<\/p>\n

\u2212\u2212connections\u2212max=<\/b>, \u2212c<\/b><\/p>\n

Sets the maximum number of simultaneous connections, defaults to 256. If the limit of concurrent connections is reached further connections will be refused.<\/p>\n

\u2212\u2212exit\u2212idle\u2212time=<\/b><\/p>\n

Sets the time before exiting when there are no connections, defaults to infinity<\/b>. Takes a unit\u2212less value in seconds, or a time span value such as “5min 20s”.<\/p>\n

EXIT STATUS <\/a> <\/h2>\n

On success, 0 is returned, a non\u2212zero failure code otherwise.<\/p>\n

EXAMPLES <\/a> <\/h2>\n

Simple Example<\/b>
Use two services with a dependency and no namespace isolation.<\/p>\n

Example\u00a01.\u00a0proxy\u2212to\u2212nginx.socket<\/b><\/p>\n

[Socket]
ListenStream=80<\/p>\n

[Install]
WantedBy=sockets.target<\/p>\n

Example\u00a02.\u00a0proxy\u2212to\u2212nginx.service<\/b><\/p>\n

[Unit]
Requires=nginx.service
After=nginx.service
Requires=proxy\u2212to\u2212nginx.socket
After=proxy\u2212to\u2212nginx.socket<\/p>\n

[Service]
ExecStart=\/usr\/lib\/systemd\/systemd\u2212socket\u2212proxyd \/run\/nginx\/socket
PrivateTmp=yes
PrivateNetwork=yes<\/p>\n

Example\u00a03.\u00a0nginx.conf<\/b><\/p>\n

[…]
server {
listen unix:\/run\/nginx\/socket;
[…]<\/p>\n

Example\u00a04.\u00a0Enabling the proxy<\/b><\/p>\n

# systemctl enable \u2212\u2212now proxy\u2212to\u2212nginx.socket
$ curl http:\/\/localhost:80\/<\/p>\n

If nginx.service has StopWhenUnneeded=<\/i> set, then passing \u2212\u2212exit\u2212idle\u2212time=<\/b> to systemd\u2212socket\u2212proxyd<\/b> allows both services to stop during idle periods.<\/p>\n

Namespace Example<\/b>
Similar as above, but runs the socket proxy and the main service in the same private namespace, assuming that nginx.service has PrivateTmp=<\/i> and PrivateNetwork=<\/i> set, too.<\/p>\n

Example\u00a05.\u00a0proxy\u2212to\u2212nginx.socket<\/b><\/p>\n

[Socket]
ListenStream=80<\/p>\n

[Install]
WantedBy=sockets.target<\/p>\n

Example\u00a06.\u00a0proxy\u2212to\u2212nginx.service<\/b><\/p>\n

[Unit]
Requires=nginx.service
After=nginx.service
Requires=proxy\u2212to\u2212nginx.socket
After=proxy\u2212to\u2212nginx.socket
JoinsNamespaceOf=nginx.service<\/p>\n

[Service]
ExecStart=\/usr\/lib\/systemd\/systemd\u2212socket\u2212proxyd 127.0.0.1:8080
PrivateTmp=yes
PrivateNetwork=yes<\/p>\n

Example\u00a07.\u00a0nginx.conf<\/b><\/p>\n

[…]
server {
listen 8080;
[…]<\/p>\n

Example\u00a08.\u00a0Enabling the proxy<\/b><\/p>\n

# systemctl enable \u2212\u2212now proxy\u2212to\u2212nginx.socket
$ curl http:\/\/localhost:80\/<\/p>\n

SEE ALSO <\/a> <\/h2>\n

systemd<\/b>(1), systemd.socket<\/b>(5), systemd.service<\/b>(5), systemctl<\/b>(1), socat<\/b>(1), nginx<\/b>(1), curl<\/b>(1)<\/p>\n

\n","protected":false},"excerpt":{"rendered":"

systemd-socket-proxyd \u2212 Bidirectionally proxy local sockets to another (possibly remote) socket <\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[2],"tags":[5,52,4,498],"class_list":["post-3370","post","type-post","status-publish","format-standard","hentry","category-8-administracion-del-sistema","tag-5","tag-administracion","tag-man8","tag-systemd-socket-proxyd"],"gutentor_comment":0,"_links":{"self":[{"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/posts\/3370","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/comments?post=3370"}],"version-history":[{"count":0,"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/posts\/3370\/revisions"}],"wp:attachment":[{"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/media?parent=3370"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/categories?post=3370"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/tags?post=3370"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}