Skip to content

Commit e0c3b86

Browse files
imronImron Alston
authored andcommitted
Update ssh key instructions
Add instructions to edit ~/.ssh/config so that it contains an entry for `ssh.balena-devices.com` that uses the newly added key, otherwise `balena ssh` won't know which key to use. Change-type: patch Signed-off-by: Imron Alston <imron.alston@elenium.com>
1 parent fa78a8e commit e0c3b86

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

shared/general/container-ssh.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,14 @@ You may either import an existing SSH key from GitHub or manually enter the publ
5555

5656
If you do not have an existing key, you can follow [GitHub's documentation][github-ssh], skipping the step about adding the key to your GitHub account, and instead adding the key to your {{ $names.cloud.lower }} account.
5757

58+
Once you have added a key your your account, you should also add an entry for `ssh.balena-devices.com` to your `~/.ssh/config` file so that the `balena ssh` command knows to use this key:
59+
60+
```shell
61+
Host ssh.balena-devices.com
62+
User <USER>
63+
IdentityFile ~/.ssh/<PRIVATE_KEY>
64+
```
65+
5866
## Using a standalone SSH client
5967

6068
If you prefer to use a standalone SSH client to connect to the device, the SSH server on a device listens on TCP port `22222`. While development images have passwordless root access enabled, production images require an SSH key to be added to the `config.json` file.

0 commit comments

Comments
 (0)