Adding a new Git Repository to your project using SSH key

Creating credentials

If you are adding a private repository, want to write commits to remote, or are using SSH, you will need to add Git credentials to your Domino account. Domino will use these credentials to authenticate with the service hosting your repository when you start a Run.

SSH Key creation

You will need an SSH Private Key to access a repository via SSH. You will need an SSH private key if the URI you want to use to interact with a repository is formatted as:

<user>@<domain>:<username>/<repository>.git

SSH access is supported by the following Git services.

• GitHub SSH Access

• GitLab SSH Access

• Bitbucket SSH Access

To generate an SSH Key

• Open Terminal.

• Paste the text below, substituting in your GitHub email address.

$ ssh-keygen -t ed25519 -C "your_email@example.com"
Note: If you are using a legacy system that doesn't support the Ed25519 algorithm, use:
$ ssh-keygen -t rsa -b 4096 -C "your_email@example.com"

This creates a new SSH key, using the provided email as a label.
Generating public/private ed25519 key pair.

• When you're prompted to "Enter a file in which to save the key," press Enter. This accepts the default file location.

> Enter a file in which to save the key (/Users/you/.ssh/id_ed25519): [Press enter]

• At the prompt, type a secure passphrase. 

> Enter passphrase (empty for no passphrase): [Type a passphrase]
> Enter same passphrase again: [Type passphrase again]

After setting up SSH access with your Git service, you should have both a public key that you provided to the Git service and a private key. Use these steps to add the private key to Domino:

1. Copy your SSH key

   From a terminal, pbcopy < ~/.ssh/id_rsa is the easiest way to copy the key to your clipboard assuming you set up your key with the standard name and in the standard location.

   If you copy the key manually, remember to include the -----BEGIN OPENSSH PRIVATE KEY----- and -----END OPENSSH PRIVATE KEY----- header and footer.

2. In Domino, click your username at the bottom of the main menu, then click Account Settings.

3. Scroll down to the panel labeled Git Credentials, then click Add a New Credential.

4. In the Domain field, enter the exact domain of the service hosting your repositories, such as github.com, bitbucket.com, or your-internal-gitlab-url.com.

5. For Authentication Credential Type, click to select Private SSH Key.

6. Paste in your private key. This will be the contents of the private key file that matches the public key you provided to your Git service.

7. If you set up your SSH keys to require a passphrase when used, enter it in the Passphrase field, then click Add Credential.

8. You should now see your credential listed in the Git Credentials panel. You can also delete it from this panel if desired.

Add a repository to a project

1. Open the project you want to add a repository to, then click Files from the left navigation bar.

2. Click to open the Git Repositories tab, then click Add a New Repository.

3. Enter an optional directory name and the HTTPS or SSH URI of the repository you want to add. The directory name will be the directory in /repos that this repository clones into. It defaults to the name of the repository.

4. Use the dropdown menu to choose which branch of the repository you want Domino to check out when it clones this repository into a run or workspace. If you leave this setting at Use default branch, Domino will check out the branch specified as default by your Git service, typically master. You can also specify a different branch name, tag name, commit ID, or supply a custom Git ref.

   

5. Click Add Repository.