Blame


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