4 <meta charset="utf-8"/>
5 <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
6 <link rel="stylesheet" href="mandoc.css" type="text/css" media="all"/>
9 <!-- This is an automatically generated file. Do not edit.
10 Copyright (c) 2022 Stefan Sperling
12 Permission to use, copy, modify, and distribute this software for any
13 purpose with or without fee is hereby granted, provided that the above
14 copyright notice and this permission notice appear in all copies.
16 THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
17 WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
18 MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
19 ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
20 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
21 ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
22 OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
25 <div class="head" role="doc-pageheader" aria-label="Manual header
26 line"><span class="head-ltitle">GOTD(8)</span> <span class="head-vol">System
27 Manager's Manual</span> <span class="head-rtitle">GOTD(8)</span></div>
28 <main class="manual-text">
30 <h2 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h2>
31 <p class="Pp"><code class="Nm">gotd</code> —
32 <span class="Nd" role="doc-subtitle">Game of Trees Daemon</span></p>
35 <h2 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h2>
38 <td><code class="Nm">gotd</code></td>
39 <td>[<code class="Fl">-dnv</code>] [<code class="Fl">-f</code>
40 <var class="Ar">config-file</var>] [<code class="Fl">-s</code>
41 <var class="Ar">secrets</var>]</td>
46 <h2 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h2>
47 <p class="Pp"><code class="Nm">gotd</code> is a Git repository server which
48 listens on a <a class="Xr" aria-label="unix, section 4">unix(4)</a> socket
49 and relies on its companion tool <a class="Xr" aria-label="gotsh, section
50 1">gotsh(1)</a> to handle Git-protocol communication over the network, via
51 <a class="Xr" aria-label="ssh, section 1">ssh(1)</a>.</p>
52 <p class="Pp">The Git repository format is described in
53 <a class="Xr" aria-label="git-repository, section
54 5">git-repository(5)</a>.</p>
55 <p class="Pp"><code class="Nm">gotd</code> requires a configuration file in
56 order to run. The configuration file format is described in
57 <a class="Xr" aria-label="gotd.conf, section 5">gotd.conf(5)</a>.</p>
58 <p class="Pp">It is recommended to restrict <a class="Xr" aria-label="ssh,
59 section 1">ssh(1)</a> features available to users of
60 <code class="Nm">gotd</code>. See <a class="Xr" aria-label="gotsh, section
61 1">gotsh(1)</a> for details.</p>
62 <p class="Pp">The options for <code class="Nm">gotd</code> are as follows:</p>
64 <dt id="d"><a class="permalink" href="#d"><code class="Fl">-d</code></a></dt>
65 <dd>Do not daemonize. Send log output to stderr.</dd>
66 <dt id="f"><a class="permalink" href="#f"><code class="Fl">-f</code></a>
67 <var class="Ar">config-file</var></dt>
68 <dd>Set the path to the configuration file. If not specified, the file
69 <span class="Pa">/etc/gotd.conf</span> will be used.</dd>
70 <dt id="n"><a class="permalink" href="#n"><code class="Fl">-n</code></a></dt>
71 <dd>Configtest mode. Only check the configuration file for validity.</dd>
72 <dt id="s"><a class="permalink" href="#s"><code class="Fl">-s</code></a>
73 <var class="Ar">secrets</var></dt>
74 <dd>Set the path to the secrets file. If not specified, the file
75 <span class="Pa">/etc/gotd-secrets.conf</span> will be used if it
77 <dt id="v"><a class="permalink" href="#v"><code class="Fl">-v</code></a></dt>
78 <dd>Verbose mode. Verbosity increases if this option is used multiple
83 <h2 class="Sh" id="FILES"><a class="permalink" href="#FILES">FILES</a></h2>
84 <dl class="Bl-tag Bl-compact">
85 <dt><span class="Pa">/etc/gotd.conf</span></dt>
86 <dd>Default location of the configuration file.</dd>
87 <dt><span class="Pa">/var/run/gotd.sock</span></dt>
88 <dd>Default location of the unix socket which <code class="Nm">gotd</code> is
89 listening on. This path can be configured in
90 <a class="Xr" aria-label="gotd.conf, section 5">gotd.conf(5)</a>.</dd>
94 <h2 class="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a></h2>
95 <p class="Pp">Create an empty repository to be served by
96 <code class="Nm">gotd</code>, ensuring that it can only be accessed by the
99 <div class="Bd Bd-indent"><code class="Li"># mkdir -p
100 /git/myrepo.git</code></div>
101 <div class="Bd Bd-indent"><code class="Li"># chmod 700
102 /git/myrepo.git</code></div>
103 <div class="Bd Bd-indent"><code class="Li"># chown _gotd
104 /git/myrepo.git</code></div>
105 <div class="Bd Bd-indent"><code class="Li"># su -m _gotd -c 'gotadmin init
106 /git/myrepo.git'</code></div>
107 <p class="Pp">Add the new repository to <a class="Xr" aria-label="gotd.conf,
108 section 5">gotd.conf(5)</a> granting read-write access to the flan_hacker
109 user account, and restart <code class="Nm">gotd</code>:</p>
111 <div class="Bd Bd-indent"><code class="Li"># cat >> /etc/gotd.conf
112 <<EOF</code></div>
113 <div class="Bd Bd-indent"><code class="Li">repository 'myrepo' {</code></div>
114 <div class="Bd Bd-indent"><code class="Li">path '/git/myrepo.git'</code></div>
115 <div class="Bd Bd-indent"><code class="Li">permit rw flan_hacker</code></div>
116 <div class="Bd Bd-indent"><code class="Li">}</code></div>
117 <div class="Bd Bd-indent"><code class="Li">EOF</code></div>
118 <div class="Bd Bd-indent"><code class="Li"># rcctl restart gotd</code></div>
119 <p class="Pp">The flan_hacker user can now populate the empty repository with
120 <code class="Cm">got send</code>.</p>
123 <h2 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
125 <p class="Pp"><a class="Xr" aria-label="got, section 1">got(1)</a>,
126 <a class="Xr" aria-label="gotsh, section 1">gotsh(1)</a>,
127 <a class="Xr" aria-label="git-repository, section 5">git-repository(5)</a>,
128 <a class="Xr" aria-label="gotd.conf, section 5">gotd.conf(5)</a>
129 <a class="Xr" aria-label="gotd-secrets.conf, section
130 5">gotd-secrets.conf(5)</a></p>
133 <h2 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h2>
134 <p class="Pp"><span class="An">Stefan Sperling</span>
135 <<a class="Mt" href="mailto:stsp@openbsd.org">stsp@openbsd.org</a>></p>
138 <h2 class="Sh" id="CAVEATS"><a class="permalink" href="#CAVEATS">CAVEATS</a></h2>
139 <p class="Pp">At present, <code class="Nm">gotd</code> cannot serve repositories
140 that use the sha256 object ID hashing algorithm because
141 <code class="Nm">gotd</code> does not yet support version 2 of the Git
142 network protocol.</p>
145 <div class="foot" role="doc-pagefooter" aria-label="Manual footer
146 line"><span class="foot-left"></span><span class="foot-date">November 21,
147 2024</span> <span class="foot-os">OpenBSD 7.6</span></div>
