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 b95d1cf6 2023-06-25 thomas The first server defined is used if the requested hostname is not
84 b95d1cf6 2023-06-25 thomas matched by any server block.
86 cf5878ee 2022-08-30 thomas The available server configuration directives are as follows:
87 cf5878ee 2022-08-30 thomas .Bl -tag -width Ds
88 55331ef5 2022-08-30 thomas .It Ic custom_css Ar path
89 55331ef5 2022-08-30 thomas Set the path to a custom Cascading Style Sheet (CSS) to be used.
90 cf5878ee 2022-08-30 thomas If this option is not specified then a default style sheet will be used.
91 55331ef5 2022-08-30 thomas .It Ic listen on Ar address Ic port Ar number
92 cf5878ee 2022-08-30 thomas Configure an address and port for incoming FCGI TCP connections.
94 cf5878ee 2022-08-30 thomas .Ar address
95 08f1c78e 2023-11-16 thomas arguments are hostnames, IP4 addresses and IPv6 addresses.
98 cf5878ee 2022-08-30 thomas argument may be number or a service name defined in
99 cf5878ee 2022-08-30 thomas .Xr services 5 .
101 cf5878ee 2022-08-30 thomas May be specified multiple times to build up a list of listening sockets.
102 cf5878ee 2022-08-30 thomas However, a given combination of address and port may only be used by
103 cf5878ee 2022-08-30 thomas one server.
104 bea82c4f 2023-01-06 thomas .It Ic listen on socket off
105 bea82c4f 2023-01-06 thomas Disable use of unix socket.
106 bea82c4f 2023-01-06 thomas .It Ic listen on socket Ar path
107 bea82c4f 2023-01-06 thomas Set the path to the unix socket used by the server.
108 55331ef5 2022-08-30 thomas .It Ic logo Ar path
109 8a35f56c 2022-07-16 thomas Set the path to an image file containing a logo to be displayed.
110 55331ef5 2022-08-30 thomas .It Ic logo_url Ar url
111 8a35f56c 2022-07-16 thomas Set a hyperlink for the logo.
112 55331ef5 2022-08-30 thomas .It Ic max_commits_display Ar number
113 55331ef5 2022-08-30 thomas Set the maximum amount of commits displayed per page.
114 55331ef5 2022-08-30 thomas .It Ic max_repos Ar number
115 8a35f56c 2022-07-16 thomas Set the maximum amount of repositories
116 55331ef5 2022-08-30 thomas .Xr gotwebd 8
117 8a35f56c 2022-07-16 thomas will work with.
118 55331ef5 2022-08-30 thomas .It Ic max_repos_display Ar number
119 8a35f56c 2022-07-16 thomas Set the maximum amount of repositories displayed on the index screen.
120 55331ef5 2022-08-30 thomas .It Ic repos_path Ar path
121 55331ef5 2022-08-30 thomas Set the path to the directory which contains Git repositories that
122 cf5878ee 2022-08-30 thomas the server should publish.
123 3991b2a5 2022-10-31 thomas .It Ic respect_exportok Ar on | off
124 3991b2a5 2022-10-31 thomas Set whether to display the repository only if it contains the magic
125 3991b2a5 2022-10-31 thomas .Pa git-daemon-export-ok
127 55331ef5 2022-08-30 thomas .It Ic show_repo_age Ar on | off
128 8a35f56c 2022-07-16 thomas Toggle display of last repository modification date.
129 55331ef5 2022-08-30 thomas .It Ic show_repo_cloneurl Ar on | off
130 8a35f56c 2022-07-16 thomas Toggle display of clone URLs for a repository.
131 8a35f56c 2022-07-16 thomas This requires the creation of a
132 8a35f56c 2022-07-16 thomas .Pa cloneurl
133 8a35f56c 2022-07-16 thomas file inside the repository which contains one URL per line.
134 55331ef5 2022-08-30 thomas .It Ic show_repo_description Ar on | off
135 8a35f56c 2022-07-16 thomas Toggle display of the repository description.
137 8a35f56c 2022-07-16 thomas .Pa description
138 8a35f56c 2022-07-16 thomas file in the repository should be updated with an appropriate description.
139 55331ef5 2022-08-30 thomas .It Ic show_repo_owner Ar on | off
140 8a35f56c 2022-07-16 thomas Set whether to display the repository owner.
141 8a35f56c 2022-07-16 thomas Displaying the owner requires owner information to be added to the
142 8a35f56c 2022-07-16 thomas .Pa config
143 8a35f56c 2022-07-16 thomas file in the repository.
144 55331ef5 2022-08-30 thomas .Xr gotwebd 8
145 8a35f56c 2022-07-16 thomas will parse owner information from either a [gotweb] or a [gitweb] section.
146 8a35f56c 2022-07-16 thomas For example:
147 8a35f56c 2022-07-16 thomas .Bd -literal -offset indent
149 8a35f56c 2022-07-16 thomas owner = "Your Name"
151 55331ef5 2022-08-30 thomas .It Ic site_link Ar string
152 8a35f56c 2022-07-16 thomas Set the displayed site link name for the index page.
153 55331ef5 2022-08-30 thomas .It Ic site_name Ar string
154 8a35f56c 2022-07-16 thomas Set the displayed site name title.
155 55331ef5 2022-08-30 thomas .It Ic site_owner Ar string
156 8a35f56c 2022-07-16 thomas Set the displayed site owner.
157 55331ef5 2022-08-30 thomas .It Ic show_site_owner Ar on | off
158 8a35f56c 2022-07-16 thomas Toggle display of the site owner.
160 634fd2c7 2022-11-17 thomas .Sh FILES
161 634fd2c7 2022-11-17 thomas .Bl -tag -width Ds -compact
162 634fd2c7 2022-11-17 thomas .It Pa /etc/gotwebd.conf
163 634fd2c7 2022-11-17 thomas Default location of the
165 634fd2c7 2022-11-17 thomas configuration file.
167 8a35f56c 2022-07-16 thomas .Sh EXAMPLES
168 8a35f56c 2022-07-16 thomas These are the currently configurable items for
169 55331ef5 2022-08-30 thomas .Xr gotwebd 8
170 8a35f56c 2022-07-16 thomas with their default values.
171 8a35f56c 2022-07-16 thomas .Bd -literal -offset indent
173 55331ef5 2022-08-30 thomas # gotwebd options
174 8a35f56c 2022-07-16 thomas # all paths relative to /var/www (httpd chroot jail)
177 a15b57cd 2023-02-21 thomas prefork 3
179 55331ef5 2022-08-30 thomas server "localhost-unix" {
180 55331ef5 2022-08-30 thomas repos_path "/got/public"
181 bea82c4f 2023-01-06 thomas listen on socket "/run/gotweb.sock"
183 ef504a85 2023-01-02 thomas site_name "my public repos"
184 ef504a85 2023-01-02 thomas site_owner "Got Owner"
185 ef504a85 2023-01-02 thomas site_link "repos"
187 cf5878ee 2022-08-30 thomas logo "got.png"
188 cf5878ee 2022-08-30 thomas logo_url "https://gameoftrees.org"
190 cf5878ee 2022-08-30 thomas # on by default
191 a15b57cd 2023-02-21 thomas #show_site_owner on
192 a15b57cd 2023-02-21 thomas #show_repo_owner on
193 a15b57cd 2023-02-21 thomas #show_repo_age on
194 ee003af8 2023-06-15 thomas #show_repo_description on
195 a15b57cd 2023-02-21 thomas #show_repo_cloneurl on
196 a15b57cd 2023-02-21 thomas #respect_exportok off
198 a15b57cd 2023-02-21 thomas #max_repos 0
199 cf5878ee 2022-08-30 thomas #max_repos_display 25
200 a15b57cd 2023-02-21 thomas #max_commits_display 25
203 55331ef5 2022-08-30 thomas # Example server context for FCGI over TCP connections:
204 55331ef5 2022-08-30 thomas #server "localhost-tcp" {
205 55331ef5 2022-08-30 thomas # repos_path "/got/public"
206 bea82c4f 2023-01-06 thomas # listen on socket off
207 55331ef5 2022-08-30 thomas # listen on 127.0.0.1 port 9000
208 55331ef5 2022-08-30 thomas # listen on ::1 port 9000
211 8a35f56c 2022-07-16 thomas .Sh SEE ALSO
212 8a35f56c 2022-07-16 thomas .Xr got 1 ,
213 0176d7a5 2022-08-30 thomas .Xr httpd.conf 5 ,
214 cf5878ee 2022-08-30 thomas .Xr services 5 ,
215 0176d7a5 2022-08-30 thomas .Xr gotwebd 8 ,
216 0176d7a5 2022-08-30 thomas .Xr httpd 8
