adds text explaining ssh support in peers (#236)

* adds text explaining ssh support in peers

* cleans small typo
This commit is contained in:
Marco Garcês
2024-10-04 12:29:55 +01:00
committed by GitHub
parent e5acced50f
commit 331545a1fe
2 changed files with 10 additions and 0 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

View File

@@ -381,6 +381,16 @@ If you the remote peer agent is running the ssh service on a different port, you
sudo netbird ssh -p 3434 user@100.119.230.104
```
#### Troubleshooting
When you try to connect via `netbird ssh <peer>`, errors can occur. Please enable `ssh` support when joining a peer to your account.
```shell
netbird up --allow-server-ssh
```
This will allow the the `SSH Access feature` to work when enabled in the dashboard, under Peers > _your_peer_ > SSH Access.
<p>
<img src="/docs-static/img/how-to/enable-ssh-access.png" alt="high-level-dia" className="imagewrapper-big"/>
</p>
### version
Outputs the `netbird` command version.
#### Usage