Skip to content
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.

Sign up for GitHub

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

Jump to bottom

adds text explaining ssh support in peers #236

Merged
merged 2 commits into from
Oct 4, 2024
Merged

adds text explaining ssh support in peers #236

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4e5694f
adds text explaining ssh support in peers
mgarces Sep 27, 2024
1f0712a
cleans small typo
mgarces Sep 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added public/docs-static/img/how-to-guides/enable-ssh-access.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 10 additions & 0 deletions src/pages/how-to/cli.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -381,6 +381,16 @@ If you the remote peer agent is running the ssh service on a different port, you
sudo netbird ssh -p 3434 [email protected]
```

#### Troubleshooting
When you try to connect via `netbird ssh <peer>`, errors can occur. Please enable `ssh` support when joining a peer to your account.
```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.
<p>
<img src="/docs-static/img/how-to/enable-ssh-access.png" alt="high-level-dia" className="imagewrapper-big"/>
</p>

### version
Outputs the `netbird` command version.
#### Usage
Expand Down
Loading