1 c08369d7 2020-01-15 tracey Game of Trees Web (Gotweb) is a read-only web front-end for Got.
 2 14b96325 2020-01-15 tracey 
 3 14b96325 2020-01-15 tracey Gotweb is still under development; it is being developed exclusively
 4 14b96325 2020-01-15 tracey on OpenBSD and its target audience are OpenBSD developers. Gotweb is
 5 14b96325 2020-01-15 tracey ISC-licensed and was designed with pledge(2) and unveil(2) in mind.
 6 14b96325 2020-01-15 tracey 
 7 14b96325 2020-01-15 tracey Gotweb uses bare Git repositories to read versioned data and is designed to
 8 14b96325 2020-01-15 tracey work with httpd(8).
 9 14b96325 2020-01-15 tracey 
10 14b96325 2020-01-15 tracey To compile the Gotweb tool suite on OpenBSD, run:
11 14b96325 2020-01-15 tracey 
12 14b96325 2020-01-15 tracey  $ make web
13 14b96325 2020-01-15 tracey  # make web-install
14 14b96325 2020-01-15 tracey 
15 14b96325 2020-01-15 tracey This will install Gotweb and all the required files to /var/www by default.
16 14b96325 2020-01-15 tracey 
17 14b96325 2020-01-15 tracey Man page files in the Gotweb source tree can be viewed with 'man -l':
18 14b96325 2020-01-15 tracey 
19 14b96325 2020-01-15 tracey  $ man -l gotweb/gotweb.conf.5
20 14b96325 2020-01-15 tracey 
21 14b96325 2020-01-15 tracey Example configuration for httpd.conf:
22 14b96325 2020-01-15 tracey 
23 14b96325 2020-01-15 tracey ext_if = "*"
24 14b96325 2020-01-15 tracey 
25 14b96325 2020-01-15 tracey types { include "/usr/share/misc/mime.types" }
26 14b96325 2020-01-15 tracey 
27 14b96325 2020-01-15 tracey server "localhost" {
28 14b96325 2020-01-15 tracey 	listen on $ext_if port 80
29 14b96325 2020-01-15 tracey 
30 14b96325 2020-01-15 tracey 	root "/htdocs/gotweb"
31 14b96325 2020-01-15 tracey 
32 14b96325 2020-01-15 tracey 	location "/cgi-bin/*" {
33 14b96325 2020-01-15 tracey 		root "/"
34 14b96325 2020-01-15 tracey 		fastcgi
35 14b96325 2020-01-15 tracey 	}
36 14b96325 2020-01-15 tracey 	location "/*" {
37 14b96325 2020-01-15 tracey 		directory index "index.html"
38 14b96325 2020-01-15 tracey 	}
39 14b96325 2020-01-15 tracey }
40 14b96325 2020-01-15 tracey 
41 14b96325 2020-01-15 tracey Guidelines for submitting patches:
42 14b96325 2020-01-15 tracey 
43 14b96325 2020-01-15 tracey Mail patches to: gameoftrees@openbsd.org
44 14b96325 2020-01-15 tracey Pull requests via any Git hosting sites will likely be overlooked.
45 14b96325 2020-01-15 tracey Please keep the intended target audience in mind when contributing to Gotweb.
46 14b96325 2020-01-15 tracey 
47 14b96325 2020-01-15 tracey Subscribing to the gameoftrees@openbsd.org mailing list:
48 14b96325 2020-01-15 tracey 
49 14b96325 2020-01-15 tracey The mailing list is used for patch reviews, bug reports, and user questions.
50 14b96325 2020-01-15 tracey To subscribe, send mail to majordomo@openbsd.org with a message body of:
51 14b96325 2020-01-15 tracey subscribe gameoftrees
52 14b96325 2020-01-15 tracey 
53 14b96325 2020-01-15 tracey See https://www.openbsd.org/mail.html for more information.