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