commit b2c82ae21b340f042c71c9174e9c7093a5bbcbe3 from: Stefan Sperling date: Mon Feb 17 23:28:08 2020 UTC add gotweb man pages commit - 8b679b4bf15b84e71c5d2f610692ea08e197d87c commit + b2c82ae21b340f042c71c9174e9c7093a5bbcbe3 blob - /dev/null blob + d14ad9cb4effa9916d43ab163beb43c0e35a65fa (mode 644) --- /dev/null +++ gotweb.8.html @@ -0,0 +1,164 @@ + + + + + + + GOTWEB(8) + + + + + + + + +
GOTWEB(8)System Manager's ManualGOTWEB(8)
+
+
+

+

gotwebGame of + Trees Git repository server for web browsers

+
+
+

+ + + + + +
gotweb
+
+
+

+

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:

+
    +
  1. 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.
  2. +
  3. httpd(8) and slowcgi(8) must be enabled and started: +
    +
    +  # rcctl enable httpd slowcgi
    +  # rcctl start httpd slowcgi
    +    
    +
    +
  4. +
  5. Optionally, the run-time behaviour of gotweb can + be configured via the gotweb.conf(5) configuration + file.
  6. +
  7. 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.
  8. +
  9. 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).
  10. +
+
+
+

+
+
/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.
+
+
+
+

+

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"
+  	}
+  }
+
+
+
+
+

+

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

+
+
+

+

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

+
+
+ + + + + +
February 18, 2020OpenBSD 6.6
+ + blob - /dev/null blob + 7d48e8d1c5a989cf8872e915ff9abe05e4fcaf0a (mode 644) --- /dev/null +++ gotweb.conf.5.html @@ -0,0 +1,178 @@ + + + + + + + GOTWEB.CONF(5) + + + + + + + + +
GOTWEB.CONF(5)File Formats ManualGOTWEB.CONF(5)
+
+
+

+

gotweb.conf — + gotweb configuration file

+
+
+

+

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).

+
+
+

+

The available configuration directives are as follows:

+
+
+ number
+
Set the maximum amount of commits displayed per page.
+
+ path
+
Set the path to an image file containing a logo to be displayed.
+
+ url
+
Set a hyperlink for the logo.
+
+ number
+
Set the maximum amount of repositories gotweb(8) will + work with.
+
+ number
+
Set the maximum amount of repositories displayed on the index screen.
+
+ on | off
+
Toggle display of last repository modification date.
+
+ 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.
+
+ on | off
+
Toggle display of the repository description. The + description file in the repository should be + updated with an appropriate description.
+
+ path
+
Set the path to the directory which contains Git repositories that + gotweb(8) should publish.
+
+ 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"
+    
+
+
+
+ string
+
Set the displayed site link name for the index page.
+
+ string
+
Set the displayed site name title.
+
+ string
+
Set the displayed site owner.
+
+ on | off
+
Toggle display of the site owner.
+
+
+
+

+

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
+
+
+
+
+

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

+

got(1), gotweb(8)

+
+
+ + + + + +
January 15, 2020OpenBSD 6.6
+ + blob - 7cbf9a4ab4e63b94db7458c27834b71baf70a8da blob + ce90884a714ab964bad844cc07b04bc92d916519 --- manual.html +++ manual.html @@ -19,4 +19,6 @@ Manual Pages
  • tog — Git repository browser
  • got-worktree — Got work tree format
  • git-repository — Git repository format +
  • gotweb.conf — gotweb configuration file +
  • gotweb — Game of Trees Git repository server for web browsers blob - 78fa8a84ed8474003333c727ff2846e6e8985a10 blob + 7a41ef9aecfd0375136351d73c8b2d3ff607949e --- sync-man.sh +++ sync-man.sh @@ -4,5 +4,8 @@ for f in got.1 got-worktree.5 git-repository.5; do mandoc -T html $HOME/src/got/got/$f > ./${f}.html done mandoc -T html $HOME/src/got/tog/tog.1 > ./tog.1.html +for f in gotweb.8 gotweb.conf.5; do + mandoc -T html $HOME/src/got/gotweb/$f > ./${f}.html +done hg st --pager never --color never