adds text explaining ssh support in peers (#236)

* adds text explaining ssh support in peers * cleans small typo
netbirdio · Oct 4, 2024 · 331545a · 331545a
1 parent e5acced
commit 331545a
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/public/docs-static/img/how-to-guides/enable-ssh-access.png b/public/docs-static/img/how-to-guides/enable-ssh-access.png
diff --git a/src/pages/how-to/cli.mdx b/src/pages/how-to/cli.mdx
@@ -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 [email protected]
 ```
 
+#### 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