summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGravatar Joey Hess <joey@kitenet.net>2011-10-15 19:06:35 -0400
committerGravatar Joey Hess <joey@kitenet.net>2011-10-15 19:06:35 -0400
commit52c8244219dd90102818282b8b09186f2ce93a0f (patch)
treefe20f5fa19965bbfdbc9c7d2015038ca3e3f34f7 /doc
parent1480d71adb1d6acf2cc8863064902244a31f099b (diff)
git-annex-shell: GIT_ANNEX_SHELL_READONLY and GIT_ANNEX_SHELL_LIMITED environment variables can be set to limit what commands can be run.
This could be used by eg, gitolite.
Diffstat (limited to 'doc')
-rw-r--r--doc/git-annex-shell.mdwn24
1 files changed, 20 insertions, 4 deletions
diff --git a/doc/git-annex-shell.mdwn b/doc/git-annex-shell.mdwn
index 1fc9647c8..fc5bc6c2d 100644
--- a/doc/git-annex-shell.mdwn
+++ b/doc/git-annex-shell.mdwn
@@ -19,6 +19,10 @@ user's restricted login shell.
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
@@ -44,11 +48,23 @@ Any command not listed below is passed through to git-shell.
# OPTIONS
-Same as git-annex or git-shell, depending on the command being run.
+Most options are the same as in git-annex. The ones specific
+to git-annex-shell are:
-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.
+* --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.
+
+# 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