I
Docs

Authentication

Generating a new SSH key

You can use your existing SSH key pair or generate a new SSH key pair to use for authentication.

Secure Shell Protocol (SSH) is the basis for connecting to your Outpost Machine when using VS Code Desktop, JetBrains Gateway, or accessing via the command-line from a local machine.

See command-line editors & IDEs documentation for more.

Manage your SSH Keys

Installing a supported SSH client

How to install a local SSH client depending on your operating system?

OSInstructions
Windows 10 1803+ / Server 2016/2019 1803+Install the Windows OpenSSH Client.
Earlier WindowsInstall Git for Windows.
macOSComes pre-installed.
Debian / Ubuntu / MintRun sudo apt-get install openssh-client
RHEL / Fedora / CentOSRun sudo yum install openssh-clients
Arch / ManjaroComes pre-installed.

Create an SSH key

Check to see if you already have an SSH key on your local machine. The key is typically located at ~/.ssh/id_ed25519.pub on macOS / Linux, and the .ssh directory in your user profile folder on Windows (for example C:\Users\your-user\.ssh\id_ed25519.pub).

If you do not have a key, run the following command in a local terminal / PowerShell to generate an SSH key pair:

bash
ssh-keygen -t ed25519

You will then be prompted to enter a secure passphrase, but you can leave that blank. You should now have a id_ed25519.pub file which contains your new public SSH key.

Note: If you are using a legacy system that doesn’t support the Ed25519 algorithm, you can use rsa instead: ssh-keygen -t rsa -b 4096
Tip: Don’t have ssh-keygen? Install a supported SSH client.

SSH file and folder permissions

macOS / Linux:

Folder / FilePermissions
.ssh in your user folderchmod 700 ~/.ssh
.ssh/config in your user folderchmod 600 ~/.ssh/config
.ssh/id_ed25519.pub in your user folderchmod 600 ~/.ssh/id_ed25519.pub
Any other key filechmod 600 /path/to/key/file

On your local machine, make sure the following permissions are set:

Windows:

The specific expected permissions can vary depending on the exact SSH implementation you are using. We recommend using the out of box Windows 10 OpenSSH Client.

In this case, make sure that all of the files in the .ssh folder for your remote user on the SSH host is owned by you and no other user has permissions to access it. See the Windows OpenSSH wiki for details.

For all other clients, consult your client’s documentation for what the implementation expects.