X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fsystemd-socket-proxyd.xml;h=1c78b656e174100360b5396b8852da237c2aa025;hb=dab2bce81ed3e97d059d56e66f560aa25d9c2d63;hp=d17c86e479612c9e0aaf5ad0d5e4a2de8f4c87ce;hpb=202e6abb3d0959d8051d514ae48a140934a30f47;p=elogind.git
diff --git a/man/systemd-socket-proxyd.xml b/man/systemd-socket-proxyd.xml
index d17c86e47..1c78b656e 100644
--- a/man/systemd-socket-proxyd.xml
+++ b/man/systemd-socket-proxyd.xml
@@ -20,235 +20,172 @@
You should have received a copy of the GNU Lesser General Public License
along with systemd; If not, see .
-->
-
-
- systemd-socket-proxyd
- systemd
-
-
- Developer
- David
- Strauss
- david@davidstrauss.net
-
-
-
-
- systemd-socket-proxyd
- 1
-
-
- systemd-socket-proxyd
- Inherit a socket. Bidirectionally
- proxy.
-
-
-
- systemd-socket-proxyd
- OPTIONS
- HOSTNAME-OR-IPADDR
- PORT-OR-SERVICE
-
-
- systemd-socket-proxyd
- OPTIONS
- UNIX-DOMAIN-SOCKET-PATH
-
-
-
-
- Description
-
- systemd-socket-proxyd provides a proxy
- to socket-activate services that do not yet support
- native socket activation. On behalf of the daemon,
- the proxy inherits the socket from systemd, accepts
- each client connection, opens a connection to the server
- for each client, and then bidirectionally forwards
- data between the two.
- This utility's behavior is similar to
- socat1.
- The main differences for systemd-socket-proxyd
- are support for socket activation with
- Accept=false and an event-driven
- design that scales better with the number of
- connections.
-
-
- Options
- The following options are understood:
-
-
-
-
-
- Prints a short help
- text and exits.
-
-
-
-
-
- Prints a version
- string and exits.
-
-
-
-
-
- Skips verification of
- the expected PID and file
- descriptor numbers. Use this if
- invoked indirectly, for
- example, with a shell script
- rather than with
-
-
-
-
-
-
-
- Exit status
- On success, 0 is returned, a non-zero failure
- code otherwise.
-
-
- Examples
-
- Direct-Use Example
- Use two services with a dependency
- and no namespace isolation.
-
- /etc/systemd/system/proxy-to-nginx.socket
-
-
+
+
+ systemd-socket-proxyd
+ systemd
+
+
+ Developer
+ David
+ Strauss
+ david@davidstrauss.net
+
+
+
+
+ systemd-socket-proxyd
+ 8
+
+
+ systemd-socket-proxyd
+ Bidirectionally proxy local sockets to another (possibly remote) socket.
+
+
+
+ systemd-socket-proxyd
+ OPTIONS
+ HOST:PORT
+
+
+ systemd-socket-proxyd
+ OPTIONS
+ UNIX-DOMAIN-SOCKET-PATH
+
+
+
+
+ Description
+
+ systemd-socket-proxyd is a generic
+ socket-activated network socket forwarder proxy daemon for IPv4,
+ IPv6 and UNIX stream sockets. It may be used to bi-directionally
+ forward traffic from a local listening socket to a local or remote
+ destination socket.
+
+ 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.
+ This utility's behavior is similar to
+ socat1.
+ The main differences for systemd-socket-proxyd
+ are support for socket activation with
+ Accept=false and an event-driven
+ design that scales better with the number of
+ connections.
+
+
+ Options
+ The following options are understood:
+
+
+
+
+
+
+ Exit status
+ On success, 0 is returned, a non-zero failure
+ code otherwise.
+
+
+ Examples
+
+ Simple Example
+ Use two services with a dependency and no namespace
+ isolation.
+
+ proxy-to-nginx.socket
+
-
-
-
- /etc/systemd/system/proxy-to-nginx.service
-
-
+
+
+ proxy-to-nginx.service
+
-
-
-
- /etc/nginx/nginx.conf
-
+ExecStart=/usr/lib/systemd/systemd-socket-proxyd /tmp/nginx.sock
+PrivateTmp=yes
+PrivateNetwork=yes]]>
+
+
+ nginx.conf
+
-
-
-
-
+
+ Enabling the proxy
+
-
-
-
-
- Indirect-Use Example
- Use a shell script to isolate the
- service and proxy into the same namespace.
- This is particularly useful for running
- TCP-only daemons without the daemon
- affecting ports on regular
- interfaces.
-
-
-
- /etc/systemd/system/proxy-with-nginx.socket
-
-
+
+
+
+ Namespace Example
+ Similar as above, but runs the socket proxy and the main
+ service in the same private namespace, assuming that
+ nginx.service has
+ PrivateTmp= and
+ PrivateNetwork= set, too.
+
+ proxy-to-nginx.socket
+
-
-
-
-
-
- /etc/systemd/system/proxy-with-nginx.service
-
-
+
+
+ proxy-to-nginx.service
+
-
-
-
-
- /usr/bin/socket-proxyd-nginx.sh
-
-
-
-
-
-
- /etc/nginx/nginx.conf
-
-
+
+
+ nginx.conf
+
-
-
-
-
-
-
-
-
-
-
- See Also
-
-
-
- systemd.service
- 5
- ,
-
-
- systemd.socket
- 5
- ,
-
- systemctl
- 1
- ,
-
- socat
- 1
-
-
+ [...]]]>
+
+
+ Enabling the proxy
+
+
+
+
+
+ See Also
+
+ systemd1,
+ systemd.socket5,
+ systemd.service5,
+ systemctl1,
+ socat1,
+ nginx1,
+ curl1
+
+