2005-10-25 21:43:30 +00:00
|
|
|
git-shell(1)
|
|
|
|
============
|
|
|
|
|
|
|
|
NAME
|
|
|
|
----
|
2010-08-24 05:36:51 +00:00
|
|
|
git-shell - Restricted login shell for Git-only SSH access
|
2005-10-25 21:43:30 +00:00
|
|
|
|
|
|
|
|
|
|
|
SYNOPSIS
|
|
|
|
--------
|
2011-07-02 02:38:26 +00:00
|
|
|
[verse]
|
2013-03-09 21:55:37 +00:00
|
|
|
'chsh' -s $(command -v git-shell) <user>
|
|
|
|
'git clone' <user>`@localhost:/path/to/repo.git`
|
|
|
|
'ssh' <user>`@localhost`
|
2005-10-25 21:43:30 +00:00
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
-----------
|
2010-08-24 05:36:51 +00:00
|
|
|
|
2013-03-09 21:55:37 +00:00
|
|
|
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.
|
2010-08-24 05:36:51 +00:00
|
|
|
|
2013-03-09 21:55:37 +00:00
|
|
|
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 linkgit: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
|
|
|
|
---------------
|
2010-08-24 05:36:51 +00:00
|
|
|
|
2013-03-09 21:55:37 +00:00
|
|
|
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.
|
|
|
|
|
|
|
|
SEE ALSO
|
|
|
|
--------
|
|
|
|
ssh(1),
|
|
|
|
linkgit:git-daemon[1],
|
|
|
|
contrib/git-shell-commands/README
|
2005-10-25 21:43:30 +00:00
|
|
|
|
|
|
|
GIT
|
|
|
|
---
|
2008-06-06 07:07:32 +00:00
|
|
|
Part of the linkgit:git[1] suite
|