2 .\" Copyright (c) 2020 Stefan Sperling
4 .\" Permission to use, copy, modify, and distribute this software for any
5 .\" purpose with or without fee is hereby granted, provided that the above
6 .\" copyright notice and this permission notice appear in all copies.
8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
21 .Nd Game of Trees Git repository server for web browsers
26 provides a web interface allowing Git repository contents to be viewed
30 is a CGI program based on
34 which is intended to run in a
38 The program has been designed to work out of the box with
41 web server in conjunction with
46 requires the following steps:
51 configuration file must be adjusted to run
57 section below contains an appropriate configuration file sample.
59 httpd(8) and slowcgi(8) must be enabled and started:
60 .Bd -literal -offset indent
61 # rcctl enable httpd slowcgi
62 # rcctl start httpd slowcgi
65 Optionally, the run-time behaviour of
67 can be configured via the
71 Git repositories must be created at a suitable location inside the
75 These repositories should
77 be writable by the user ID of the
80 The default location for repositories published by
83 .Pa /var/www/got/public .
85 Git repositories served by
87 should be kept up-to-date with a mechanism such as
95 .Bl -tag -width /var/www/got/public/ -compact
96 .It Pa /var/www/got/public/
97 Default location for Git repositories served by
99 This location can be adjusted in the
102 .It Pa /var/www/cgi-bin/gotweb/gotweb
105 CGI program, statically linked for use in a
108 .It Pa /var/www/cgi-bin/gotweb/gw_tmpl/
109 Directory for template files used by
111 .It Pa /var/www/cgi-bin/gotweb/libexec/
112 Directory containing statically linked
114 helper programs which are run by
116 to read Git repositories.
117 .It Pa /var/www/htdocs/gotweb/
118 Directory containing HTML, CSS, and image files used by
120 .It Pa /var/www/got/tmp/
121 Directory for temporary files created by
125 Example configuration for httpd.conf:
126 .Bd -literal -offset indent
128 types { include "/usr/share/misc/mime.types" }
129 server "gotweb.example.com" {
131 root "/htdocs/gotweb"
132 location "/cgi-bin/*" {
137 directory index "index.html"
144 .Xr git-repository 5 ,
149 .An Tracey Emery Aq Mt tracey@traceyemery.net
150 .An Stefan Sperling Aq Mt stsp@openbsd.org