2 8a35f56c 2022-07-16 thomas .\" Copyright (c) 2020 Tracey Emery <tracey@traceyemery.net>
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.
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.
16 8a35f56c 2022-07-16 thomas .Dd $Mdocdate$
17 55331ef5 2022-08-30 thomas .Dt GOTWEBD.CONF 5
20 55331ef5 2022-08-30 thomas .Nm gotwebd.conf
21 55331ef5 2022-08-30 thomas .Nd gotwebd configuration file
22 8a35f56c 2022-07-16 thomas .Sh DESCRIPTION
24 8a35f56c 2022-07-16 thomas is the run-time configuration file for
25 55331ef5 2022-08-30 thomas .Xr gotwebd 8 .
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
30 8a35f56c 2022-07-16 thomas are treated as comments and ignored.
32 cfab1835 2022-10-04 thomas Macros can be defined that are later expanded in context.
33 cfab1835 2022-10-04 thomas Macro names must start with a letter, digit, or underscore, and may
34 cfab1835 2022-10-04 thomas contain any of those characters, but may not be reserved words.
35 cfab1835 2022-10-04 thomas Macros are not expanded inside quotes.
36 cfab1835 2022-10-04 thomas For example:
37 cfab1835 2022-10-04 thomas .Bd -literal -offset indent
38 cfab1835 2022-10-04 thomas lan_addr = "192.168.0.1"
39 cfab1835 2022-10-04 thomas listen on $lan_addr
42 8a35f56c 2022-07-16 thomas Paths mentioned in
44 8a35f56c 2022-07-16 thomas must be relative to
45 8a35f56c 2022-07-16 thomas .Pa /var/www ,
47 8a35f56c 2022-07-16 thomas .Xr chroot 2
48 8a35f56c 2022-07-16 thomas environment of
49 8a35f56c 2022-07-16 thomas .Xr httpd 8 .
50 8a35f56c 2022-07-16 thomas .Sh GLOBAL CONFIGURATION
51 cf5878ee 2022-08-30 thomas The available global configuration directives are as follows:
52 8a35f56c 2022-07-16 thomas .Bl -tag -width Ds
53 55331ef5 2022-08-30 thomas .It Ic chroot Ar path
54 55331ef5 2022-08-30 thomas Set the path to the
55 55331ef5 2022-08-30 thomas .Xr chroot 2
56 55331ef5 2022-08-30 thomas environment of
57 55331ef5 2022-08-30 thomas .Xr httpd 8 .
58 55331ef5 2022-08-30 thomas If not specified then
59 55331ef5 2022-08-30 thomas .Pa /var/www
60 55331ef5 2022-08-30 thomas will be used.
61 cf5878ee 2022-08-30 thomas .It Ic prefork Ar number
62 cf5878ee 2022-08-30 thomas Run the specified number of server processes.
63 cf5878ee 2022-08-30 thomas .It Ic unix_socket Ar on | off
64 cf5878ee 2022-08-30 thomas Controls whether the servers will listen on unix sockets by default.
65 cf5878ee 2022-08-30 thomas .It Ic unix_socket_name Ar path
66 cf5878ee 2022-08-30 thomas Set the path to the default unix socket.
68 cf5878ee 2022-08-30 thomas .Sh SERVER CONFIGURATION
69 cf5878ee 2022-08-30 thomas At least one server context must exist for
70 cf5878ee 2022-08-30 thomas .Xr gotwebd 8
71 cf5878ee 2022-08-30 thomas to function.
72 cf5878ee 2022-08-30 thomas In case no server context is defined in the configuration file, a default
73 cf5878ee 2022-08-30 thomas server context will be used, which listens on a unix socket at
74 cf5878ee 2022-08-30 thomas .Pa /var/www/run/gotweb.sock
75 cf5878ee 2022-08-30 thomas and uses default parameters for all applicable settings.
77 cf5878ee 2022-08-30 thomas A server context is declared with a unique
78 a568bf72 2022-08-30 thomas .Ar name ,
79 cf5878ee 2022-08-30 thomas followed by server-specific configuration directives inside curly braces:
81 cf5878ee 2022-08-30 thomas .Ic server Ar name Brq ...
83 211ff89e 2022-08-30 thomas .Xr gotwebd 8
84 211ff89e 2022-08-30 thomas is compatible with TLS Server Name Indication (SNI), provided the
86 211ff89e 2022-08-30 thomas of a server defined in
88 211ff89e 2022-08-30 thomas corresponds to the name of a server defined in
89 211ff89e 2022-08-30 thomas .Xr httpd.conf 5 .
91 cf5878ee 2022-08-30 thomas The available server configuration directives are as follows:
92 cf5878ee 2022-08-30 thomas .Bl -tag -width Ds
93 55331ef5 2022-08-30 thomas .It Ic custom_css Ar path
94 55331ef5 2022-08-30 thomas Set the path to a custom Cascading Style Sheet (CSS) to be used.
95 cf5878ee 2022-08-30 thomas If this option is not specified then a default style sheet will be used.
96 55331ef5 2022-08-30 thomas .It Ic listen on Ar address Ic port Ar number
97 cf5878ee 2022-08-30 thomas Configure an address and port for incoming FCGI TCP connections.
99 cf5878ee 2022-08-30 thomas .Ar address
100 cf5878ee 2022-08-30 thomas arguments are hostnames, IP4 addresses, IPv6 addresses, and network
101 cf5878ee 2022-08-30 thomas interface names.
104 cf5878ee 2022-08-30 thomas argument may be number or a service name defined in
105 cf5878ee 2022-08-30 thomas .Xr services 5 .
107 cf5878ee 2022-08-30 thomas May be specified multiple times to build up a list of listening sockets.
108 cf5878ee 2022-08-30 thomas However, a given combination of address and port may only be used by
109 cf5878ee 2022-08-30 thomas one server.
111 a8bfd781 2022-09-23 thomas If a network interface name is given as
112 a8bfd781 2022-09-23 thomas .Ar address
113 a8bfd781 2022-09-23 thomas argument then
114 a8bfd781 2022-09-23 thomas .Xr gotwebd 8
115 a8bfd781 2022-09-23 thomas will obtain the list of addresses on this interface only on startup.
116 a8bfd781 2022-09-23 thomas Any future changes to the address configuration of the interface will
117 a8bfd781 2022-09-23 thomas be ignored.
118 55331ef5 2022-08-30 thomas .It Ic logo Ar path
119 8a35f56c 2022-07-16 thomas Set the path to an image file containing a logo to be displayed.
120 55331ef5 2022-08-30 thomas .It Ic logo_url Ar url
121 8a35f56c 2022-07-16 thomas Set a hyperlink for the logo.
122 55331ef5 2022-08-30 thomas .It Ic max_commits_display Ar number
123 55331ef5 2022-08-30 thomas Set the maximum amount of commits displayed per page.
124 55331ef5 2022-08-30 thomas .It Ic max_repos Ar number
125 8a35f56c 2022-07-16 thomas Set the maximum amount of repositories
126 55331ef5 2022-08-30 thomas .Xr gotwebd 8
127 8a35f56c 2022-07-16 thomas will work with.
128 55331ef5 2022-08-30 thomas .It Ic max_repos_display Ar number
129 8a35f56c 2022-07-16 thomas Set the maximum amount of repositories displayed on the index screen.
130 55331ef5 2022-08-30 thomas .It Ic repos_path Ar path
131 55331ef5 2022-08-30 thomas Set the path to the directory which contains Git repositories that
132 cf5878ee 2022-08-30 thomas the server should publish.
133 55331ef5 2022-08-30 thomas .It Ic show_repo_age Ar on | off
134 8a35f56c 2022-07-16 thomas Toggle display of last repository modification date.
135 55331ef5 2022-08-30 thomas .It Ic show_repo_cloneurl Ar on | off
136 8a35f56c 2022-07-16 thomas Toggle display of clone URLs for a repository.
137 8a35f56c 2022-07-16 thomas This requires the creation of a
138 8a35f56c 2022-07-16 thomas .Pa cloneurl
139 8a35f56c 2022-07-16 thomas file inside the repository which contains one URL per line.
140 55331ef5 2022-08-30 thomas .It Ic show_repo_description Ar on | off
141 8a35f56c 2022-07-16 thomas Toggle display of the repository description.
143 8a35f56c 2022-07-16 thomas .Pa description
144 8a35f56c 2022-07-16 thomas file in the repository should be updated with an appropriate description.
145 55331ef5 2022-08-30 thomas .It Ic show_repo_owner Ar on | off
146 8a35f56c 2022-07-16 thomas Set whether to display the repository owner.
147 8a35f56c 2022-07-16 thomas Displaying the owner requires owner information to be added to the
148 8a35f56c 2022-07-16 thomas .Pa config
149 8a35f56c 2022-07-16 thomas file in the repository.
150 55331ef5 2022-08-30 thomas .Xr gotwebd 8
151 8a35f56c 2022-07-16 thomas will parse owner information from either a [gotweb] or a [gitweb] section.
152 8a35f56c 2022-07-16 thomas For example:
153 8a35f56c 2022-07-16 thomas .Bd -literal -offset indent
155 8a35f56c 2022-07-16 thomas owner = "Your Name"
157 55331ef5 2022-08-30 thomas .It Ic site_link Ar string
158 8a35f56c 2022-07-16 thomas Set the displayed site link name for the index page.
159 55331ef5 2022-08-30 thomas .It Ic site_name Ar string
160 8a35f56c 2022-07-16 thomas Set the displayed site name title.
161 55331ef5 2022-08-30 thomas .It Ic site_owner Ar string
162 8a35f56c 2022-07-16 thomas Set the displayed site owner.
163 55331ef5 2022-08-30 thomas .It Ic show_site_owner Ar on | off
164 8a35f56c 2022-07-16 thomas Toggle display of the site owner.
165 55331ef5 2022-08-30 thomas .It Ic unix_socket Ar on | off
166 cf5878ee 2022-08-30 thomas Enable or disable use of unix sockets.
167 55331ef5 2022-08-30 thomas .It Ic unix_socket_name Ar path
168 cf5878ee 2022-08-30 thomas Set the path to the unix socket used by the server.
170 8a35f56c 2022-07-16 thomas .Sh EXAMPLES
171 8a35f56c 2022-07-16 thomas These are the currently configurable items for
172 55331ef5 2022-08-30 thomas .Xr gotwebd 8
173 8a35f56c 2022-07-16 thomas with their default values.
174 8a35f56c 2022-07-16 thomas .Bd -literal -offset indent
176 55331ef5 2022-08-30 thomas # gotwebd options
177 8a35f56c 2022-07-16 thomas # all paths relative to /var/www (httpd chroot jail)
180 55331ef5 2022-08-30 thomas prefork 1
182 55331ef5 2022-08-30 thomas server "localhost-unix" {
183 55331ef5 2022-08-30 thomas repos_path "/got/public"
184 55331ef5 2022-08-30 thomas unix_socket_name "/run/gotweb.sock"
186 cf5878ee 2022-08-30 thomas got_site_name "my public repos"
187 cf5878ee 2022-08-30 thomas got_site_owner "Got Owner"
188 cf5878ee 2022-08-30 thomas got_site_link "repos"
190 cf5878ee 2022-08-30 thomas logo "got.png"
191 cf5878ee 2022-08-30 thomas logo_url "https://gameoftrees.org"
193 cf5878ee 2022-08-30 thomas # on by default
194 cf5878ee 2022-08-30 thomas #show_site_owner off
195 cf5878ee 2022-08-30 thomas #show_repo_owner off
196 cf5878ee 2022-08-30 thomas #show_repo_age false
197 cf5878ee 2022-08-30 thomas #show_repo_description no
198 cf5878ee 2022-08-30 thomas #show_repo_cloneurl off
200 cf5878ee 2022-08-30 thomas #max_repos 100
201 cf5878ee 2022-08-30 thomas #max_repos_display 25
202 cf5878ee 2022-08-30 thomas #max_commits_display 50
205 55331ef5 2022-08-30 thomas # Example server context for FCGI over TCP connections:
206 55331ef5 2022-08-30 thomas #server "localhost-tcp" {
207 55331ef5 2022-08-30 thomas # repos_path "/got/public"
208 55331ef5 2022-08-30 thomas # unix_socket off
209 55331ef5 2022-08-30 thomas # listen on 127.0.0.1 port 9000
210 55331ef5 2022-08-30 thomas # listen on ::1 port 9000
213 8a35f56c 2022-07-16 thomas .Sh FILES
214 8a35f56c 2022-07-16 thomas .Bl -tag -width Ds -compact
215 380f0955 2022-09-07 thomas .It Pa /etc/gotwebd.conf
216 380f0955 2022-09-07 thomas Default location of the
218 8a35f56c 2022-07-16 thomas configuration file.
220 8a35f56c 2022-07-16 thomas .Sh SEE ALSO
221 8a35f56c 2022-07-16 thomas .Xr got 1 ,
222 0176d7a5 2022-08-30 thomas .Xr httpd.conf 5 ,
223 cf5878ee 2022-08-30 thomas .Xr services 5 ,
224 0176d7a5 2022-08-30 thomas .Xr gotwebd 8 ,
225 0176d7a5 2022-08-30 thomas .Xr httpd 8
