Blob


1 <!DOCTYPE html>
2 <html>
3 <head>
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"/>
7 <title>GOTD(8)</title>
8 </head>
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.
23 -->
24 <body>
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">
29 <section class="Sh">
30 <h2 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h2>
31 <p class="Pp"><code class="Nm">gotd</code> &#x2014;
32 <span class="Nd" role="doc-subtitle">Game of Trees Daemon</span></p>
33 </section>
34 <section class="Sh">
35 <h2 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h2>
36 <table class="Nm">
37 <tr>
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>]</td>
41 </tr>
42 </table>
43 </section>
44 <section class="Sh">
45 <h2 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h2>
46 <p class="Pp"><code class="Nm">gotd</code> is a Git repository server which
47 listens on a <a class="Xr" aria-label="unix, section 4">unix(4)</a> socket
48 and relies on its companion tool <a class="Xr" aria-label="gotsh, section
49 1">gotsh(1)</a> to handle Git-protocol communication over the network, via
50 <a class="Xr" aria-label="ssh, section 1">ssh(1)</a>.</p>
51 <p class="Pp">The Git repository format is described in
52 <a class="Xr" aria-label="git-repository, section
53 5">git-repository(5)</a>.</p>
54 <p class="Pp"><code class="Nm">gotd</code> requires a configuration file in
55 order to run. The configuration file format is described in
56 <a class="Xr" aria-label="gotd.conf, section 5">gotd.conf(5)</a>.</p>
57 <p class="Pp">It is recommended to restrict <a class="Xr" aria-label="ssh,
58 section 1">ssh(1)</a> features available to users of
59 <code class="Nm">gotd</code>. See <a class="Xr" aria-label="gotsh, section
60 1">gotsh(1)</a> for details.</p>
61 <p class="Pp">The options for <code class="Nm">gotd</code> are as follows:</p>
62 <dl class="Bl-tag">
63 <dt id="d"><a class="permalink" href="#d"><code class="Fl">-d</code></a></dt>
64 <dd>Do not daemonize. Send log output to stderr.</dd>
65 <dt id="f"><a class="permalink" href="#f"><code class="Fl">-f</code></a>
66 <var class="Ar">config-file</var></dt>
67 <dd>Set the path to the configuration file. If not specified, the file
68 <span class="Pa">/etc/gotd.conf</span> will be used.</dd>
69 <dt id="n"><a class="permalink" href="#n"><code class="Fl">-n</code></a></dt>
70 <dd>Configtest mode. Only check the configuration file for validity.</dd>
71 <dt id="v"><a class="permalink" href="#v"><code class="Fl">-v</code></a></dt>
72 <dd>Verbose mode. Verbosity increases if this option is used multiple
73 times.</dd>
74 </dl>
75 </section>
76 <section class="Sh">
77 <h2 class="Sh" id="FILES"><a class="permalink" href="#FILES">FILES</a></h2>
78 <dl class="Bl-tag Bl-compact">
79 <dt><span class="Pa">/etc/gotd.conf</span></dt>
80 <dd>Default location of the configuration file.</dd>
81 <dt><span class="Pa">/var/run/gotd.sock</span></dt>
82 <dd>Default location of the unix socket which <code class="Nm">gotd</code> is
83 listening on. This path can be configured in
84 <a class="Xr" aria-label="gotd.conf, section 5">gotd.conf(5)</a>.</dd>
85 </dl>
86 </section>
87 <section class="Sh">
88 <h2 class="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a></h2>
89 <p class="Pp">Create an empty repository to be served by
90 <code class="Nm">gotd</code>, ensuring that it can only be accessed by the
91 _gotd user:</p>
92 <p class="Pp"></p>
93 <div class="Bd Bd-indent"><code class="Li"># mkdir -p
94 /git/myrepo.git</code></div>
95 <div class="Bd Bd-indent"><code class="Li"># chmod 700
96 /git/myrepo.git</code></div>
97 <div class="Bd Bd-indent"><code class="Li"># chown _gotd
98 /git/myrepo.git</code></div>
99 <div class="Bd Bd-indent"><code class="Li"># su -m _gotd -c 'gotadmin init
100 /git/myrepo.git'</code></div>
101 <p class="Pp">Add the new repository to <a class="Xr" aria-label="gotd.conf,
102 section 5">gotd.conf(5)</a> granting read-write access to the flan_hacker
103 user account, and restart <code class="Nm">gotd</code>:</p>
104 <p class="Pp"></p>
105 <div class="Bd Bd-indent"><code class="Li"># cat &gt;&gt; /etc/gotd.conf
106 &lt;&lt;EOF</code></div>
107 <div class="Bd Bd-indent"><code class="Li">repository 'myrepo' {</code></div>
108 <div class="Bd Bd-indent"><code class="Li">path '/git/myrepo.git'</code></div>
109 <div class="Bd Bd-indent"><code class="Li">permit rw flan_hacker</code></div>
110 <div class="Bd Bd-indent"><code class="Li">}</code></div>
111 <div class="Bd Bd-indent"><code class="Li">EOF</code></div>
112 <div class="Bd Bd-indent"><code class="Li"># rcctl restart gotd</code></div>
113 <p class="Pp">The flan_hacker user can now populate the empty repository with
114 <code class="Cm">got send</code>.</p>
115 </section>
116 <section class="Sh">
117 <h2 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
118 ALSO</a></h2>
119 <p class="Pp"><a class="Xr" aria-label="got, section 1">got(1)</a>,
120 <a class="Xr" aria-label="gotsh, section 1">gotsh(1)</a>,
121 <a class="Xr" aria-label="git-repository, section 5">git-repository(5)</a>,
122 <a class="Xr" aria-label="gotd.conf, section 5">gotd.conf(5)</a></p>
123 </section>
124 <section class="Sh">
125 <h2 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h2>
126 <p class="Pp"><span class="An">Stefan Sperling</span>
127 &lt;<a class="Mt" href="mailto:stsp@openbsd.org">stsp@openbsd.org</a>&gt;</p>
128 </section>
129 </main>
130 <div class="foot" role="doc-pagefooter" aria-label="Manual footer
131 line"><span class="foot-left"></span><span class="foot-date">July 11,
132 2024</span> <span class="foot-os">OpenBSD 7.5</span></div>
133 </body>
134 </html>