SSH Authentication

SSH

Version 0.5.0 of the collaboration plug-in supports SSH authentication as well as username/password authentication for HTTPS connections.

This requires the user to do some manual configuration outside of Archi.

Setting up private and public keys

Here's an example of how to create SSH key files and add a public key to GitHub.

This example uses Windows and a Git Bash terminal.

Create the files:

1. ssh-keygen -t rsa -b 4096 -m PEM -C "yourGitHubEmailAddress"
2. Enter a pass-phrase when prompted
3. eval $(ssh-agent -s)
4. ssh-add ~/.ssh/id_rsa

Add to GitHub:

1. Copy the public key to clipboard with clip < ~/.ssh/id_rsa.pub
2. At GitHub create a new key at https://github.com/settings/keys and paste the contents of the clipboard

For more information see the following:

https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/#platform-windows

https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account/

Setting the key file in Archi

In Archi's Preferences, select the "Collaboration" tab and, in the "SSH Authentication" section set the SSH key file (in the example above this is ~/.ssh/id_rsa) and if the key file requires an identity password enter this too.

Using SSH in Archi

Once SSH has been configured, it's simply a case of using the appropriate URL when setting up a repository based model in the Collaboration Workspace. For example, when cloning a model or adding a model to the workspace, simply enter the URL of the online repository. Unlike HTTPS connections no user name or password is required as this is stored in the SSH key file.

Typical SSH URLs are: