Update ssh docs (#442)

* Update ssh docs

* Add more ssh links

* Update src/pages/how-to/ssh.mdx

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Add cli command

* Apply suggestion from @mlsmaycon

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Maycon Santos <mlsmaycon@gmail.com>
This commit is contained in:
Eduard Gert
2025-10-07 17:26:41 +02:00
committed by GitHub
parent eb031239d5
commit 13e9e98177
6 changed files with 83 additions and 8 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 290 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 134 KiB

View File

@@ -58,6 +58,7 @@ export const docsNavigation = [
{ title: 'Approve Peers', href: '/how-to/approve-peers' },
{ title: 'Setup Keys', href: '/how-to/register-machines-using-setup-keys' },
{ title: 'Browser Client', href: '/how-to/browser-client' },
{ title: 'SSH', href: '/how-to/ssh' },
{ title: 'Lazy Connections', href: '/how-to/lazy-connection'},
{
title: 'Access Infrastructure',

View File

@@ -21,7 +21,7 @@ Before using the Browser Client, ensure:
1. **Admin privileges** - You must be logged into the NetBird dashboard with an admin account (required for temporary ACL creation)
2. **Protocol requirements**:
- **For SSH**: The NetBird SSH server must be enabled on the target peer
- **For SSH**: The NetBird SSH server must be enabled on the target peer. Learn more about [enabling SSH access](/how-to/ssh).
- **For RDP**: The RDP server must be enabled on the target machine
3. **Modern browser** - You're using an up-to-date version of Chrome, Firefox, Edge, or Safari with WebAssembly support
@@ -46,6 +46,10 @@ When connecting via SSH:
1. Click the **SSH** button for your target peer
2. A credentials modal will appear
<Note>
Before connecting via SSH, make sure that SSH Access is enabled both on the target peer and in the NetBird Dashboard. Learn more about [enabling SSH access](/how-to/ssh).
</Note>
<p>
<img src="/docs-static/img/how-to-guides/browser-client/ssh-credentials-modal.png" alt="ssh-credentials-modal" className="imagewrapper-big"/>
</p>
@@ -58,10 +62,6 @@ When connecting via SSH:
<img src="/docs-static/img/how-to-guides/browser-client/ssh-terminal-connected.png" alt="ssh-terminal-connected" className="imagewrapper-big"/>
</p>
<Note>
**NetBird SSH Required**: The target peer must have NetBird's SSH server enabled. Learn how to [enable SSH access](/how-to/cli#ssh).
</Note>
### RDP Connection
For RDP access:

View File

@@ -394,7 +394,9 @@ Peers count: 2/3 Connected
### ssh
Command to connect using ssh to a remote peer in your NetBird network.
<Note>
Before using this command, make sure that SSH Access is enabled both on the target peer and in the NetBird Dashboard. Learn more about [enabling SSH access](/how-to/ssh).
</Note>
You should run the ssh command with elevated permissions.
#### Flags
```shell
@@ -419,11 +421,14 @@ When you try to connect via `netbird ssh <peer>`, errors can occur. Please enabl
```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.
Ensure that the peer you are trying to connect to has `SSH Access` enabled in the dashboard, under Peers > _your_peer_ > SSH Access.
<p>
<img src="/docs-static/img/how-to-guides/enable-ssh-access.png" alt="high-level-dia" className="imagewrapper-big"/>
<img src="/docs-static/img/ssh/ssh-dashboard.png" alt="netbird ssh dashboard" className="imagewrapper-big" />
</p>
### version
Outputs the `netbird` command version.
#### Usage

69
src/pages/how-to/ssh.mdx Normal file
View File

@@ -0,0 +1,69 @@
import {Note} from "@/components/mdx";
# SSH
NetBird provides secure SSH access to your peers through its built-in SSH server, allowing you to connect to remote machines without exposing SSH ports to the internet.
<Note>
SSH Access is disabled by default and must be enabled both on the target peer and in the NetBird Dashboard.
</Note>
## Requirements
To use SSH access through NetBird, you need to enable SSH in two places:
1. **NetBird Client Settings** - Enable SSH on the target peer
2. **NetBird Dashboard** - Allow SSH access for the peer
## Enabling SSH
### Step 1: Enable SSH Server on Target Peer
On the machine you want to access via SSH:
1. Click on the NetBird tray icon
2. Navigate to Settings
3. Click on **Allow SSH** to enable the SSH server
If you are using the CLI, you can enable SSH by running:
```bash
netbird down # if NetBird is already running
netbird up --allow-server-ssh
```
<p>
<img src="/docs-static/img/ssh/ssh-client.png" alt="netbird ssh client" className="imagewrapper" />
</p>
### Step 2: Enable SSH in Dashboard
1. Log in to your NetBird Dashboard
2. Navigate to the target peer details page
3. Enable SSH access for the peer
4. Save the changes
<p>
<img src="/docs-static/img/ssh/ssh-dashboard.png" alt="netbird ssh dashboard" className="imagewrapper-big" />
</p>
## Using SSH
### CLI
For SSH access through the command line interface (CLI), refer to the [CLI documentation](/how-to/cli#ssh) for detailed instructions on establishing SSH connections using the NetBird CLI.
### Browser Client
For SSH access through the Browser Client, refer to the [Browser Client documentation](/how-to/browser-client#ssh-connection) for detailed instructions on establishing SSH connections directly from your web browser.
## Get started
<p float="center" >
<Button name="button" className="button-5" onClick={() => window.open("https://netbird.io/pricing")}>Use NetBird</Button>
</p>
- Make sure to [star us on GitHub](https://github.com/netbirdio/netbird)
- Follow us [on X](https://x.com/netbird)
- Join our [Slack Channel](/slack-url)
- NetBird [latest release](https://github.com/netbirdio/netbird/releases) on GitHub