Blame


1 b2c82ae2 2020-02-17 stsp <!DOCTYPE html>
2 b2c82ae2 2020-02-17 stsp <html>
3 b2c82ae2 2020-02-17 stsp <!-- This is an automatically generated file. Do not edit.
4 b2c82ae2 2020-02-17 stsp Copyright (c) 2020 Stefan Sperling
5 b2c82ae2 2020-02-17 stsp
6 b2c82ae2 2020-02-17 stsp Permission to use, copy, modify, and distribute this software for any
7 b2c82ae2 2020-02-17 stsp purpose with or without fee is hereby granted, provided that the above
8 b2c82ae2 2020-02-17 stsp copyright notice and this permission notice appear in all copies.
9 b2c82ae2 2020-02-17 stsp
10 b2c82ae2 2020-02-17 stsp THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 b2c82ae2 2020-02-17 stsp WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 b2c82ae2 2020-02-17 stsp MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 b2c82ae2 2020-02-17 stsp ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 b2c82ae2 2020-02-17 stsp WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 b2c82ae2 2020-02-17 stsp ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 b2c82ae2 2020-02-17 stsp OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 b2c82ae2 2020-02-17 stsp -->
18 b2c82ae2 2020-02-17 stsp <head>
19 b2c82ae2 2020-02-17 stsp <meta charset="utf-8"/>
20 a954aa0a 2021-06-22 stsp <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
21 5ca479d6 2021-11-21 stsp <link rel="stylesheet" href="mandoc.css" type="text/css" media="all"/>
22 b2c82ae2 2020-02-17 stsp <title>GOTWEB(8)</title>
23 b2c82ae2 2020-02-17 stsp </head>
24 b2c82ae2 2020-02-17 stsp <body>
25 b2c82ae2 2020-02-17 stsp <table class="head">
26 b2c82ae2 2020-02-17 stsp <tr>
27 b2c82ae2 2020-02-17 stsp <td class="head-ltitle">GOTWEB(8)</td>
28 b2c82ae2 2020-02-17 stsp <td class="head-vol">System Manager's Manual</td>
29 b2c82ae2 2020-02-17 stsp <td class="head-rtitle">GOTWEB(8)</td>
30 b2c82ae2 2020-02-17 stsp </tr>
31 b2c82ae2 2020-02-17 stsp </table>
32 b2c82ae2 2020-02-17 stsp <div class="manual-text">
33 b2c82ae2 2020-02-17 stsp <section class="Sh">
34 b2c82ae2 2020-02-17 stsp <h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
35 b2c82ae2 2020-02-17 stsp <p class="Pp"><code class="Nm">gotweb</code> &#x2014; <span class="Nd">Game of
36 b2c82ae2 2020-02-17 stsp Trees Git repository server for web browsers</span></p>
37 b2c82ae2 2020-02-17 stsp </section>
38 b2c82ae2 2020-02-17 stsp <section class="Sh">
39 b2c82ae2 2020-02-17 stsp <h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
40 b2c82ae2 2020-02-17 stsp <table class="Nm">
41 b2c82ae2 2020-02-17 stsp <tr>
42 b2c82ae2 2020-02-17 stsp <td><code class="Nm">gotweb</code></td>
43 b2c82ae2 2020-02-17 stsp <td></td>
44 b2c82ae2 2020-02-17 stsp </tr>
45 b2c82ae2 2020-02-17 stsp </table>
46 b2c82ae2 2020-02-17 stsp </section>
47 b2c82ae2 2020-02-17 stsp <section class="Sh">
48 b2c82ae2 2020-02-17 stsp <h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
49 b2c82ae2 2020-02-17 stsp <p class="Pp"><code class="Nm">gotweb</code> provides a web interface allowing
50 b2c82ae2 2020-02-17 stsp Git repository contents to be viewed with a web browser.</p>
51 b2c82ae2 2020-02-17 stsp <p class="Pp"><code class="Nm">gotweb</code> is a CGI program based on
52 b2c82ae2 2020-02-17 stsp <a class="Xr">got(1)</a> and <a class="Xr">kcgi(3)</a> which is intended to
53 b2c82ae2 2020-02-17 stsp run in a <a class="Xr">chroot(2)</a> environment in
54 b2c82ae2 2020-02-17 stsp <span class="Pa">/var/www</span>. The program has been designed to work out
55 b2c82ae2 2020-02-17 stsp of the box with the <a class="Xr">httpd(8)</a> web server in conjunction
56 b2c82ae2 2020-02-17 stsp with <a class="Xr">slowcgi(8)</a>.</p>
57 b2c82ae2 2020-02-17 stsp <p class="Pp">Enabling <code class="Nm">gotweb</code> requires the following
58 b2c82ae2 2020-02-17 stsp steps:</p>
59 b2c82ae2 2020-02-17 stsp <ol class="Bl-enum">
60 b2c82ae2 2020-02-17 stsp <li>The <a class="Xr">httpd.conf(5)</a> configuration file must be adjusted to
61 b2c82ae2 2020-02-17 stsp run <code class="Nm">gotweb</code> as a CGI program with
62 b2c82ae2 2020-02-17 stsp <a class="Xr">slowcgi(8)</a>. The
63 b2c82ae2 2020-02-17 stsp <a class="Sx" href="#EXAMPLES">EXAMPLES</a> section below contains an
64 b2c82ae2 2020-02-17 stsp appropriate configuration file sample.</li>
65 b2c82ae2 2020-02-17 stsp <li>httpd(8) and slowcgi(8) must be enabled and started:
66 a954aa0a 2021-06-22 stsp <div class="Bd Pp Bd-indent Li">
67 a954aa0a 2021-06-22 stsp <pre> # rcctl enable httpd slowcgi
68 a954aa0a 2021-06-22 stsp # rcctl start httpd slowcgi</pre>
69 b2c82ae2 2020-02-17 stsp </div>
70 b2c82ae2 2020-02-17 stsp </li>
71 b2c82ae2 2020-02-17 stsp <li>Optionally, the run-time behaviour of <code class="Nm">gotweb</code> can
72 b2c82ae2 2020-02-17 stsp be configured via the <a class="Xr">gotweb.conf(5)</a> configuration
73 b2c82ae2 2020-02-17 stsp file.</li>
74 2dbbbc3a 2020-07-23 stsp <li id="not">Git repositories must be created at a suitable location inside
75 2dbbbc3a 2020-07-23 stsp the web server's <a class="Xr">chroot(2)</a> environment. These
76 2dbbbc3a 2020-07-23 stsp repositories should
77 2dbbbc3a 2020-07-23 stsp <a class="permalink" href="#not"><i class="Em">not</i></a> be writable by
78 2dbbbc3a 2020-07-23 stsp the user ID of the <a class="Xr">httpd(8)</a> server. The default location
79 2dbbbc3a 2020-07-23 stsp for repositories published by <code class="Nm">gotweb</code> is
80 b2c82ae2 2020-02-17 stsp <span class="Pa">/var/www/got/public</span>.</li>
81 b2c82ae2 2020-02-17 stsp <li>Git repositories served by <code class="Nm">gotweb</code> should be kept
82 b213cbf7 2020-03-23 stsp up-to-date with a mechanism such as <code class="Cm">got fetch</code>,
83 b213cbf7 2020-03-23 stsp <a class="Xr">git-fetch(1)</a>, or <a class="Xr">rsync(1)</a>, scheduled
84 b213cbf7 2020-03-23 stsp by <a class="Xr">cron(8)</a>.</li>
85 b2c82ae2 2020-02-17 stsp </ol>
86 b2c82ae2 2020-02-17 stsp </section>
87 b2c82ae2 2020-02-17 stsp <section class="Sh">
88 b2c82ae2 2020-02-17 stsp <h1 class="Sh" id="FILES"><a class="permalink" href="#FILES">FILES</a></h1>
89 b2c82ae2 2020-02-17 stsp <dl class="Bl-tag Bl-compact">
90 b2c82ae2 2020-02-17 stsp <dt><span class="Pa">/var/www/got/public/</span></dt>
91 b2c82ae2 2020-02-17 stsp <dd>Default location for Git repositories served by
92 b2c82ae2 2020-02-17 stsp <code class="Nm">gotweb</code>. This location can be adjusted in the
93 b2c82ae2 2020-02-17 stsp <a class="Xr">gotweb.conf(5)</a> configuration file.</dd>
94 b2c82ae2 2020-02-17 stsp <dt><span class="Pa">/var/www/cgi-bin/gotweb/gotweb</span></dt>
95 b2c82ae2 2020-02-17 stsp <dd>The <code class="Nm">gotweb</code> CGI program, statically linked for use
96 b2c82ae2 2020-02-17 stsp in a <a class="Xr">chroot(2)</a> environment.</dd>
97 b2c82ae2 2020-02-17 stsp <dt><span class="Pa">/var/www/cgi-bin/gotweb/gw_tmpl/</span></dt>
98 b2c82ae2 2020-02-17 stsp <dd>Directory for template files used by <code class="Nm">gotweb</code>.</dd>
99 b2c82ae2 2020-02-17 stsp <dt><span class="Pa">/var/www/cgi-bin/gotweb/libexec/</span></dt>
100 b2c82ae2 2020-02-17 stsp <dd>Directory containing statically linked <a class="Xr">got(1)</a> helper
101 b2c82ae2 2020-02-17 stsp programs which are run by <code class="Nm">gotweb</code> to read Git
102 b2c82ae2 2020-02-17 stsp repositories.</dd>
103 b2c82ae2 2020-02-17 stsp <dt><span class="Pa">/var/www/htdocs/gotweb/</span></dt>
104 b2c82ae2 2020-02-17 stsp <dd>Directory containing HTML, CSS, and image files used by
105 b2c82ae2 2020-02-17 stsp <code class="Nm">gotweb</code>.</dd>
106 b2c82ae2 2020-02-17 stsp <dt><span class="Pa">/var/www/got/tmp/</span></dt>
107 b2c82ae2 2020-02-17 stsp <dd>Directory for temporary files created by
108 b2c82ae2 2020-02-17 stsp <code class="Nm">gotweb</code>.</dd>
109 b2c82ae2 2020-02-17 stsp </dl>
110 b2c82ae2 2020-02-17 stsp </section>
111 b2c82ae2 2020-02-17 stsp <section class="Sh">
112 b2c82ae2 2020-02-17 stsp <h1 class="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a></h1>
113 b2c82ae2 2020-02-17 stsp <p class="Pp">Example configuration for httpd.conf:</p>
114 a954aa0a 2021-06-22 stsp <div class="Bd Pp Bd-indent Li">
115 b2c82ae2 2020-02-17 stsp <pre>
116 b2c82ae2 2020-02-17 stsp types { include &quot;/usr/share/misc/mime.types&quot; }
117 b2c82ae2 2020-02-17 stsp server &quot;gotweb.example.com&quot; {
118 b2c82ae2 2020-02-17 stsp listen on * port 80
119 b2c82ae2 2020-02-17 stsp root &quot;/htdocs/gotweb&quot;
120 b2c82ae2 2020-02-17 stsp location &quot;/cgi-bin/*&quot; {
121 b2c82ae2 2020-02-17 stsp root &quot;/&quot;
122 b2c82ae2 2020-02-17 stsp fastcgi
123 b2c82ae2 2020-02-17 stsp }
124 b2c82ae2 2020-02-17 stsp location &quot;/*&quot; {
125 b2c82ae2 2020-02-17 stsp directory index &quot;index.html&quot;
126 b2c82ae2 2020-02-17 stsp }
127 a954aa0a 2021-06-22 stsp }</pre>
128 b2c82ae2 2020-02-17 stsp </div>
129 b2c82ae2 2020-02-17 stsp </section>
130 b2c82ae2 2020-02-17 stsp <section class="Sh">
131 b2c82ae2 2020-02-17 stsp <h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
132 b2c82ae2 2020-02-17 stsp ALSO</a></h1>
133 b2c82ae2 2020-02-17 stsp <p class="Pp"><a class="Xr">got(1)</a>, <a class="Xr">kcgi(3)</a>,
134 b2c82ae2 2020-02-17 stsp <a class="Xr">git-repository(5)</a>, <a class="Xr">gotweb.conf(5)</a>,
135 b2c82ae2 2020-02-17 stsp <a class="Xr">httpd(8)</a>, <a class="Xr">slowcgi(8)</a></p>
136 b2c82ae2 2020-02-17 stsp </section>
137 b2c82ae2 2020-02-17 stsp <section class="Sh">
138 b2c82ae2 2020-02-17 stsp <h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1>
139 b2c82ae2 2020-02-17 stsp <p class="Pp"><span class="An">Tracey Emery</span>
140 b2c82ae2 2020-02-17 stsp &lt;<a class="Mt" href="mailto:tracey@traceyemery.net">tracey@traceyemery.net</a>&gt;
141 b2c82ae2 2020-02-17 stsp <br/>
142 b2c82ae2 2020-02-17 stsp <span class="An">Stefan Sperling</span>
143 b2c82ae2 2020-02-17 stsp &lt;<a class="Mt" href="mailto:stsp@openbsd.org">stsp@openbsd.org</a>&gt;</p>
144 b2c82ae2 2020-02-17 stsp </section>
145 b2c82ae2 2020-02-17 stsp </div>
146 b2c82ae2 2020-02-17 stsp <table class="foot">
147 b2c82ae2 2020-02-17 stsp <tr>
148 03b138b5 2022-05-10 stsp <td class="foot-date">May 10, 2022</td>
149 15ba8349 2022-04-24 stsp <td class="foot-os">OpenBSD 7.1</td>
150 b2c82ae2 2020-02-17 stsp </tr>
151 b2c82ae2 2020-02-17 stsp </table>
152 b2c82ae2 2020-02-17 stsp </body>
153 b2c82ae2 2020-02-17 stsp </html>