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.
177 .Bl -tag -width Ds -compact
178 .It Pa /etc/gotd.conf
184 .Bd -literal -offset indent
185 # Run as the default user:
188 # Listen on the default socket:
189 listen on "/var/run/gotd.sock"
191 # This repository can be accessed via ssh://user@example.com/src
193 path "/var/git/src.git"
194 permit rw flan_hacker
195 permit rw :developers
199 # This repository can be accessed via
200 # ssh://user@example.com/openbsd/ports
201 repository "openbsd/ports" {
202 path "/var/git/ports.git"
208 # Use a larger request timeout value:
209 connection request timeout 2h
211 # Some users are granted a higher concurrent connection limit:
213 limit user flan_hacker 16
214 limit user anonymous 32
