|
| 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