commit 270ebbdc1383b269d75f45d12e8dacc072df8538 from: Stefan Sperling date: Thu Jan 16 14:34:36 2020 UTC merge gotweb's README into top-level README; ok kn tracey commit - 6bee13de786cb52a98bb33a4a1cef191a240f962 commit + 270ebbdc1383b269d75f45d12e8dacc072df8538 blob - 94876ae5bc42e5a943600ed854570f3885868489 blob + 8f340f4d9512d927ed278f944b0fd4818defd389 --- README +++ README @@ -46,7 +46,43 @@ Man page files in the Got source tree can be viewed wi EXAMPLES in got.1 contains a quick-start guide for OpenBSD developers. +Game of Trees Web (Gotweb) is a CGI program which displays repository data +and is designed to work with httpd(8). +To compile gotweb on OpenBSD, run: + + # pkg_add kcgi + $ make web + # make web-install + +This will create the following files: + the CGI program /var/www/cgi-bin/gotweb/gotweb + helper programs from the libexec directory in /var/www/cgi-bin/gotweb/libexec + several template files in /var/www/cgi-bin/gw_tmpl/ + html, css, and image files in /var/www/htdocs/gotweb/gotweb/ + the directory /var/www/tmp/ + man pages (only installed if building sources from a Got release tarball) + +Example configuration for httpd.conf: + + types { include "/usr/share/misc/mime.types" } + server "localhost" { + listen on * port 80 + root "/htdocs/gotweb" + location "/cgi-bin/*" { + root "/" + fastcgi + } + location "/*" { + directory index "index.html" + } + } + +Gotweb's run-time behaviour can be configured in the gotweb.conf file: + + $ man -l gotweb/gotweb.conf.5 + + Guidelines for reporting problems: All problem/bug reports should include a reproduction recipe in form of a blob - b91a7673b394570cea7dcb6eed8e2d9ede1197b5 (mode 644) blob + /dev/null --- gotweb/README +++ /dev/null @@ -1,53 +0,0 @@ -Game of Trees Web (Gotweb) is a read-only web front-end for Got. - -Gotweb is still under development; it is being developed exclusively -on OpenBSD and its target audience are OpenBSD developers. Gotweb is -ISC-licensed and was designed with pledge(2) and unveil(2) in mind. - -Gotweb uses bare Git repositories to read versioned data and is designed to -work with httpd(8). - -To compile the Gotweb tool suite on OpenBSD, run: - - $ make web - # make web-install - -This will install Gotweb and all the required files to /var/www by default. - -Man page files in the Gotweb source tree can be viewed with 'man -l': - - $ man -l gotweb/gotweb.conf.5 - -Example configuration for httpd.conf: - -ext_if = "*" - -types { include "/usr/share/misc/mime.types" } - -server "localhost" { - listen on $ext_if port 80 - - root "/htdocs/gotweb" - - location "/cgi-bin/*" { - root "/" - fastcgi - } - location "/*" { - directory index "index.html" - } -} - -Guidelines for submitting patches: - -Mail patches to: gameoftrees@openbsd.org -Pull requests via any Git hosting sites will likely be overlooked. -Please keep the intended target audience in mind when contributing to Gotweb. - -Subscribing to the gameoftrees@openbsd.org mailing list: - -The mailing list is used for patch reviews, bug reports, and user questions. -To subscribe, send mail to majordomo@openbsd.org with a message body of: -subscribe gameoftrees - -See https://www.openbsd.org/mail.html for more information.