2 .\" Copyright (c) 2020 Tracey Emery <tracey@traceyemery.net>
4 .\" Permission to use, copy, modify, and distribute this software for any
5 .\" purpose with or without fee is hereby granted, provided that the above
6 .\" copyright notice and this permission notice appear in all copies.
8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
21 .Nd gotwebd configuration file
24 is the run-time configuration file for
27 The file format is line-based, with one configuration directive per line.
28 Any lines beginning with a
30 are treated as comments and ignored.
32 Macros can be defined that are later expanded in context.
33 Macro names must start with a letter, digit, or underscore, and may
34 contain any of those characters, but may not be reserved words.
35 Macros are not expanded inside quotes.
37 .Bd -literal -offset indent
38 lan_addr = "192.168.0.1"
39 listen on $lan_addr port 9090
50 .Sh GLOBAL CONFIGURATION
51 The available global configuration directives are as follows:
61 .It Ic prefork Ar number
62 Run the specified number of server processes.
64 runs 3 server processes by default.
65 .It Ic unix_socket Ar on | off
66 Controls whether the servers will listen on unix sockets by default.
67 Listening on unix sockets is the default.
68 .It Ic unix_socket_name Ar path
69 Set the path to the default unix socket.
71 .Pa /var/www/run/gotweb.sock .
73 .Sh SERVER CONFIGURATION
74 At least one server context must exist for
77 In case no server context is defined in the configuration file, a default
78 server context will be used, which listens on a unix socket at
79 .Pa /var/www/run/gotweb.sock
80 and uses default parameters for all applicable settings.
82 A server context is declared with a unique
84 followed by server-specific configuration directives inside curly braces:
86 .Ic server Ar name Brq ...
88 The first server defined is used if the requested hostname is not
89 matched by any server block.
91 The available server configuration directives are as follows:
93 .It Ic custom_css Ar path
94 Set the path to a custom Cascading Style Sheet (CSS) to be used.
95 If this option is not specified then the default style sheet
98 .It Ic listen on Ar address Ic port Ar number
99 Configure an address and port for incoming FastCGI connections.
102 arguments are hostnames, IPv4 and IPv6 addresses.
105 argument may be number or a service name defined in
108 May be specified multiple times to build up a list of listening sockets.
109 However, a given combination of address and port may only be used by
111 .It Ic listen on socket off
112 Disable use of unix socket.
113 .It Ic listen on socket Ar path
114 Set the path to the unix socket used by the server.
116 Set the path to an image file containing a logo to be displayed.
119 .It Ic logo_url Ar url
120 Set a hyperlink for the logo.
122 .Lk https://gameoftrees.org .
123 .It Ic max_commits_display Ar number
124 Set the maximum amount of commits and tags displayed per page.
126 .It Ic max_repos_display Ar number
127 Set the maximum amount of repositories displayed on the index screen.
129 Set to zero to show all the repositories without pagination.
130 .It Ic repos_path Ar path
131 Set the path to the directory which contains Git repositories that
132 the server should publish.
134 .Pa /run/gotwebd.sock
136 .It Ic respect_exportok Ar on | off
137 Set whether to display the repository only if it contains the magic
138 .Pa git-daemon-export-ok
141 .It Ic show_repo_age Ar on | off
142 Toggle display of last repository modification date.
144 .It Ic show_repo_cloneurl Ar on | off
145 Toggle display of clone URLs for a repository.
146 This requires the creation of a
148 file inside the repository which contains one URL per line.
150 .It Ic show_repo_description Ar on | off
151 Toggle display of the repository description.
155 file in the repository should be updated with an appropriate description.
156 .It Ic show_repo_owner Ar on | off
157 Set whether to display the repository owner.
159 Displaying the owner requires owner information to be added to the
161 file in the repository.
163 will parse owner information from either a [gotweb] or a [gitweb] section.
165 .Bd -literal -offset indent
169 .It Ic site_link Ar string
170 Set the displayed site link name for the index page.
173 .It Ic site_name Ar string
174 Set the displayed site name title.
177 .It Ic site_owner Ar string
178 Set the displayed site owner.
181 .It Ic show_site_owner Ar on | off
182 Toggle display of the site owner.
184 .It Ic summary_commits_display Ar number
185 The maximum number of commits to show in the summary page.
187 .It Ic summary_tags_display Ar number
188 The maximum number of tags to show in the summary page.
192 .Bl -tag -width Ds -compact
193 .It Pa /etc/gotwebd.conf
194 Default location of the
199 A sample configuration:
200 .Bd -literal -offset indent
202 site_name "my public repos"
203 site_owner "Flan Hacker"
204 site_link "Flan' Projects"
208 Another example, this time listening on a local port instead of the
212 .Bd -literal -offset indent
215 listen on 127.0.0.1 port 9000
216 listen on ::1 port 9000
