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
25 .Op Fl D Ar macro=value
29 is a Fast-CGI server program which can display the contents of Git
30 repositories via a web browser.
31 The program has been designed to work out of the box with
37 provides the following options:
38 .Bl -tag -width tenletters
40 Do not daemonize and log to stderr.
41 .It Fl D Ar macro=value
42 Override the value of a macro used in the configuration file.
44 Set the path to the configuration file.
45 If not specified, the file
49 Parse the configuration file, report errors if any, and exit.
52 Verbosity increases if this option is used multiple times.
57 requires the following steps:
62 configuration file must be adjusted to run
64 as a Fast-CGI helper program.
67 section below contains an appropriate configuration file sample.
69 httpd(8) must be enabled and started:
70 .Bd -literal -offset indent
75 Optionally, the run-time behaviour of
77 can be configured via the
81 Git repositories must be created at a suitable location inside the
85 These repositories should
87 be writable by the user ID shared between
91 The default location for repositories published by
94 .Pa /var/www/got/public .
96 Git repositories served by
98 should be kept up-to-date with a mechanism such as
107 .Bl -tag -width /var/www/got/public/ -compact
108 .It Pa /etc/gotwebd.conf
109 Default location of the
112 .It Pa /var/www/got/public/
113 Default location for Git repositories served by
115 This location can be adjusted in the
118 .It Pa /var/www/bin/gotwebd/
119 Directory containing statically linked
121 helper programs which are run by
123 to read Git repositories.
124 .It Pa /var/www/htdocs/gotwebd/
125 Directory containing HTML, CSS, and image files used by
128 Directory for temporary files created by
132 Example configuration for
134 .Bd -literal -offset indent
135 types { include "/usr/share/misc/mime.types" }
137 # one gotwebd reachable at http://gotweb1.example.com/
138 server "gotweb1.example.com" {
140 root "/htdocs/gotwebd"
142 fastcgi socket tcp localhost 9000
146 # hosting multiple gotwebd instances on the same HTTP server:
147 # http://gotweb2.example.com/gotwebd-unix/
148 # http://gotweb2.example.com/gotwebd-tcp/
149 server "gotweb2.example.com" {
151 location "/gotwebd-unix/" {
152 fastcgi socket "/run/gotweb.sock"
154 location "/gotwebd-unix/*" {
155 root "/htdocs/gotwebd"
158 location "/gotwebd-tcp/" {
159 fastcgi socket tcp 127.0.0.1 9000
161 location "/gotwebd-tcp/*" {
162 root "/htdocs/gotwebd"
169 .Xr git-repository 5 ,
174 .An Omar Polo Aq Mt op@openbsd.org
175 .An Stefan Sperling Aq Mt stsp@openbsd.org
176 .An Tracey Emery Aq Mt tracey@traceyemery.net