summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRuss Allbery <eagle@eyrie.org>2014-01-05 12:24:32 -0800
committerRuss Allbery <rra@stanford.edu>2014-01-05 13:00:11 -0800
commita00d1d4ff597ab0d1ab3020ecce9a3b0aae67514 (patch)
treeaff1434d22b76c5eccde1ef270b2557780eb2834 /docs
parenta5a819c8951ee9da5fec5560f266a88d3b2fd551 (diff)
Add support for systemd socket activation and notification
Add support for systemd. If built on a system with systemd installed, remctl will install (but not enable) systemd units to start remctld via socket activation. remctld will also notify systemd when its initialization is complete if started by systemd with service notification enabled. Change-Id: I91caa7a3a909c7e85454e43b4cf3b6d7bd4a6067 Reviewed-on: https://gerrit.stanford.edu/1356 Reviewed-by: Russ Allbery <rra@stanford.edu> Tested-by: Russ Allbery <rra@stanford.edu>
Diffstat (limited to 'docs')
-rw-r--r--docs/remctld.pod32
1 files changed, 31 insertions, 1 deletions
diff --git a/docs/remctld.pod b/docs/remctld.pod
index 9cd23b4..6ab0e37 100644
--- a/docs/remctld.pod
+++ b/docs/remctld.pod
@@ -3,7 +3,7 @@ remctld remctl -dFhmSvZ keytab GSS-API tcpserver inetd subcommand AFS
backend logmask NUL acl ACL princ filename gput CMU GPUT xform ANYUSER IP
IPv4 IPv6 hostname SCPRINCIPAL sysctld Heimdal MICs Ushakov Allbery
subcommands REMUSER pcre PCRE triple-DES MERCHANTABILITY username arg
-SIGCONT SIGSTOP
+SIGCONT SIGSTOP systemd
=head1 NAME
@@ -410,6 +410,36 @@ without any I<method>: prefixes.
=head1 ENVIRONMENT
+B<remctld> itself uses the following environment variables when run in
+stand-alone mode (B<-m>):
+
+=over 4
+
+=item LISTEN_FDS
+
+=item LISTEN_PID
+
+If these environment variables are set, B<remctld> will expect to be
+provided its listening sockets via the systemd socket activation protocol
+and will not attempt to bind its own sockets. For more details on the
+protocol, see L<daemon(7)> and L<sd_listen_fds(3)>.
+
+=item NOTIFY_SOCKET
+
+If this environment variable is set, B<remctld> will notify the socket
+named in this variable when it is ready to accept incoming packets using
+the systemd status notification protocol. For more details, see
+L<daemon(7)> and L<sd_notify(3)>.
+
+Note that using socket activation is recommended when running under
+systemd in stand-alone mode, and status notification is not necessary or
+useful when using socket activation.
+
+=back
+
+When running in stand-alone mode, these environment variables will be
+cleared by B<remctld> before running any commands.
+
The following environment variables will be set for any commands run via
B<remctld>: