GOTWEBD.CONF(5) File Formats Manual GOTWEBD.CONF(5)

gotwebd.confgotwebd configuration file

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

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

Macros can be defined that are later expanded in context. Macro names must start with a letter, digit, or underscore, and may contain any of those characters, but may not be reserved words. Macros are not expanded inside quotes. For example:

lan_addr = "192.168.0.1"
listen on $lan_addr port 9090

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

The available global configuration directives are as follows:

path
Set the path to the chroot(2) environment of httpd(8). If not specified, it defaults to /var/www, the home directory of the www user.
address port number
Configure an address and port for incoming FastCGI connections. Valid address arguments are hostnames, IPv4 and IPv6 addresses. The port argument may be number or a service name defined in services(5). May be specified multiple times to build up a list of listening sockets.
path
Configure a UNIX-domain socket for incoming FastCGI connections. May be specified multiple times to build up a list of listening sockets.
number
Run the specified number of server processes. gotwebd(8) runs 3 server processes by default.
user
Set the user which will run gotwebd(8). If not specified, the user www will be used.

If no listen directive is used, gotwebd(8) will listen on the UNIX-domain socket at /var/www/run/gotweb.sock.

At least one server context must exist for gotwebd(8) to function. In case no server context is defined in the configuration file, a default server context will be used which uses default parameters for all applicable settings.

A server context is declared with a unique name, followed by server-specific configuration directives inside curly braces:

server name {...}

The first server defined is used if the requested hostname is not matched by any server block.

The available server configuration directives are as follows:

path
Set the path to a custom Cascading Style Sheet (CSS) to be used. If this option is not specified then the default style sheet ‘gotweb.css’ will be used.
Set the path to an image file containing a logo to be displayed. Defaults to ‘got.png’.
url
Set a hyperlink for the logo. Defaults to https://gameoftrees.org.
number
Set the maximum amount of commits and tags displayed per page. Defaults to 25.
number
Set the maximum amount of repositories displayed on the index screen. Defaults to 25. Set to zero to show all the repositories without pagination.
path
Set the path to the directory which contains Git repositories that the server should publish. Defaults to /got/public under the chroot.
on | off
Set whether to display the repository only if it contains the magic git-daemon-export-ok file. Disabled by default.
on | off
Toggle display of last repository modification date. Enabled by default.
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. Enabled by default.
on | off
Toggle display of the repository description. Enabled by default. The description file in the repository should be updated with an appropriate description.
on | off
Set whether to display the repository owner. Enabled by default. Displaying the owner requires owner information to be added to the config file in the repository. gotwebd(8) will parse owner information from either a [gotweb] or a [gitweb] section. For example:
[gotweb]
owner = "Your Name"
Set the displayed site link name for the index page. Defaults to ‘Repos’.
string
Set the displayed site name title. Defaults to ‘Gotweb’.
string
Set the displayed site owner. Defaults to ‘Got Owner’.
on | off
Toggle display of the site owner. Enabled by default.
number
The maximum number of commits to show in the summary page. Defaults to 10.
number
The maximum number of tags to show in the summary page. Defaults to 3.

/etc/gotwebd.conf
Default location of the gotwebd.conf configuration file.
/var/www/run/gotweb.sock
Default location for the gotwebd(8) listening socket.

A sample configuration:

server "localhost" {
	site_name	"my public repos"
	site_owner	"Flan Hacker"
	site_link	"Flan' Projects"
}

Another example, this time listening on a local port instead of the implicit UNIX socket.

listen on 127.0.0.1 port 9000
listen on ::1 port 9000

server "localhost" {
	site_name "my public repos"
}

got(1), httpd.conf(5), services(5), gotwebd(8), httpd(8)

July 11, 2024 OpenBSD 7.5