From 11eb4b51accebf8a163e8f46f99b067eda80f7b9 Mon Sep 17 00:00:00 2001 From: James Moger <james.moger@gitblit.com> Date: Fri, 23 May 2014 08:29:14 -0400 Subject: [PATCH] Remove GitBlit static singleton reference from localclone.groovy --- src/site/setup_transport_ssh.mkd | 54 ++++++++++++++++++++++++++++++------------------------ 1 files changed, 30 insertions(+), 24 deletions(-) diff --git a/src/site/setup_transport_ssh.mkd b/src/site/setup_transport_ssh.mkd index 38742ec..7b53624 100644 --- a/src/site/setup_transport_ssh.mkd +++ b/src/site/setup_transport_ssh.mkd @@ -23,24 +23,24 @@ Then you can upload your *public* key right from the command-line. - cat ~/.ssh/id_rsa.pub | ssh -l <username> -p 29418 <hostname> gitblit add-key - cat c:\<userfolder>\.ssh\id_rsa.pub | ssh -l <username> -p 29418 <hostname> gitblit add-key + cat ~/.ssh/id_rsa.pub | ssh -l <username> -p 29418 <hostname> keys add + cat c:\<userfolder>\.ssh\id_rsa.pub | ssh -l <username> -p 29418 <hostname> keys add **NOTE:** It is important to note that *ssh-keygen* generates a public/private keypair (e.g. id_rsa and id_rsa.pub). You want to upload the *public* key, which is denoted by the *.pub* file extension. Once you've done both of those steps you should be able to execute the following command without a password prompt. - ssh -l <username> -p 29418 <hostname> gitblit version + ssh -l <username> -p 29418 <hostname> ### Setting up an SSH alias Typing the following command syntax all the time gets to be rather tedious. - ssh -l <username> -p 29418 <hostname> gitblit version + ssh -l <username> -p 29418 <hostname> You can define an alias for your server which will reduce your command syntax to something like this. - ssh <alias> gitblit version + ssh <alias> Create or modify your `~/.ssh/config` file and add a host entry. If you are on Windows, you'll want to create or modify `<userfolder>\.ssh\config`, where *userfolder* is dependent on your version of Windows. Most recently this is `c:\users\<userfolder>`. @@ -52,36 +52,42 @@ ### SSH Commands -#### git +Gitblit supports SSH command plugins and provides several commands out-of-the-box. -You will likely never directly interact with the git command, but it is used by your git client to clone, fetch, and push commits to/from your Gitblit server. +#### keys -##### git-receive-pack +The *keys* command dispatcher allows you to manage your public ssh keys. You can list keys, add keys, remove keys, and identify the key in-use for the active session. -This is the command for processing pushes sent from clients. - -##### git-upload-pack - -This is the command for sending refs and commits to clients. - -#### gitblit - -The *gitblit* command has many subcommands for interacting gitblit. - -##### add-key +##### keys add Add an SSH public key to your account. This command accepts a public key piped to stdin. - cat ~/.ssh/id_rsa.pub | ssh -l <username> -p 29418 <hostname> gitblit add-key + cat ~/.ssh/id_rsa.pub | ssh -l <username> -p 29418 <hostname> keys add -##### rm-key +##### keys list -Remove an SSH public key from your account. This command accepts a public key piped to stdin. +Show the SSH public keys you have added to your account. - cat ~/.ssh/id_rsa.pub | ssh -l <username> -p 29418 <hostname> gitblit rm-key + ssh -l <username> -p 29418 <hostname> keys list + +##### keys remove + +Remove an SSH public key from your account. This command accepts several input values, the most useful one is an index number which matches the index number displayed in the `list` command. + + ssh -l <username> -p 29418 <hostname> keys remove 2 You can also remove all your public keys from your account. - ssh -l <username> -p 29418 <hostname> gitblit rm-key ALL + ssh -l <username> -p 29418 <hostname> keys remove ALL + +##### keys permission + +You may control the access permission for each SSH key. This is more of a safety feature than a security measure. + +| Permission | Description | +| ---------- | ----------------------------------------------- | +| V | SSH key may not be used for clone/fetch or push | +| R | SSH key may be used to clone/fetch | +| RW | SSH key may be used to clone/fetch and push | -- Gitblit v1.9.1