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 configuration file for gotweb.
25 .Sh GLOBAL CONFIGURATION
26 Here are the settings that can be set globally:
27 .Bl -tag -width Ds
28 .It Ic got_commits_display Ar number
29 Set the maximum amount of log lines displayed.
30 .It Ic got_logo Ar string
31 Set the displayed logo.
32 .It Ic got_logo_url Ar string
33 Set the href link for the logo.
34 .It Ic got_max_repos Ar number
35 Set the maximum amount of repositories gotweb will work with.
36 .It Ic got_max_repos_display Ar number
37 Set the maximum amount of repositories displayed on the index screen.
38 .It Ic got_repo_age Ar string
39 Set whether to display the repository age, or not.
40 .It Ic got_repo_cloneurl Ar string
41 Set whether to display clone URLs for a repository.
42 This requires the creation of a cloneurl file in the repository.
43 .It Ic got_repo_description Ar string
44 Set whether to display the repository description, or not.
45 This requires the description file to be edited in the repository.
46 .It Ic got_repos_path Ar string
47 Set the default git repository path.
48 .It Ic got_repo_owner Ar string
49 Set whether to display the repository owner, or not.
50 This requires the owner to be added to the config file in the repository.
51 The gotweb code will parse either [gotweb] or [gitweb] owner information.
52 For example:
53 .Bd -literal -offset indent
54 [gotweb]
55 owner = "Your Name"
56 .Ed
57 .It Ic got_site_link Ar string
58 Set the displayed site link name for the index page.
59 .It Ic got_site_name Ar string
60 Set the displayed site name title.
61 .It Ic got_site_owner Ar string
62 Set the displayed site owner.
63 .It Ic got_show_site_owner Ar string
64 Set whether to display the site owner, or not.
65 .It Ic got_www_path Ar string
66 Set the public gotweb httpd path.
67 .El
68 .Sh EXAMPLES
69 These are the currently configurable items for Gotweb.
70 The configuration file gotweb.conf must be located at /var/www/etc/gotweb.conf.
71 .Bd -literal -offset indent
72 
73 #
74 # gotweb options
75 # all paths relative to /var/www (httpd chroot jail)
76 #
77 
78 got_repos_path			"/got/public"
79 got_www_path			"/gotweb"
80 
81 #got_max_repos			100
82 #got_max_repos_display		25
83 got_max_commits_display		50
84 
85 got_site_name			"my public repos"
86 got_site_owner			"Got Owner"
87 got_site_link			"repos"
88 
89 got_logo			"got.png"
90 got_logo_url			"https://gameoftrees.org"
91 
92 # on by default
93 #got_show_site_owner		off
94 #got_show_repo_owner		off
95 #got_show_repo_age		false
96 #got_show_repo_description	no
97 #got_show_repo_cloneurl		off
98 .Ed
99 .Sh FILES
100 .Bl -tag -width Ds -compact
101 .It Pa /var/www/etc/gotweb.conf
102 gotweb configuration file.
103 .El
104 .Sh SEE ALSO
105 .Xr got 1 ,
106 .Xr tog 1
107 .Sh HISTORY
108 The
109 .Nm
110 file format first appeared in
111 .Ox 6.7 .