2 .\" Copyright (c) 2022 Stefan Sperling <stsp@openbsd.org>
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 gotd 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.
31 .Sh GLOBAL CONFIGURATION
32 The available global configuration directives are as follows:
34 .It Ic connection Ar option
35 Set the specified options and limits for connections to the
41 directive may be specified multiple times, and multiple
43 arguments may be specified within curly braces:
45 .Ic connection Brq Ar ...
47 Each option should only be specified once.
48 If a given option is listed multiple times, the last line which sets this
51 Valid connection options are:
53 .It Ic request timeout Ar seconds
54 Specify the inactivity timeout for operations between client and server.
55 If this timeout is exceeded while a Git protocol request is being processed,
56 the request will be aborted and the connection will be terminated.
58 The timeout value may also have a suffix indicating its unit of measure.
59 Supported suffixes are:
61 .Bl -tag -compact -width tenletters
70 The default timeout is 1h (3600 seconds, one hour).
71 This should only be changed if legitimate requests are exceeding the default
72 timeout for some reason, such as the server spending an extraordinary
73 amount of time generating a pack file.
74 .It Ic limit Ic user Ar identity Ar number
75 Limit the maximum amount of concurrent connections by the user with
80 Numeric user IDs are also accepted.
82 The default per-user limit is 4.
83 This should only be changed if concurrent connections from a given user are
84 expected to exceed the default limit, for example if an anonymous user
85 is granted read access and many concurrent connections will share this
86 anonymous user identity.
88 .It Ic listen on Ar path
89 Set the path to the unix socket which
92 If not specified, the path
93 .Pa /var/run/gotd.sock
102 requires root privileges in order to create its unix socket.
105 drops privileges to the specified
107 If not specified, the user _gotd will be used.
109 .Sh REPOSITORY CONFIGURATION
110 At least one repository context must exist for
113 For each repository, access rules must be configured using the
117 configuration directives.
118 Multiple access rules can be specified, and the last matching rule
119 determines the action taken.
120 If no rule matches, access to the repository is denied.
122 A repository context is declared with a unique
124 followed by repository-specific configuration directives inside curly braces:
126 .Ic repository Ar name Brq ...
131 clients can connect to a repository by including the repository's unique
134 Clients appending the string
138 will also be accepted.
142 may contain path-separators,
144 to expose repositories as part of a virtual client-visible directory hierarchy.
146 The available repository configuration directives are as follows:
148 .It Ic deny Ar identity
149 Deny repository access to users with the username
151 Group names may be matched by prepending a colon
155 Numeric IDs are also accepted.
157 Set the path to the Git repository.
159 .It Ic permit Ar mode Ar identity
160 Permit repository access to users with the username
164 argument must be set to either
166 for read-only access,
169 for read-write access.
170 Group names may be matched by prepending a colon
174 Numeric IDs are also accepted.
175 .It Ic protect Brq Ar ...
178 directive may be used to protect branches and tags in a repository
179 from being overwritten by potentially destructive client-side commands,
184 are used to change the history of a branch.
186 To build a set of protected branches and tags, multiple
188 directives may be specified per repository and
191 directive parameters may be specified within curly braces.
195 parameters are as follows:
198 .It Ic branch Ar name
199 Protect the named branch.
200 The branch may be created if it does not exist yet.
201 Attempts to delete the branch or change its history will be denied.
205 does not already begin with
207 it will be looked up in the
210 .It Ic branch Ic namespace Ar namespace
211 Protect the given reference namespace, assuming that references in
212 this namespace represent branches.
213 New branches may be created in the namespace.
214 Attempts to change the history of branches or delete them will be denied.
218 argument must be absolute, starting with
220 .It Ic tag Ic namespace Ar namespace
221 Protect the given reference namespace, assuming that references in
222 this namespace represent tags.
223 New tags may be created in the namespace.
224 Attempts to change or delete existing tags will be denied.
228 argument must be absolute, starting with
232 The special reference namespaces
236 do not need to be listed in
238 These namespaces are always protected and even attempts to create new
239 references in these namespaces will always be denied.
240 .It Ic notify Brq Ar ...
243 directive enables notifications about new commits or tags
244 added to the repository.
246 Notifications via email require an SMTP daemon which accepts mail
247 for forwarding without requiring client authentication or encryption.
252 daemon can be used for this purpose.
253 The default content of email notifications looks similar to the output of the
257 Notifications via HTTP require a HTTP or HTTPS server which is accepting
258 POST requests with or without HTTP Basic authentication.
259 Depending on the use case a custom server-side CGI script may be required
260 for the processing of notifications.
261 HTTP notifications can achieve functionality
262 similar to Git's server-side post-receive hook script with
264 by triggering arbitrary post-commit actions via the HTTP server.
268 directive expects parameters which must be enclosed in curly braces.
269 The available parameters are as follows:
272 .It Ic branch Ar name
273 Send notifications about commits to the named branch.
276 will be looked up in the
279 This directive may be specified multiple times to build a list of
280 branches to send notifications for.
284 .Ic reference namespace
285 are specified then changes to any reference will trigger notifications.
286 .It Ic reference Ic namespace Ar namespace
287 Send notifications about commits or tags within a reference namespace.
288 This directive may be specified multiple times to build a list of
289 namespaces to send notifications for.
293 .Ic reference namespace
294 are specified then changes to any reference will trigger notifications.
295 .It Ic email Oo Ic from Ar sender Oc Ic to Ar recipient Oo Ic reply to Ar responder Oc Oo Ic relay Ar hostname Oo Ic port Ar port Oc Oc
296 Send notifications via email to the specified
298 This directive may be specified multiple times to build a list of
299 recipients to send notifications to.
303 must be an email addresses that accepts mail.
306 will be used as the From address.
307 If not specified, the sender defaults to an email address composed of the user
310 and the local hostname.
318 will be used as the Reply-to address.
319 Setting the Reply-to header can be useful if replies should go to a
320 mailing list instead of the
324 By default, mail will be sent to the SMTP server listening on the loopback
325 address 127.0.0.1 on port 25.
330 directives can be used to specify a different SMTP server address and port.
332 .It Ic url Ar URL Oo Ic user Ar user Ic password Ar password Oc
333 Send notifications via HTTP.
334 This directive may be specified multiple times to build a list of
335 HTTP servers to send notifications to.
337 The notification will be sent as a POST request to the given
339 which must be a valid HTTP URL and begin with either
343 If HTTPS is used, sending of notifications will only succeed if
350 directives enable HTTP Basic authentication.
358 must not be an empty string.
360 The request body contains a JSON document with the following objects:
361 .Bl -tag -width { "notifications" : array }
362 .It { "notifications" : array }
363 The top-level object contains an array of all notifications in this request.
367 .Bl -tag -width Ds -compact
368 .It Pa /etc/gotd.conf
374 .Bd -literal -offset indent
375 # Run as the default user:
378 # Listen on the default socket:
379 listen on "/var/run/gotd.sock"
381 # This repository can be accessed via ssh://user@example.com/src
383 path "/var/git/src.git"
384 permit rw flan_hacker
385 permit rw :developers
388 protect branch "main"
389 protect tag namespace "refs/tags/"
392 # This repository can be accessed via
393 # ssh://user@example.com/openbsd/ports
394 repository "openbsd/ports" {
395 path "/var/git/ports.git"
402 tag namespace "refs/tags/"
407 reference namespace "refs/tags/"
408 email to openbsd-ports-changes@example.com
409 .\" url https://example.com/notify/ user "flan_announcer" password "secret"
413 # Use a larger request timeout value:
414 connection request timeout 2h
416 # Some users are granted a higher concurrent connection limit:
418 limit user flan_hacker 16
419 limit user anonymous 32
