2 a596b957 2022-07-14 tracey .\" Copyright (c) 2020 Tracey Emery <tracey@traceyemery.net>
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.
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.
16 a596b957 2022-07-14 tracey .Dd $Mdocdate$
17 59975c69 2022-08-29 stsp .Dt GOTWEBD.CONF 5
20 59975c69 2022-08-29 stsp .Nm gotwebd.conf
21 59975c69 2022-08-29 stsp .Nd gotwebd configuration file
22 a596b957 2022-07-14 tracey .Sh DESCRIPTION
24 a596b957 2022-07-14 tracey is the run-time configuration file for
25 59975c69 2022-08-29 stsp .Xr gotwebd 8 .
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
30 a596b957 2022-07-14 tracey are treated as comments and ignored.
32 47b307cd 2022-10-02 op Macros can be defined that are later expanded in context.
33 47b307cd 2022-10-02 op Macro names must start with a letter, digit, or underscore, and may
34 47b307cd 2022-10-02 op contain any of those characters, but may not be reserved words.
35 47b307cd 2022-10-02 op Macros are not expanded inside quotes.
37 47b307cd 2022-10-02 op .Bd -literal -offset indent
38 47b307cd 2022-10-02 op lan_addr = "192.168.0.1"
39 f497614d 2023-12-29 op listen on $lan_addr port 9090
42 a596b957 2022-07-14 tracey Paths mentioned in
44 a596b957 2022-07-14 tracey must be relative to
45 a596b957 2022-07-14 tracey .Pa /var/www ,
47 a596b957 2022-07-14 tracey .Xr chroot 2
48 a596b957 2022-07-14 tracey environment of
49 a596b957 2022-07-14 tracey .Xr httpd 8 .
50 a596b957 2022-07-14 tracey .Sh GLOBAL CONFIGURATION
51 0dd80998 2022-08-29 stsp The available global configuration directives are as follows:
52 a596b957 2022-07-14 tracey .Bl -tag -width Ds
53 59975c69 2022-08-29 stsp .It Ic chroot Ar path
54 59975c69 2022-08-29 stsp Set the path to the
55 59975c69 2022-08-29 stsp .Xr chroot 2
56 59975c69 2022-08-29 stsp environment of
57 59975c69 2022-08-29 stsp .Xr httpd 8 .
58 59975c69 2022-08-29 stsp If not specified then
59 59975c69 2022-08-29 stsp .Pa /var/www
60 59975c69 2022-08-29 stsp will be used.
61 0dd80998 2022-08-29 stsp .It Ic prefork Ar number
62 0dd80998 2022-08-29 stsp Run the specified number of server processes.
64 f497614d 2023-12-29 op runs 3 server processes by default.
65 0dd80998 2022-08-29 stsp .It Ic unix_socket Ar on | off
66 0dd80998 2022-08-29 stsp Controls whether the servers will listen on unix sockets by default.
67 f497614d 2023-12-29 op Listening on unix sockets is the default.
68 0dd80998 2022-08-29 stsp .It Ic unix_socket_name Ar path
69 0dd80998 2022-08-29 stsp Set the path to the default unix socket.
71 f497614d 2023-12-29 op .Pa /var/www/run/gotweb.sock .
73 0dd80998 2022-08-29 stsp .Sh SERVER CONFIGURATION
74 0dd80998 2022-08-29 stsp At least one server context must exist for
75 0dd80998 2022-08-29 stsp .Xr gotwebd 8
76 0dd80998 2022-08-29 stsp to function.
77 0dd80998 2022-08-29 stsp In case no server context is defined in the configuration file, a default
78 0dd80998 2022-08-29 stsp server context will be used, which listens on a unix socket at
79 0dd80998 2022-08-29 stsp .Pa /var/www/run/gotweb.sock
80 0dd80998 2022-08-29 stsp and uses default parameters for all applicable settings.
82 0dd80998 2022-08-29 stsp A server context is declared with a unique
84 0dd80998 2022-08-29 stsp followed by server-specific configuration directives inside curly braces:
86 0dd80998 2022-08-29 stsp .Ic server Ar name Brq ...
88 c8af7691 2023-06-22 op The first server defined is used if the requested hostname is not
89 c8af7691 2023-06-22 op matched by any server block.
91 0dd80998 2022-08-29 stsp The available server configuration directives are as follows:
92 0dd80998 2022-08-29 stsp .Bl -tag -width Ds
93 59975c69 2022-08-29 stsp .It Ic custom_css Ar path
94 59975c69 2022-08-29 stsp Set the path to a custom Cascading Style Sheet (CSS) to be used.
95 f497614d 2023-12-29 op If this option is not specified then the default style sheet
96 f497614d 2023-12-29 op .Sq gotweb.css
98 59975c69 2022-08-29 stsp .It Ic listen on Ar address Ic port Ar number
99 f497614d 2023-12-29 op Configure an address and port for incoming FastCGI connections.
101 0dd80998 2022-08-29 stsp .Ar address
102 f497614d 2023-12-29 op arguments are hostnames, IPv4 and IPv6 addresses.
105 0dd80998 2022-08-29 stsp argument may be number or a service name defined in
106 0dd80998 2022-08-29 stsp .Xr services 5 .
108 0dd80998 2022-08-29 stsp May be specified multiple times to build up a list of listening sockets.
109 0dd80998 2022-08-29 stsp However, a given combination of address and port may only be used by
110 0dd80998 2022-08-29 stsp one server.
111 3a1c1a1b 2023-01-04 op .It Ic listen on socket off
112 3a1c1a1b 2023-01-04 op Disable use of unix socket.
113 3a1c1a1b 2023-01-04 op .It Ic listen on socket Ar path
114 3a1c1a1b 2023-01-04 op Set the path to the unix socket used by the server.
115 59975c69 2022-08-29 stsp .It Ic logo Ar path
116 a596b957 2022-07-14 tracey Set the path to an image file containing a logo to be displayed.
118 f497614d 2023-12-29 op .Sq got.png .
119 59975c69 2022-08-29 stsp .It Ic logo_url Ar url
120 a596b957 2022-07-14 tracey Set a hyperlink for the logo.
122 f497614d 2023-12-29 op .Lk https://gameoftrees.org .
123 59975c69 2022-08-29 stsp .It Ic max_commits_display Ar number
124 f497614d 2023-12-29 op Set the maximum amount of commits and tags displayed per page.
125 f497614d 2023-12-29 op Defaults to 25.
126 59975c69 2022-08-29 stsp .It Ic max_repos_display Ar number
127 a596b957 2022-07-14 tracey Set the maximum amount of repositories displayed on the index screen.
128 f497614d 2023-12-29 op Defaults to 25.
129 f497614d 2023-12-29 op Set to zero to show all the repositories without pagination.
130 59975c69 2022-08-29 stsp .It Ic repos_path Ar path
131 59975c69 2022-08-29 stsp Set the path to the directory which contains Git repositories that
132 0dd80998 2022-08-29 stsp the server should publish.
134 f497614d 2023-12-29 op .Pa /run/gotwebd.sock
135 f497614d 2023-12-29 op under the chroot.
136 d5996b9e 2022-10-31 landry .It Ic respect_exportok Ar on | off
137 d5996b9e 2022-10-31 landry Set whether to display the repository only if it contains the magic
138 d5996b9e 2022-10-31 landry .Pa git-daemon-export-ok
140 f497614d 2023-12-29 op Disabled by default.
141 59975c69 2022-08-29 stsp .It Ic show_repo_age Ar on | off
142 a596b957 2022-07-14 tracey Toggle display of last repository modification date.
143 f497614d 2023-12-29 op Enabled by default.
144 59975c69 2022-08-29 stsp .It Ic show_repo_cloneurl Ar on | off
145 a596b957 2022-07-14 tracey Toggle display of clone URLs for a repository.
146 a596b957 2022-07-14 tracey This requires the creation of a
147 a596b957 2022-07-14 tracey .Pa cloneurl
148 a596b957 2022-07-14 tracey file inside the repository which contains one URL per line.
149 f497614d 2023-12-29 op Enabled by default.
150 59975c69 2022-08-29 stsp .It Ic show_repo_description Ar on | off
151 a596b957 2022-07-14 tracey Toggle display of the repository description.
152 f497614d 2023-12-29 op Enabled by default.
154 a596b957 2022-07-14 tracey .Pa description
155 a596b957 2022-07-14 tracey file in the repository should be updated with an appropriate description.
156 59975c69 2022-08-29 stsp .It Ic show_repo_owner Ar on | off
157 a596b957 2022-07-14 tracey Set whether to display the repository owner.
158 f497614d 2023-12-29 op Enabled by default.
159 a596b957 2022-07-14 tracey Displaying the owner requires owner information to be added to the
160 a596b957 2022-07-14 tracey .Pa config
161 a596b957 2022-07-14 tracey file in the repository.
162 59975c69 2022-08-29 stsp .Xr gotwebd 8
163 a596b957 2022-07-14 tracey will parse owner information from either a [gotweb] or a [gitweb] section.
164 a596b957 2022-07-14 tracey For example:
165 a596b957 2022-07-14 tracey .Bd -literal -offset indent
167 a596b957 2022-07-14 tracey owner = "Your Name"
169 59975c69 2022-08-29 stsp .It Ic site_link Ar string
170 a596b957 2022-07-14 tracey Set the displayed site link name for the index page.
173 59975c69 2022-08-29 stsp .It Ic site_name Ar string
174 a596b957 2022-07-14 tracey Set the displayed site name title.
177 59975c69 2022-08-29 stsp .It Ic site_owner Ar string
178 a596b957 2022-07-14 tracey Set the displayed site owner.
180 f497614d 2023-12-29 op .Sq Got Owner .
181 59975c69 2022-08-29 stsp .It Ic show_site_owner Ar on | off
182 a596b957 2022-07-14 tracey Toggle display of the site owner.
183 f497614d 2023-12-29 op Enabled by default.
184 8762929a 2023-12-29 op .It Ic summary_commits_display Ar number
185 8762929a 2023-12-29 op The maximum number of commits to show in the summary page.
186 f497614d 2023-12-29 op Defaults to 10.
187 8762929a 2023-12-29 op .It Ic summary_tags_display Ar number
188 8762929a 2023-12-29 op The maximum number of tags to show in the summary page.
189 f497614d 2023-12-29 op Defaults to 3.
192 d375d894 2022-11-14 op .Bl -tag -width Ds -compact
193 d375d894 2022-11-14 op .It Pa /etc/gotwebd.conf
194 d375d894 2022-11-14 op Default location of the
196 d375d894 2022-11-14 op configuration file.
198 a596b957 2022-07-14 tracey .Sh EXAMPLES
199 f497614d 2023-12-29 op A sample configuration:
200 a596b957 2022-07-14 tracey .Bd -literal -offset indent
201 f497614d 2023-12-29 op server "localhost" {
202 f497614d 2023-12-29 op site_name "my public repos"
203 f497614d 2023-12-29 op site_owner "Flan Hacker"
204 f497614d 2023-12-29 op site_link "Flan' Projects"
208 f497614d 2023-12-29 op Another example, this time listening on a local port instead of the
212 f497614d 2023-12-29 op .Bd -literal -offset indent
213 f497614d 2023-12-29 op server "localhost" {
214 f497614d 2023-12-29 op listen on socket off
215 f497614d 2023-12-29 op listen on 127.0.0.1 port 9000
216 f497614d 2023-12-29 op listen on ::1 port 9000
219 a596b957 2022-07-14 tracey .Sh SEE ALSO
220 a596b957 2022-07-14 tracey .Xr got 1 ,
221 e0e2a861 2022-08-30 stsp .Xr httpd.conf 5 ,
222 0dd80998 2022-08-29 stsp .Xr services 5 ,
223 e0e2a861 2022-08-30 stsp .Xr gotwebd 8 ,
224 e0e2a861 2022-08-30 stsp .Xr httpd 8
