git-annex-shell(1) [debian man page]

git-annex-shell(1)					      General Commands Manual						git-annex-shell(1)

NAME

       git-annex-shell - Restricted login shell for git-annex only SSH access

SYNOPSIS

       git-annex-shell [-c] command [params ...]

DESCRIPTION

       git-annex-shell is a restricted shell, similar to git-shell, which can be used as a login shell for SSH accounts.

       Since  its  syntax  is  identical to git-shell's, it can be used as a drop-in replacement anywhere git-shell is used. For example it can be
       used as a user's restricted login shell.

COMMANDS

       Any command not listed below is passed through to git-shell.

       Note that the directory parameter should be an absolute path, otherwise it is assumed to be relative to the user's home directory. Also the
       first "/~/" or "/~user/" is expanded to the specified home directory.

       configlist directory
	      This outputs a subset of the git configuration, in the same form as git config --list

       inannex directory [key ...]
	      This checks if all specified keys are present in the annex, and exits zero if so.

       dropkey directory [key ...]
	      This drops the annexed data for the specified keys.

       recvkey directory key
	      This runs rsync in server mode to receive the content of a key, and stores the content in the annex.

       sendkey directory key
	      This runs rsync in server mode to transfer out the content of a key.

       commit directory
	      This commits any staged changes to the git-annex branch.	It also runs the annex-content hook.

OPTIONS

       Most options are the same as in git-annex. The ones specific to git-annex-shell are:

       --uuid=UUID
	      git-annex uses this to specify the UUID of the repository it was expecting git-annex-shell to access, as a sanity check.

HOOK

       After  content is received or dropped from the repository by git-annex-shell, it runs a hook, .git/hooks/annex-content (or hooks/annex-con-
       tent on a bare repository). The hook is not currently passed any information about what changed.

ENVIRONMENT

       GIT_ANNEX_SHELL_READONLY

	      If set, disallows any command that could modify the repository.

       GIT_ANNEX_SHELL_LIMITED
	      If set, disallows running git-shell to handle unknown commands.

SEE ALSO

       git-annex(1)

       git-shell(1)

AUTHOR

       Joey Hess <joey@kitenet.net>

       <http://git-annex.branchable.com/>

																git-annex-shell(1)

GIT-SHELL(1)							    Git Manual							      GIT-SHELL(1)

NAME

       git-shell - Restricted login shell for Git-only SSH access

SYNOPSIS

       chsh -s $(command -v git-shell) <user>
       git clone <user>@localhost:/path/to/repo.git
       ssh <user>@localhost

DESCRIPTION

       This is a login shell for SSH accounts to provide restricted Git access. It permits execution only of server-side Git commands implementing
       the pull/push functionality, plus custom commands present in a subdirectory named git-shell-commands in the user's home directory.

COMMANDS

       git shell accepts the following commands after the -c option:

       git receive-pack <argument>, git upload-pack <argument>, git upload-archive <argument>
	   Call the corresponding server-side command to support the client's git push, git fetch, or git archive --remote request.

       cvs server
	   Imitate a CVS server. See git-cvsserver(1).

       If a ~/git-shell-commands directory is present, git shell will also handle other, custom commands by running "git-shell-commands/<command>
       <arguments>" from the user's home directory.

INTERACTIVE USE

       By default, the commands above can be executed only with the -c option; the shell is not interactive.

       If a ~/git-shell-commands directory is present, git shell can also be run interactively (with no arguments). If a help command is present
       in the git-shell-commands directory, it is run to provide the user with an overview of allowed actions. Then a "git> " prompt is presented
       at which one can enter any of the commands from the git-shell-commands directory, or exit to close the connection.

       Generally this mode is used as an administrative interface to allow users to list repositories they have access to, create, delete, or
       rename repositories, or change repository descriptions and permissions.

       If a no-interactive-login command exists, then it is run and the interactive shell is aborted.

EXAMPLE

       To disable interactive logins, displaying a greeting instead:

	   $ chsh -s /usr/bin/git-shell
	   $ mkdir $HOME/git-shell-commands
	   $ cat >$HOME/git-shell-commands/no-interactive-login <<EOF
	   #!/bin/sh
	   printf '%s
' "Hi $USER! You've successfully authenticated, but I do not"
	   printf '%s
' "provide interactive shell access."
	   exit 128
	   EOF
	   $ chmod +x $HOME/git-shell-commands/no-interactive-login

       To enable git-cvsserver access (which should generally have the no-interactive-login example above as a prerequisite, as creating the
       git-shell-commands directory allows interactive logins):

	   $ cat >$HOME/git-shell-commands/cvs <<EOF
	   if ! test $# = 1 && test "$1" = "server"
	   then
		   echo >&2 "git-cvsserver only handles "server""
		   exit 1
	   fi
	   exec git cvsserver server
	   EOF
	   $ chmod +x $HOME/git-shell-commands/cvs

SEE ALSO

       ssh(1), git-daemon(1), contrib/git-shell-commands/README

GIT

       Part of the git(1) suite

Git 2.17.1							    10/05/2018							      GIT-SHELL(1)