Appearance

Project SSH keys ​

Project SSH keys belong to a project instead of a person. They grant SSH access to the project in addition to the SSH keys of your team members, and keep working regardless of who is part of your team.

Use project SSH keys whenever something other than a team member needs to access your project via SSH, for example:

  • your own CI/CD pipeline deploying the project,
  • automated jobs, like backups or data imports, running on another system,
  • an external agency that should not need a Hubble Studio account.

You can find the project SSH keys in the SSH keys tab of your project. Every team member can see them, but only owners of the team (or of the team's organization) can add, edit and remove keys.

WARNING

Project SSH keys grant access to your project, independent of your team's members. Removing a member from your team does not remove any project SSH key they added. Regularly review your project SSH keys and remove the ones that are no longer needed.

Adding an SSH key ​

  1. Open your project and navigate to the SSH keys tab.
  2. Enter the details of your SSH key:
    • Public Key: The SSH public key, e.g. ssh-ed25519 AAAA....
    • Comment: A brief description to help identify the key, e.g. "GitLab deployment pipeline".
  3. Click "Add SSH-Key" to add the key to your project.

Each SSH key can only be added once per project. By default, a project can have up to 25 SSH keys. If you need more, contact our support team.

Please note that it may take up to 5 minutes for the new SSH key to be available in your project.

Editing an SSH key ​

  1. Open your project and navigate to the SSH keys tab.
  2. Find the SSH key you want to edit and click on the "Edit" button next to it.
  3. Change the comment and click "Save SSH-Key".

Only the comment of an SSH key can be changed. To replace the key itself, add the new SSH key and remove the old one afterwards.

Removing an SSH key ​

  1. Open your project and navigate to the SSH keys tab.
  2. Find the SSH key you want to remove and click on the "Delete" button next to it.

The SSH key is removed from your project immediately. Please note that it may take up to 5 minutes for the SSH key to lose its access to your project.

Connecting with a project SSH key ​

Project SSH keys use the same connection details as the SSH keys of your team members. You can find the host, username and port of your project under Services > SSH. See the SSH service for more details.

Managing project SSH keys via the API ​

Project SSH keys can also be listed, added, edited and removed through the Hubble Studio API, which comes in handy when you automate the setup of your projects. You'll find the endpoints in the API Docs, linked in the top navigation. To authenticate with the API, create a personal access token.

The same permissions apply as in Hubble Studio: every team member can list the project SSH keys, while only owners of the team can add, edit and remove them.