Documentation

James Moger

2014-04-15 2d73a0350d9745668d65a53cbcc776f933380f6a

 src/site/setup_transport_ssh.mkd

@@ -23,8 +23,8 @@


Then you can upload your *public* key right from the command-line.



    cat ~/.ssh/id_rsa.pub | ssh -l <username> -p 29418 <hostname> gitblit keys add

    cat c:\<userfolder>\.ssh\id_rsa.pub | ssh -l <username> -p 29418 <hostname> gitblit keys add

    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.



@@ -36,7 +36,7 @@


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.



@@ -54,29 +54,40 @@


Gitblit supports SSH command plugins and provides several commands out-of-the-box.



#### gitblit

#### keys



The *gitblit* command has many subcommands for interacting with Gitblit.

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.



##### 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 keys add

    cat ~/.ssh/id_rsa.pub | ssh -l <username> -p 29418 <hostname> keys add



##### keys list



Show the SSH public keys you have added to your account.



    ssh -l <username> -p 29418 <hostname> gitblit keys list

    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> gitblit keys remove 2

    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 keys remove 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     |