mirror of
https://github.com/netbirdio/docs.git
synced 2026-04-20 17:36:36 +00:00
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:
69
src/pages/how-to/ssh.mdx
Normal file
69
src/pages/how-to/ssh.mdx
Normal 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
|
||||
Reference in New Issue
Block a user