summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSytse Sijbrandij <sytse@gitlab.com>2015-02-21 12:52:15 -0800
committerSytse Sijbrandij <sytse@gitlab.com>2015-02-21 12:52:15 -0800
commit9b089f955ff8df8ad3328ee0faa19acfcf8b05b4 (patch)
tree022fa1d378fe60f5106e6693ed5c3376ddf7ed79 /README.md
parent0710fb4c30e0b15e7a1ff3d69e0ac358a4cd49bc (diff)
downloadgitlab-shell-9b089f955ff8df8ad3328ee0faa19acfcf8b05b4.tar.gz
Make key authorization easier to understand.
Diffstat (limited to 'README.md')
-rw-r--r--README.md5
1 files changed, 2 insertions, 3 deletions
diff --git a/README.md b/README.md
index 69f11db..5ee8623 100644
--- a/README.md
+++ b/README.md
@@ -2,12 +2,11 @@
## GitLab Shell handles git commands for GitLab
-GitLab Shell is a progam that executes git commands for GitLab.
+GitLab Shell handles git commands for GitLab and modifies the list of authorized keys.
GitLab Shell is not a Unix shell nor a replacement for Bash or Zsh.
-Hwen you access the GitLab server over ssh then GitLab Shell will:
+When you access the GitLab server over ssh then GitLab Shell will:
-1. Checks if your ssh key is known in authrorized keys.
1. Limits you to predefined git commands (git push, git pull, git annex).
1. Call the GitLab Rails API to check if you are authorized
1. It will execute the pre-receive hooks (called Git Hooks in GitLab Enterprise Edition)