NAME

gotweb — Game of + Trees Git repository server for web browsers

SYNOPSIS

+ + + + + +

gotweb

DESCRIPTION

gotweb provides a web interface allowing + Git repository contents to be viewed with a web browser.

gotweb is a CGI program based on + got(1) and kcgi(3) which is intended to + run in a chroot(2) environment in + /var/www. The program has been designed to work out + of the box with the httpd(8) web server in conjunction + with slowcgi(8).

Enabling gotweb requires the following + steps:

The httpd.conf(5) configuration file must be adjusted to + run gotweb as a CGI program with + slowcgi(8). The + EXAMPLES section below contains an + appropriate configuration file sample.

httpd(8) and slowcgi(8) must be enabled and started: +

+  # rcctl enable httpd slowcgi
+  # rcctl start httpd slowcgi
+

Optionally, the run-time behaviour of gotweb can + be configured via the gotweb.conf(5) configuration + file.
Git repositories must be created at a suitable location inside the web + server's chroot(2) environment. These repositories + should not be writable by the user ID of the + httpd(8) server. The default location for repositories + published by gotweb is + /var/www/got/public.
Git repositories served by gotweb should be kept + up-to-date with a mechanism such as git-fetch(1) or + rsync(1), scheduled by cron(8).

FILES

/var/www/got/public/: Default location for Git repositories served by + gotweb. This location can be adjusted in the + gotweb.conf(5) configuration file.
/var/www/cgi-bin/gotweb/gotweb: The gotweb CGI program, statically linked for use + in a chroot(2) environment.
/var/www/cgi-bin/gotweb/gw_tmpl/: Directory for template files used by gotweb.
/var/www/cgi-bin/gotweb/libexec/: Directory containing statically linked got(1) helper + programs which are run by gotweb to read Git + repositories.
/var/www/htdocs/gotweb/: Directory containing HTML, CSS, and image files used by + gotweb.
/var/www/got/tmp/: Directory for temporary files created by + gotweb.

EXAMPLES

Example configuration for httpd.conf:

+
+  types { include "/usr/share/misc/mime.types" }
+  server "gotweb.example.com" {
+  	listen on * port 80
+  	root "/htdocs/gotweb"
+  	location "/cgi-bin/*" {
+  		root "/"
+  		fastcgi
+  	}
+  	location "/*" {
+  		directory index "index.html"
+  	}
+  }
+

SEE + ALSO

got(1), kcgi(3), + git-repository(5), gotweb.conf(5), + httpd(8), slowcgi(8)

AUTHORS

Tracey Emery + <tracey@traceyemery.net> +
+ Stefan Sperling + <stsp@openbsd.org>

NAME

gotweb.conf — + gotweb configuration file

DESCRIPTION

gotweb.conf is the run-time configuration + file for gotweb(8).

The file format is line-based, with one configuration directive + per line. Any lines beginning with a ‘#’ are treated as + comments and ignored.

Paths mentioned in gotweb.conf must be + relative to /var/www, the + chroot(2) environment of httpd(8).

GLOBAL + CONFIGURATION

The available configuration directives are as follows:

got_max_commits_display + number

Set the maximum amount of commits displayed per page.

got_logo + path

Set the path to an image file containing a logo to be displayed.

got_logo_url + url

Set a hyperlink for the logo.

got_max_repos + number

Set the maximum amount of repositories gotweb(8) will + work with.

got_max_repos_display + number

Set the maximum amount of repositories displayed on the index screen.

got_show_repo_age + on | off

Toggle display of last repository modification date.

got_show_repo_cloneurl + on | off

Toggle display of clone URLs for a repository. This requires the creation + of a cloneurl file inside the repository which + contains one URL per line.

got_show_repo_description + on | off

Toggle display of the repository description. The + description file in the repository should be + updated with an appropriate description.

got_repos_path + path

Set the path to the directory which contains Git repositories that + gotweb(8) should publish.

got_show_repo_owner + on | off

Set whether to display the repository owner. Displaying the owner requires + owner information to be added to the config file + in the repository. gotweb(8) will parse owner + information from either a [gotweb] or a [gitweb] section. For example: +

+[gotweb]
+owner = "Your Name"
+

got_site_link + string

Set the displayed site link name for the index page.

got_site_name + string

Set the displayed site name title.

got_site_owner + string

Set the displayed site owner.

got_show_site_owner + on | off

Toggle display of the site owner.

EXAMPLES

These are the currently configurable items for + gotweb(8) with their default values.

+
+#
+# gotweb options
+# all paths relative to /var/www (httpd chroot jail)
+#
+
+got_repos_path			"/got/public"
+
+#got_max_repos			100
+#got_max_repos_display		25
+got_max_commits_display		50
+
+got_site_name			"my public repos"
+got_site_owner			"Got Owner"
+got_site_link			"repos"
+
+got_logo			"got.png"
+got_logo_url			"https://gameoftrees.org"
+
+# on by default
+#got_show_site_owner		off
+#got_show_repo_owner		off
+#got_show_repo_age		false
+#got_show_repo_description	no
+#got_show_repo_cloneurl		off
+

FILES

/var/www/etc/gotweb.conf: Location of the gotweb.conf configuration + file.

SEE + ALSO

got(1), gotweb(8)