Blame


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