Skip to content

Commit e85c0b2

Browse files
committed
Update ssh docs
1 parent eb03123 commit e85c0b2

6 files changed

Lines changed: 72 additions & 4 deletions

File tree

290 KB
Loading
134 KB
Loading

‎src/components/NavigationDocs.jsx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ export const docsNavigation = [
5858
{ title: 'Approve Peers', href: '/how-to/approve-peers' },
5959
{ title: 'Setup Keys', href: '/how-to/register-machines-using-setup-keys' },
6060
{ title: 'Browser Client', href: '/how-to/browser-client' },
61+
{ title: 'SSH', href: '/how-to/ssh' },
6162
{ title: 'Lazy Connections', href: '/how-to/lazy-connection'},
6263
{
6364
title: 'Access Infrastructure',

‎src/pages/how-to/browser-client.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ When connecting via SSH:
5959
</p>
6060

6161
<Note>
62-
**NetBird SSH Required**: The target peer must have NetBird's SSH server enabled. Learn how to [enable SSH access](/how-to/cli#ssh).
62+
**NetBird SSH Required**: The target peer must have NetBird's SSH server enabled. <br/> Learn how to [enable SSH access](/how-to/ssh).
6363
</Note>
6464

6565
### RDP Connection

‎src/pages/how-to/cli.mdx‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -394,7 +394,9 @@ Peers count: 2/3 Connected
394394

395395
### ssh
396396
Command to connect using ssh to a remote peer in your NetBird network.
397-
397+
<Note>
398+
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).
399+
</Note>
398400
You should run the ssh command with elevated permissions.
399401
#### Flags
400402
```shell
@@ -419,11 +421,14 @@ When you try to connect via `netbird ssh <peer>`, errors can occur. Please enabl
419421
```shell
420422
netbird up --allow-server-ssh
421423
```
422-
This will allow the the `SSH Access feature` to work when enabled in the dashboard, under Peers > _your_peer_ > SSH Access.
424+
425+
Ensure that the peer you are trying to connect to has `SSH Access` enabled in the dashboard, under Peers > _your_peer_ > SSH Access.
426+
423427
<p>
424-
<img src="/docs-static/img/how-to-guides/enable-ssh-access.png" alt="high-level-dia" className="imagewrapper-big"/>
428+
<img src="/docs-static/img/ssh/ssh-dashboard.png" alt="netbird ssh dashboard" className="imagewrapper-big" />
425429
</p>
426430

431+
427432
### version
428433
Outputs the `netbird` command version.
429434
#### Usage

‎src/pages/how-to/ssh.mdx‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
import {Note} from "@/components/mdx";
2+
3+
# SSH
4+
5+
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.
6+
7+
<Note>
8+
SSH Access is disabled by default and must be enabled both on the target peer and in the NetBird Dashboard.
9+
</Note>
10+
11+
12+
## Requirements
13+
14+
To use SSH access through NetBird, you need to enable SSH in two places:
15+
16+
1. **NetBird Client Settings** - Enable SSH on the target peer
17+
2. **NetBird Dashboard** - Allow SSH access for the peer
18+
19+
## Enabling SSH
20+
21+
### Step 1: Enable SSH Server on Target Peer
22+
23+
On the machine you want to access via SSH:
24+
25+
1. Click on the NetBird tray icon
26+
2. Navigate Settings
27+
3. Click on **Allow SSH** to enable the SSH server
28+
29+
<p>
30+
<img src="/docs-static/img/ssh/ssh-client.png" alt="netbird ssh client" className="imagewrapper" />
31+
</p>
32+
33+
### Step 2: Enable SSH in Dashboard
34+
35+
1. Log in to your NetBird Dashboard
36+
2. Navigate to the target peer details page
37+
3. Enable SSH access for the peer
38+
4. Save the changes
39+
40+
<p>
41+
<img src="/docs-static/img/ssh/ssh-dashboard.png" alt="netbird ssh dashboard" className="imagewrapper-big" />
42+
</p>
43+
44+
## Using SSH
45+
46+
### CLI
47+
48+
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.
49+
50+
### Browser Client
51+
52+
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.
53+
54+
## Get started
55+
<p float="center" >
56+
<Button name="button" className="button-5" onClick={() => window.open("https://netbird.io/pricing")}>Use NetBird</Button>
57+
</p>
58+
59+
- Make sure to [star us on GitHub](https://github.com/netbirdio/netbird)
60+
- Follow us [on X](https://x.com/netbird)
61+
- Join our [Slack Channel](/slack-url)
62+
- NetBird [latest release](https://github.com/netbirdio/netbird/releases) on GitHub

0 commit comments

Comments
 (0)