-
Notifications
You must be signed in to change notification settings - Fork 141
Update ssh docs #442
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Update ssh docs #442
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
e85c0b2
Update ssh docs
heisbrot 89a6e5b
Add more ssh links
heisbrot 5966d22
Update src/pages/how-to/ssh.mdx
heisbrot bad0531
Add cli command
heisbrot 98af72a
Merge remote-tracking branch 'origin/ssh' into ssh
heisbrot 0d032bd
Apply suggestion from @mlsmaycon
mlsmaycon File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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> | ||
|
heisbrot marked this conversation as resolved.
|
||
| </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 | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.