commit 7c546bd8e9b2fe34f22db71d0cb0b6cc5fc182d6
from: Stefan Sperling <stsp@stsp.name>
date: Wed Oct 23 18:35:08 2024 UTC

initial draft of gotsysd.8

commit - c88a3d870970b98dfd5694d0275afc56790747bf
commit + 7c546bd8e9b2fe34f22db71d0cb0b6cc5fc182d6
blob - /dev/null
blob + 4cdf6c9a893942c66e4d0c66f2e7361fce8bd818 (mode 644)
--- /dev/null
+++ gotsysd/gotsysd.8
@@ -0,0 +1,95 @@
+.\"
+.\" Copyright (c) 2024 Stefan Sperling <stsp@openbsd.org>
+.\"
+.\" Permission to use, copy, modify, and distribute this software for any
+.\" purpose with or without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+.\"
+.Dd $Mdocdate$
+.Dt GOTSYSD 8
+.Os
+.Sh NAME
+.Nm gotsysd
+.Nd Game of Trees System Daemon
+.Sh SYNOPSIS
+.Nm
+.Op Fl dnv
+.Op Fl f Ar config-file
+.Sh DESCRIPTION
+.Nm
+manages the system configuration of a Git repository server running
+.Xr gotd 8 .
+System configuration tasks include the creation and deletion of Git
+repositores, and the addition and deletion of user accounts which use
+the
+.Xr gotsh 1
+shell.
+.Nm
+allows remote administrators to configure aspects of Git repository
+services without having shell access to the operating system.
+Remote administrators merely need to be granted write access to a
+special-purpose Git repository.
+.Pp
+.Nm
+listens on a
+.Xr unix 4
+socket for system notifications issued by
+.Xr gotd 8 .
+System notifications are sent when a remote administrator modifies the file
+.Xr gotsys.conf 5
+in a special-purpose Git repository.
+.Nm
+then adjusts the system configuration accordingly.
+.Pp
+The configuration file format is described in
+.Xr gotsysd.conf 5 .
+.Nm
+can be run without a configuration file, using default settings.
+.Pp
+The options for
+.Nm
+are as follows:
+.Bl -tag -width Ds
+.It Fl d
+Do not daemonize.
+Send log output to stderr.
+.It Fl f Ar config-file
+Set the path to the configuration file.
+If not specified, the file
+.Pa /etc/gotsysd.conf
+will be used.
+This file is not required to exist.
+.It Fl n
+Configtest mode.
+Only check the configuration file for validity.
+.It Fl v
+Verbose mode.
+Verbosity increases if this option is used multiple times.
+.El
+.Sh FILES
+.Bl -tag -width Ds -compact
+.It Pa /etc/gotsysd.conf
+Default location of the configuration file.
+.It Pa /var/run/gotd-gotsys.sock
+Default location of the unix socket which
+.Nm
+is listening on.
+This path can be configured in
+.Xr gotsysd.conf 5 .
+.El
+.Sh SEE ALSO
+.Xr got 1 ,
+.Xr gotsh 1 ,
+.Xr gotsys.conf 5 ,
+.Xr gotsysd.conf 5 ,
+.Xr gotd 8
+.Sh AUTHORS
+.An Stefan Sperling Aq Mt stsp@openbsd.org