Skip to main content

Connect with SSH

SSH is the recommended method to connect to and use your virtual machines. While it's possible to connect using a password, we strongly recommend using an SSH key for enhanced security. This guide will walk you through both methods, using a password or SSH keys.

Connect with a password​

  1. Copy your virtual machine's IP address from the virtual machine details.
  2. Open your terminal or SSH client, and run ssh root@<your-ip-address>
  3. Accept the host's fingerprint when prompted.
  4. Enter the password from the virtual machine details when prompted.

You should now be connected to your virtual machine

Setup SSH keys​

SSH keys provide a secure and convenient way to connect to your virtual machines in Katapult. You can manage them both the organization and user levels.

How SSH keys work

SSH keys are cryptographic pairs: a public key on the server and a private key on the client. The client uses the private key to prove its identity, and the server verifies it with the public key. This ensures secure access.

Add an organization SSH key​

  1. Navigate to Access > SSH Keys in the main menu.
  2. Click Add Key
  3. Give your key an identifiable name.
  4. Enter your SSH Public Key.
  5. Select any address lists you wish to restrict the key to.
  6. Review your details and click Create SSH Key.
Web Form for adding an organization SSH key.Web Form for adding an organization SSH key.

Add a user SSH key​

User SSH keys are managed in Identity.

  1. Click your avatar in the top-right corner.
  2. Select My settings from the dropdown menu.
  3. Go to SSH keys in the side menu.
  4. Click Add key.
  5. Give your key an identifiable name.
  6. Enter your SSH Public Key.
  7. Enter any networks you wish to restrict your key to.
  8. Review your details and click Add SSH key.

Manage SSH keys​

Katapult can automatically update the authorized keys for your virtual machines. To configure this:

  1. Open your virtual machine in the Virtual Machines section.
  2. Go to Configuration > SSH keys.
  3. Adjust the settings as needed:
    • Continuous management: Automatically updates authorized keys on the virtual machine.
    • Users: Add all user SSH keys. Disable to select specific users.
    • Organizations: Adds all organization SSH keys. Disable to select specific organization keys.
  4. Save your changes.
Web Form for adding an organization SSH key.Web Form for adding an organization SSH key.

Connect with SSH keys​

Once your SSH keys have been updated and set up, you will be able to log in using SSH:

  1. Copy the IP address of your virtual machine from the details page.
  2. Open a terminal or SSH client and run ssh root@<your-ip-address>
  3. Accept the new host's fingerprint.

You should now be connected to your virtual machine