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 Fast-CGI repository server for web browsers
26 is a Fast-CGI server program which can display the contents of Git
27 repositories via a web browser.
28 The program has been designed to work out of the box with
35 requires the following steps:
40 configuration file must be adjusted to run
42 as a Fast-CGI helper program.
45 section below contains an appropriate configuration file sample.
47 httpd(8) must be enabled and started:
48 .Bd -literal -offset indent
53 Optionally, the run-time behaviour of
55 can be configured via the
59 Git repositories must be created at a suitable location inside the
63 These repositories should
65 be writable by the user ID shared between
69 The default location for repositories published by
72 .Pa /var/www/got/public .
74 Git repositories served by
76 should be kept up-to-date with a mechanism such as
85 .Bl -tag -width /var/www/got/public/ -compact
86 .It Pa /var/www/got/public/
87 Default location for Git repositories served by
89 This location can be adjusted in the
92 .It Pa /var/www/bin/gotwebd/
93 Directory containing statically linked
95 helper programs which are run by
97 to read Git repositories.
98 .It Pa /var/www/htdocs/gotwebd/
99 Directory containing HTML, CSS, and image files used by
102 Directory for temporary files created by
106 Example configuration for httpd.conf:
107 .Bd -literal -offset indent
108 types { include "/usr/share/misc/mime.types" }
110 # one gotwebd reachable at http://gotweb1.example.com/
111 server "gotweb1.example.com" {
113 root "/htdocs/gotwebd"
115 fastcgi socket tcp localhost 9000
119 # hosting multiple gotwebd instances on the same HTTP server:
120 # http://gotweb2.example.com/gotwebd-unix/
121 # http://gotweb2.example.com/gotwebd-tcp/
122 server "gotweb2.example.com" {
124 location "/gotwebd-unix/" {
125 fastcgi socket "/run/gotweb.sock"
127 location "/gotwebd-unix/*" {
128 root "/htdocs/gotwebd"
131 location "/gotwebd-tcp/" {
132 fastcgi socket tcp 127.0.0.1 9000
134 location "/gotwebd-tcp/*" {
135 root "/htdocs/gotwebd"
142 .Xr git-repository 5 ,
146 .An Omar Polo Aq Mt op@openbsd.org
147 .An Stefan Sperling Aq Mt stsp@openbsd.org
148 .An Tracey Emery Aq Mt tracey@traceyemery.net