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.
got_www_path
string- Set the public gotweb httpd path.
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_www_path "/gotweb" #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.