Skip to content

Update/ssh UI #51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 22, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 23 additions & 24 deletions src/user-manual/ssh.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,18 @@
# Using SSH

Like other Linux distributions, StartOS allow you to go "under-the-hood" via Secure Shell Protocol (SSH).
Like other Linux distributions, StartOS allows you to go "under-the-hood" via Secure Shell Protocol (SSH).

```admonish warning
Accessing your server via SSH is considered advanced. Please use caution, you can cause permanent damage to your server, potentially resulting in loss of data.
```

## Instructions
#### Contents

- [Using your StartOS master password](#using-your-startos-master-password)
- [Using your own SSH Keys](#using-your-own-ssh-keys)
- [Connecting via PuTTY on Windows](#connecting-via-putty-on-windows)

## Using your StartOS master password

1. Open a terminal on your client device and enter:

Expand Down Expand Up @@ -37,40 +43,33 @@ Accessing your server via SSH is considered advanced. Please use caution, you ca
Fear not! This is most likely happening because you have recently re-flashed your server, which causes a change in the key for your device's hostname. The solution is to delete the existing entry from your `known_hosts` file, which is typically located at `~/.ssh/known_hosts`. This will be specified in the warning, along with a helpful line number (in case your file is lengthy).
```

### Connecting via PuTTY on Windows
### Using your own SSH Keys

For Windows, following the command above will work. But if you prefer a GUI tool, <a href="https://brewsbitcoin.com" target="_blank">BrewsBitcoin</a> has created a guide for <a href="https://medium.com/@brewsbitcoin/ssh-to-start9-embassy-from-windows-4a4e17891b5a" target="_blank">connecting via SSH using PuTTY on Windows</a>
1. In the StartOS UI, go to `System > SSH`

### Adding SSH Keys
1. Click `Add Key`, paste in your key and click `Save`

1. Follow the guide above to first access your server via SSH using your StartOS master password.
1. Open a terminal on your client device and enter:

1. Add your key with the following command:
ssh start9@SERVER-HOSTNAME

```
start-cli ssh add <key>
```
Replace `SERVER-HOSTNAME` with your server's `adjective-noun.local` address URL.

Replaceing `<key>` with quotation marks `""` surrounding your copied key.
1. Enter your key's passphrase (if any)

For example:
1. The first time you connect, you will see something like this:

```
start-cli ssh add "ssh-ed25519 5T4RT95T4RT95T4RT95T4RT95T4RT9 user@clienthost"
```
The authenticity of host 'adjective-noun.local (192.168.1.175)' can't be established.

1. Confirm the key was added correctly with:
ED25519 key fingerprint is SHA256:BgYhzyIDbshm3annI1cfySd8C4/lh6Gfk2Oi3FdIVAa.

```
start-cli ssh list
```
This key is not known by any other names.

```admonish tip
Are you sure you want to continue connecting (yes/no/[fingerprint])?

This will show the added keys' fingerprints. You'll need the fingerprint if you want to remove an SSH key with:
Type "yes" and hit Enter to start trusting the server's SSH public key.

`start-cli ssh remove 00:11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff`

```
## Connecting via PuTTY on Windows

1. Type `exit` and hit enter to leave the current session. Next time you connect via SSH, your key will be used instead of providng your master password.
For Windows, following the command above will work. But if you prefer a GUI tool, <a href="https://brewsbitcoin.com" target="_blank">BrewsBitcoin</a> has created a guide for <a href="https://medium.com/@brewsbitcoin/ssh-to-start9-embassy-from-windows-4a4e17891b5a" target="_blank">connecting via SSH using PuTTY on Windows</a>