Blame


1 13b2bc37 2022-10-23 stsp .\"
2 13b2bc37 2022-10-23 stsp .\" Copyright (c) 2022 Stefan Sperling
3 13b2bc37 2022-10-23 stsp .\"
4 13b2bc37 2022-10-23 stsp .\" Permission to use, copy, modify, and distribute this software for any
5 13b2bc37 2022-10-23 stsp .\" purpose with or without fee is hereby granted, provided that the above
6 13b2bc37 2022-10-23 stsp .\" copyright notice and this permission notice appear in all copies.
7 13b2bc37 2022-10-23 stsp .\"
8 13b2bc37 2022-10-23 stsp .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 13b2bc37 2022-10-23 stsp .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 13b2bc37 2022-10-23 stsp .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 13b2bc37 2022-10-23 stsp .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 13b2bc37 2022-10-23 stsp .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 13b2bc37 2022-10-23 stsp .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 13b2bc37 2022-10-23 stsp .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15 13b2bc37 2022-10-23 stsp .\"
16 13b2bc37 2022-10-23 stsp .Dd $Mdocdate$
17 13b2bc37 2022-10-23 stsp .Dt GOTSH 1
18 13b2bc37 2022-10-23 stsp .Os
19 13b2bc37 2022-10-23 stsp .Sh NAME
20 13b2bc37 2022-10-23 stsp .Nm gotsh
21 13b2bc37 2022-10-23 stsp .Nd Game of Trees Shell
22 13b2bc37 2022-10-23 stsp .Sh SYNOPSIS
23 13b2bc37 2022-10-23 stsp .Nm Fl c Sq Cm git-receive-pack Ar repository-path
24 13b2bc37 2022-10-23 stsp .Nm Fl c Sq Cm git-upload-pack Ar repository-path
25 13b2bc37 2022-10-23 stsp .Sh DESCRIPTION
26 13b2bc37 2022-10-23 stsp .Nm
27 13b2bc37 2022-10-23 stsp is the network-facing interface to
28 13b2bc37 2022-10-23 stsp .Xr gotd 8 .
29 13b2bc37 2022-10-23 stsp It implements the server-side part of the Git network protocol used by
30 13b2bc37 2022-10-23 stsp .Xr git 1
31 13b2bc37 2022-10-23 stsp and
32 13b2bc37 2022-10-23 stsp .Xr got 1 .
33 13b2bc37 2022-10-23 stsp .Pp
34 13b2bc37 2022-10-23 stsp .Nm
35 13b2bc37 2022-10-23 stsp is not an interactive shell.
36 13b2bc37 2022-10-23 stsp .Nm
37 13b2bc37 2022-10-23 stsp is intended to be configured as the login shell of Git repository
38 13b2bc37 2022-10-23 stsp user accounts on servers running
39 13b2bc37 2022-10-23 stsp .Xr gotd 8 .
40 bc854c7b 2022-10-23 stsp If users require a different login shell,
41 bc854c7b 2022-10-23 stsp .Nm
42 8b60b240 2022-10-24 mark can be installed in the command search path under the names
43 bc854c7b 2022-10-23 stsp .Cm git-receive-pack
44 bc854c7b 2022-10-23 stsp and
45 bc854c7b 2022-10-23 stsp .Cm git-upload-pack .
46 bc854c7b 2022-10-23 stsp .Pp
47 13b2bc37 2022-10-23 stsp The users can then interact with
48 13b2bc37 2022-10-23 stsp .Xr gotd 8
49 13b2bc37 2022-10-23 stsp over the network.
50 13b2bc37 2022-10-23 stsp When users invoke commands such as
51 13b2bc37 2022-10-23 stsp .Cm got send
52 13b2bc37 2022-10-23 stsp and
53 13b2bc37 2022-10-23 stsp .Cm got fetch
54 13b2bc37 2022-10-23 stsp on client machines,
55 13b2bc37 2022-10-23 stsp .Xr got 1
56 13b2bc37 2022-10-23 stsp will connect to the server with
57 13b2bc37 2022-10-23 stsp .Xr ssh 1 .
58 13b2bc37 2022-10-23 stsp .Nm
59 13b2bc37 2022-10-23 stsp will facilitate communication between
60 13b2bc37 2022-10-23 stsp .Xr gotd 8
61 13b2bc37 2022-10-23 stsp running on the server machine and the
62 13b2bc37 2022-10-23 stsp .Xr got 1
63 13b2bc37 2022-10-23 stsp or
64 13b2bc37 2022-10-23 stsp .Xr git 1
65 13b2bc37 2022-10-23 stsp program running on the client machine.
66 13b2bc37 2022-10-23 stsp .Pp
67 13b2bc37 2022-10-23 stsp Users running
68 13b2bc37 2022-10-23 stsp .Nm
69 13b2bc37 2022-10-23 stsp must be members of the group which has read/write permission to the
70 13b2bc37 2022-10-23 stsp .Xr gotd 8
71 13b2bc37 2022-10-23 stsp unix socket.
72 13b2bc37 2022-10-23 stsp The group used for this purpose can be configured in
73 13b2bc37 2022-10-23 stsp .Xr gotd.conf 5 .
74 13b2bc37 2022-10-23 stsp Users running
75 13b2bc37 2022-10-23 stsp .Nm
76 13b2bc37 2022-10-23 stsp should not have access to Git repositories by means other than
77 13b2bc37 2022-10-23 stsp accessing the unix socket of
78 13b2bc37 2022-10-23 stsp .Xr gotd 8
79 13b2bc37 2022-10-23 stsp via
80 13b2bc37 2022-10-23 stsp .Nm .
81 13b2bc37 2022-10-23 stsp .Pp
82 13b2bc37 2022-10-23 stsp It is recommended to restrict
83 13b2bc37 2022-10-23 stsp .Xr ssh 1
84 13b2bc37 2022-10-23 stsp features available to users of
85 13b2bc37 2022-10-23 stsp .Nm .
86 40c2b7bf 2022-10-24 stsp See the
87 40c2b7bf 2022-10-24 stsp .Sx EXAMPLES
88 40c2b7bf 2022-10-24 stsp section for details.
89 13b2bc37 2022-10-23 stsp .Sh ENVIRONMENT
90 13b2bc37 2022-10-23 stsp .Bl -tag -width GOTD_UNIX_SOCKET
91 13b2bc37 2022-10-23 stsp .It Ev GOTD_UNIX_SOCKET
92 13b2bc37 2022-10-23 stsp Set the path to the unix socket which
93 13b2bc37 2022-10-23 stsp .Xr gotd 8
94 13b2bc37 2022-10-23 stsp is listening on.
95 13b2bc37 2022-10-23 stsp If not specified, the default path
96 13b2bc37 2022-10-23 stsp .Pa /var/run/gotd.sock
97 13b2bc37 2022-10-23 stsp will be used.
98 13b2bc37 2022-10-23 stsp .El
99 13b2bc37 2022-10-23 stsp .Sh EXAMPLES
100 13b2bc37 2022-10-23 stsp The following
101 13b2bc37 2022-10-23 stsp .Xr sshd_config 5
102 13b2bc37 2022-10-23 stsp directives are recommended to protect the server machine and any systems
103 13b2bc37 2022-10-23 stsp reachable from it via
104 13b2bc37 2022-10-23 stsp .Xr ssh 1
105 13b2bc37 2022-10-23 stsp forwarding features.
106 13b2bc37 2022-10-23 stsp This example assumes the group called
107 13b2bc37 2022-10-23 stsp .Dq _gotsh
108 13b2bc37 2022-10-23 stsp has read/write access to the
109 13b2bc37 2022-10-23 stsp .Xr gotd 8
110 13b2bc37 2022-10-23 stsp unix socket.
111 13b2bc37 2022-10-23 stsp .Bd -literal -offset indent
112 13b2bc37 2022-10-23 stsp Match Group _gotsh
113 13b2bc37 2022-10-23 stsp DisableForwarding
114 13b2bc37 2022-10-23 stsp PermitTTY no
115 13b2bc37 2022-10-23 stsp .Sh SEE ALSO
116 13b2bc37 2022-10-23 stsp .Xr got 1 ,
117 13b2bc37 2022-10-23 stsp .Xr ssh 1 ,
118 13b2bc37 2022-10-23 stsp .Xr gotd.conf 5 ,
119 13b2bc37 2022-10-23 stsp .Xr sshd_config 5 ,
120 13b2bc37 2022-10-23 stsp .Xr gotd 8
121 13b2bc37 2022-10-23 stsp .Sh AUTHORS
122 13b2bc37 2022-10-23 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org