| | |
|---|
| | |
|
|---|
| | | The SSH transport is a very exciting improvement to Gitblit. Aside from offering a simple password-less, public key workflow the SSH transport also allows exposes a new approach to interacting with Gitblit: SSH commands. The Gerrit and Android projects have to be thanked for providing great base SSH code that Gitblit has integrated.
|
|---|
| | |
|
|---|
| | | You may watch an Asciinema screencast of using the SSH transport and it's command infrastructure [here](https://asciinema.org/a/9342).
|
|---|
| | |
|
|---|
| | | ### Cloning & Pushing
|
|---|
| | |
|
|---|
| | | By default, Gitblit serves the SSH transport on port 29418, which is the same as Gerrit. Why was 29418 chosen? It's likely because it resembles the IANA port assigned to the git protocol (9418).
|
|---|
| | |
|---|
| | |
|
|---|
| | | ssh-keygen
|
|---|
| | |
|
|---|
| | | 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
|
|---|
| | |
|
|---|
| | | **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.
|
|---|
| | | #### Uploading your public key from the command-line
|
|---|
| | |
|
|---|
| | | ssh -l <username> -p 29418 <hostname> gitblit version
|
|---|
| | | Then you can upload your *public* key right from the command-line.
|
|---|
| | |
|
|---|
| | | 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
|
|---|
| | |
|
|---|
| | | #### Uploading your public key through the browser
|
|---|
| | |
|
|---|
| | | 1. Navigate to your *profile* page from the dropdown user menu.
|
|---|
| | | 2. Click the *SSH Keys* tab and paste your public key into the *Add SSH Key* form.
|
|---|
| | | 3. Click the *Save* button
|
|---|
| | |
|
|---|
| | | Once you ave uploaded your public key you should be able to execute the following command without a password prompt.
|
|---|
| | |
|
|---|
| | | 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>`.
|
|---|
| | |
|
|---|
| | |
|---|
| | |
|
|---|
| | | ### 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 |
|
|---|
| | |
|
|---|
| | | ### Mac OSX Fonts
|
|---|
| | |
|
|---|
| | | Many of Gitblit's SSH commands rely on ANSI border characters to provide a pretty presentation of data. Unfortunately, the fonts provided by Apple - while very nice - don't work well with ANSI border characters. The following public domain fixed-width, fixed-point, bitmapped fonts work very nicely. I find the 6x12 font with a line spacing of ~0.8 to be quite acceptable.
|
|---|
| | |
|
|---|
| | | [6x12.dfont](6x12.dfont)
|
|---|
| | | [6x13.dfont](6x13.dfont)
|
|---|
| | | [7x13.dfont](7x13.dfont)
|
|---|
| | | [7x14.dfont](7x14.dfont)
|
|---|
| | |
|
|---|
