Blame


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