James Moger
2014-03-27 fc8487e5ade37a82e686f4168ea5702bde3cdb4b
src/site/setup_transport_ssh.mkd
@@ -23,14 +23,14 @@
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> gitblit keys add -
    cat c:\<userfolder>\.ssh\id_rsa.pub | ssh -l <username> -p 29418 <hostname> gitblit 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
@@ -40,7 +40,7 @@
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,31 @@
### SSH Commands
#### git
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.
##### git-receive-pack
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 supports SSH command plugins and provides several commands out-of-the-box.
#### gitblit
The *gitblit* command has many subcommands for interacting gitblit.
The *gitblit* command has many subcommands for interacting with 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> gitblit 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> gitblit 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
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> gitblit keys remove ALL