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 FastCGI repository server for web browsers
25 .Op Fl D Ar macro Ns = Ns Ar value
29 is a FastCGI 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 Ns = Ns Ar value
46 Overrides the definition of
48 in the configuration file.
50 Set the path to the configuration file.
51 If not specified, the file
55 Parse the configuration file, report errors if any, and exit.
58 Verbosity increases if this option is used multiple times.
63 requires the following steps:
68 configuration file must be adjusted to run
70 as a FastCGI helper program.
73 section below contains an appropriate configuration file sample.
75 httpd(8) must be enabled and started:
76 .Bd -literal -offset indent
81 Optionally, the run-time behaviour of
83 can be configured via the
87 Git repositories must be created at a suitable location inside the
91 These repositories should
93 be writable by the user ID shared between
97 The default location for repositories published by
100 .Pa /var/www/got/public .
102 Git repositories served by
104 should be kept up-to-date with a mechanism such as
113 .Bl -tag -width /var/www/got/public/ -compact
114 .It Pa /etc/gotwebd.conf
115 Default location of the
118 .It Pa /var/www/got/public/
119 Default location for Git repositories served by
121 This location can be adjusted in the
124 .It Pa /var/www/bin/gotwebd/
125 Directory containing statically linked
127 helper programs which are run by
129 to read Git repositories.
130 .It Pa /var/www/htdocs/gotwebd/
131 Directory containing HTML, CSS, and image files used by
134 Directory for temporary files created by
138 Example configuration for
140 .Bd -literal -offset indent
141 types { include "/usr/share/misc/mime.types" }
143 # one gotwebd reachable at http://gotweb1.example.com/
144 server "gotweb1.example.com" {
146 root "/htdocs/gotwebd"
148 fastcgi socket "/run/gotweb.sock"
152 # hosting multiple gotwebd instances on the same HTTP server:
153 # http://gotweb2.example.com/gotwebd-unix/
154 # http://gotweb2.example.com/gotwebd-tcp/
155 server "gotweb2.example.com" {
157 location "/gotwebd-unix/" {
158 fastcgi socket "/run/gotweb.sock"
160 location "/gotwebd-unix/*" {
161 root "/htdocs/gotwebd"
164 location "/gotwebd-tcp/" {
165 fastcgi socket tcp 127.0.0.1 9000
167 location "/gotwebd-tcp/*" {
168 root "/htdocs/gotwebd"
175 .Xr git-repository 5 ,
180 .An Omar Polo Aq Mt op@openbsd.org
181 .An Stefan Sperling Aq Mt stsp@openbsd.org
182 .An Tracey Emery Aq Mt tracey@traceyemery.net