1 .\"
2 .\" Copyright (c) 2020 Tracey Emery <tracey@traceyemery.net>
3 .\"
4 .\" Permission to use, copy, modify, and distribute this software for any
5 .\" purpose with or without fee is hereby granted, provided that the above
6 .\" copyright notice and this permission notice appear in all copies.
7 .\"
8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15 .\"
16 .Dd $Mdocdate: January 15 2020 $
17 .Dt GOTWEB.CONF 5
18 .Os
19 .Sh NAME
20 .Nm gotweb.conf
21 .Nd gotweb configuration file
22 .Sh DESCRIPTION
23 .Nm
24 is the run-time configuration file for
25 .Xr gotweb 8 .
26 .Pp
27 Paths mentioned in
28 .Nm
29 must be relative to
30 .Pa /var/www ,
31 the
32 .Xr chroot 2
33 environment of
34 .Xr httpd 8 .
35 .Sh GLOBAL CONFIGURATION
36 The available settings are as follows:
37 .Bl -tag -width Ds
38 .It Ic got_max_commits_display Ar number
39 Set the maximum amount of log lines displayed.
40 .It Ic got_logo Ar path
41 Set the path to an image file containing a logo to be displayed.
42 .It Ic got_logo_url Ar url
43 Set a hyperlink link for the logo.
44 .It Ic got_max_repos Ar number
45 Set the maximum amount of repositories gotweb will work with.
46 .It Ic got_max_repos_display Ar number
47 Set the maximum amount of repositories displayed on the index screen.
48 .It Ic got_show_repo_age Ar on | off
49 Toggle display of last repository modification date.
50 .It Ic got_show_repo_cloneurl Ar on | off
51 Toggle display of clone URLs for a repository.
52 This requires the creation of a
53 .Pa cloneurl
54 file inside the repository which contains one URL per line.
55 .It Ic got_show_repo_description Ar on | off
56 Toggle display of the repository description.
57 The
58 .Pa description
59 file in the repository should be updated with an appropriate description.
60 .It Ic got_repos_path Ar path
61 Set the path to the directory which contains Git repositories that
62 .Xr gotweb 8
63 should publish.
64 .It Ic got_show_repo_owner Ar on | off
65 Set whether to display the repository owner.
66 Displaying the owner requires owner information to be added to the
67 .Pa config
68 file in the repository.
69 The gotweb code will parse either [gotweb] or [gitweb] owner information.
70 For example:
71 .Bd -literal -offset indent
72 [gotweb]
73 owner = "Your Name"
74 .Ed
75 .It Ic got_site_link Ar string
76 Set the displayed site link name for the index page.
77 .It Ic got_site_name Ar string
78 Set the displayed site name title.
79 .It Ic got_site_owner Ar string
80 Set the displayed site owner.
81 .It Ic got_show_site_owner Ar on | off
82 Toggle display of the site owner.
83 .El
84 .Sh EXAMPLES
85 These are the currently configurable items for
86 .Xr gotweb 8
87 with their default values.
88 .Pp
89 The configuration file gotweb.conf must be located at /var/www/etc/gotweb.conf.
90 .Bd -literal -offset indent
91 
92 #
93 # gotweb options
94 # all paths relative to /var/www (httpd chroot jail)
95 #
96 
97 got_repos_path			"/got/public"
98 
99 #got_max_repos			100
100 #got_max_repos_display		25
101 got_max_commits_display		50
102 
103 got_site_name			"my public repos"
104 got_site_owner			"Got Owner"
105 got_site_link			"repos"
106 
107 got_logo			"got.png"
108 got_logo_url			"https://gameoftrees.org"
109 
110 # on by default
111 #got_show_site_owner		off
112 #got_show_repo_owner		off
113 #got_show_repo_age		false
114 #got_show_repo_description	no
115 #got_show_repo_cloneurl		off
116 .Ed
117 .Sh FILES
118 .Bl -tag -width Ds -compact
119 .It Pa /var/www/etc/gotweb.conf
120 gotweb configuration file.
121 .El
122 .Sh SEE ALSO
123 .Xr got 1 ,
124 .Xr gotweb 8