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 unix_socket Ar path
35 Set the path to the unix socket which
38 If not specified, the path
39 .Pa /var/run/gotd.sock
41 .It Ic unix_group Ar group
46 file, which is allowed to access
52 user must be a secondary member of this group.
53 If not specified, the group _gotsh will be used.
61 requires root privileges in order to create its unix socket and start
67 drops privileges to the specified
69 If not specified, the user _gotd will be used.
71 .Sh REPOSITORY CONFIGURATION
72 At least one repository context must exist for
76 A repository context is declared with a unique
78 followed by repository-specific configuration directives inside curly braces:
80 .Ic repository Ar name Brq ...
85 clients can connect to a repository by including the repository's unique
88 Clients appending the string
92 will also be accepted.
96 may contain path-separators,
98 to expose repositories as part of a virtual client-visible directory hierarchy.
100 The available repository configuration directives are as follows:
103 Set the path to the Git repository.
106 .Bl -tag -width Ds -compact
107 .It Pa /etc/gotd.conf
113 .Bd -literal -offset indent
114 # Default unix_group and user values:
118 # This repository can be accessed via ssh://user@example.com/src
120 path "/var/git/src.git"
123 # This repository can be accessed via
124 # ssh://user@example.com/openbsd/ports
125 repository "openbsd/ports" {
126 path "/var/git/ports.git"