Blame


1 7c546bd8 2024-10-23 stsp .\"
2 7c546bd8 2024-10-23 stsp .\" Copyright (c) 2024 Stefan Sperling <stsp@openbsd.org>
3 7c546bd8 2024-10-23 stsp .\"
4 7c546bd8 2024-10-23 stsp .\" Permission to use, copy, modify, and distribute this software for any
5 7c546bd8 2024-10-23 stsp .\" purpose with or without fee is hereby granted, provided that the above
6 7c546bd8 2024-10-23 stsp .\" copyright notice and this permission notice appear in all copies.
7 7c546bd8 2024-10-23 stsp .\"
8 7c546bd8 2024-10-23 stsp .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 7c546bd8 2024-10-23 stsp .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 7c546bd8 2024-10-23 stsp .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 7c546bd8 2024-10-23 stsp .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 7c546bd8 2024-10-23 stsp .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 7c546bd8 2024-10-23 stsp .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 7c546bd8 2024-10-23 stsp .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15 7c546bd8 2024-10-23 stsp .\"
16 7c546bd8 2024-10-23 stsp .Dd $Mdocdate$
17 7c546bd8 2024-10-23 stsp .Dt GOTSYSD 8
18 7c546bd8 2024-10-23 stsp .Os
19 7c546bd8 2024-10-23 stsp .Sh NAME
20 7c546bd8 2024-10-23 stsp .Nm gotsysd
21 7c546bd8 2024-10-23 stsp .Nd Game of Trees System Daemon
22 7c546bd8 2024-10-23 stsp .Sh SYNOPSIS
23 7c546bd8 2024-10-23 stsp .Nm
24 7c546bd8 2024-10-23 stsp .Op Fl dnv
25 7c546bd8 2024-10-23 stsp .Op Fl f Ar config-file
26 7c546bd8 2024-10-23 stsp .Sh DESCRIPTION
27 7c546bd8 2024-10-23 stsp .Nm
28 7c546bd8 2024-10-23 stsp manages the system configuration of a Git repository server running
29 7c546bd8 2024-10-23 stsp .Xr gotd 8 .
30 7c546bd8 2024-10-23 stsp System configuration tasks include the creation and deletion of Git
31 7c546bd8 2024-10-23 stsp repositores, and the addition and deletion of user accounts which use
32 7c546bd8 2024-10-23 stsp the
33 7c546bd8 2024-10-23 stsp .Xr gotsh 1
34 7c546bd8 2024-10-23 stsp shell.
35 61cd1636 2024-10-23 stsp .Pp
36 7c546bd8 2024-10-23 stsp .Nm
37 7c546bd8 2024-10-23 stsp allows remote administrators to configure aspects of Git repository
38 61cd1636 2024-10-23 stsp services without having shell access to the Git server's operating system.
39 7c546bd8 2024-10-23 stsp Remote administrators merely need to be granted write access to a
40 61cd1636 2024-10-23 stsp special-purpose Git repository hosted by
41 61cd1636 2024-10-23 stsp .Xr gotd 8
42 61cd1636 2024-10-23 stsp which contains
43 61cd1636 2024-10-23 stsp .Xr gotsys.conf 5 .
44 7c546bd8 2024-10-23 stsp .Pp
45 7c546bd8 2024-10-23 stsp .Nm
46 7c546bd8 2024-10-23 stsp listens on a
47 7c546bd8 2024-10-23 stsp .Xr unix 4
48 7c546bd8 2024-10-23 stsp socket for system notifications issued by
49 7c546bd8 2024-10-23 stsp .Xr gotd 8 .
50 7c546bd8 2024-10-23 stsp System notifications are sent when a remote administrator modifies the file
51 7c546bd8 2024-10-23 stsp .Xr gotsys.conf 5
52 7c546bd8 2024-10-23 stsp in a special-purpose Git repository.
53 7c546bd8 2024-10-23 stsp .Nm
54 7c546bd8 2024-10-23 stsp then adjusts the system configuration accordingly.
55 7c546bd8 2024-10-23 stsp .Pp
56 7c546bd8 2024-10-23 stsp The configuration file format is described in
57 7c546bd8 2024-10-23 stsp .Xr gotsysd.conf 5 .
58 7c546bd8 2024-10-23 stsp .Nm
59 7c546bd8 2024-10-23 stsp can be run without a configuration file, using default settings.
60 7c546bd8 2024-10-23 stsp .Pp
61 7c546bd8 2024-10-23 stsp The options for
62 7c546bd8 2024-10-23 stsp .Nm
63 7c546bd8 2024-10-23 stsp are as follows:
64 7c546bd8 2024-10-23 stsp .Bl -tag -width Ds
65 7c546bd8 2024-10-23 stsp .It Fl d
66 7c546bd8 2024-10-23 stsp Do not daemonize.
67 7c546bd8 2024-10-23 stsp Send log output to stderr.
68 7c546bd8 2024-10-23 stsp .It Fl f Ar config-file
69 7c546bd8 2024-10-23 stsp Set the path to the configuration file.
70 7c546bd8 2024-10-23 stsp If not specified, the file
71 7c546bd8 2024-10-23 stsp .Pa /etc/gotsysd.conf
72 7c546bd8 2024-10-23 stsp will be used.
73 7c546bd8 2024-10-23 stsp This file is not required to exist.
74 7c546bd8 2024-10-23 stsp .It Fl n
75 7c546bd8 2024-10-23 stsp Configtest mode.
76 7c546bd8 2024-10-23 stsp Only check the configuration file for validity.
77 7c546bd8 2024-10-23 stsp .It Fl v
78 7c546bd8 2024-10-23 stsp Verbose mode.
79 7c546bd8 2024-10-23 stsp Verbosity increases if this option is used multiple times.
80 7c546bd8 2024-10-23 stsp .El
81 7c546bd8 2024-10-23 stsp .Sh FILES
82 7c546bd8 2024-10-23 stsp .Bl -tag -width Ds -compact
83 7c546bd8 2024-10-23 stsp .It Pa /etc/gotsysd.conf
84 7c546bd8 2024-10-23 stsp Default location of the configuration file.
85 7c546bd8 2024-10-23 stsp .It Pa /var/run/gotd-gotsys.sock
86 7c546bd8 2024-10-23 stsp Default location of the unix socket which
87 7c546bd8 2024-10-23 stsp .Nm
88 7c546bd8 2024-10-23 stsp is listening on.
89 7c546bd8 2024-10-23 stsp This path can be configured in
90 7c546bd8 2024-10-23 stsp .Xr gotsysd.conf 5 .
91 7c546bd8 2024-10-23 stsp .El
92 7c546bd8 2024-10-23 stsp .Sh SEE ALSO
93 7c546bd8 2024-10-23 stsp .Xr got 1 ,
94 7c546bd8 2024-10-23 stsp .Xr gotsh 1 ,
95 7c546bd8 2024-10-23 stsp .Xr gotsys.conf 5 ,
96 7c546bd8 2024-10-23 stsp .Xr gotsysd.conf 5 ,
97 7c546bd8 2024-10-23 stsp .Xr gotd 8
98 7c546bd8 2024-10-23 stsp .Sh AUTHORS
99 7c546bd8 2024-10-23 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org