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 unix_socket Ar path
89 Set the path to the unix socket which
92 If not specified, the path
93 .Pa /var/run/gotd.sock
95 .It Ic unix_group Ar group
100 file, which is allowed to access
106 user must be a secondary member of this group.
107 If not specified, the group _gotsh will be used.
115 requires root privileges in order to create its unix socket.
118 drops privileges to the specified
120 If not specified, the user _gotd will be used.
122 .Sh REPOSITORY CONFIGURATION
123 At least one repository context must exist for
126 For each repository, access rules must be configured using the
130 configuration directives.
131 Multiple access rules can be specified, and the last matching rule
132 determines the action taken.
133 If no rule matches, access to the repository is denied.
135 A repository context is declared with a unique
137 followed by repository-specific configuration directives inside curly braces:
139 .Ic repository Ar name Brq ...
144 clients can connect to a repository by including the repository's unique
147 Clients appending the string
151 will also be accepted.
155 may contain path-separators,
157 to expose repositories as part of a virtual client-visible directory hierarchy.
159 The available repository configuration directives are as follows:
161 .It Ic deny Ar identity
162 Deny repository access to users with the username
164 Group names may be matched by prepending a colon
168 Numeric IDs are also accepted.
170 Set the path to the Git repository.
172 .It Ic permit Ar mode Ar identity
173 Permit repository access to users with the username
177 argument must be set to either
179 for read-only access,
182 for read-write access.
183 Group names may be matched by prepending a colon
187 Numeric IDs are also accepted.
190 .Bl -tag -width Ds -compact
191 .It Pa /etc/gotd.conf
197 .Bd -literal -offset indent
198 # Default unix_group and user values:
202 # This repository can be accessed via ssh://user@example.com/src
204 path "/var/git/src.git"
205 permit rw flan_hacker
206 permit rw :developers
210 # This repository can be accessed via
211 # ssh://user@example.com/openbsd/ports
212 repository "openbsd/ports" {
213 path "/var/git/ports.git"
219 # Use a larger request timeout value:
220 connection request timeout 2h
222 # Some users are granted a higher concurrent connection limit:
224 limit user flan_hacker 16
225 limit user anonymous 32
