Skip to content

Commit

Permalink
Add docs for peer approval (#115)
Browse files Browse the repository at this point in the history
  • Loading branch information
pascal-fischer authored Dec 30, 2023
1 parent e26737f commit ab22272
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 0 deletions.
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.
1 change: 1 addition & 0 deletions src/components/NavigationDocs.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ export const docsNavigation = [
]
},*/
{ title: 'Add machines to your network', href: '/how-to/add-machines-to-your-network' },
{ title: 'Approve peers', href: '/how-to/approve-peers' },
{ title: 'Add users to your network', href: '/how-to/add-users-to-your-network' },
{ title: 'Use setup keys for automation', href: '/how-to/register-machines-using-setup-keys' },
{ title: 'Manage network access', href: '/how-to/manage-network-access' },
Expand Down
40 changes: 40 additions & 0 deletions src/pages/how-to/approve-peers.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
import {Note} from "@/components/mdx";

# Approve peers
The peer approval feature enhances network security by requiring manual administrator approval before a device can join the NetBird network.
This feature is handy when network administrators want to ensure access is restricted only to trusted, corporate-managed devices.

When enabled, devices connect to the management service without network access to other resources.
Administrators then can assess whether the peer is eligible to join the network.

<Note>
This feature is only available in the [NetBird cloud](https://app.netbird.io/) version.
</Note>

## Enable peer approval
To enable peer approval, navigate to [Settings &raquo; Authentication](https://app.netbird.io/settings) and enable 'Peer approval'.

<p>
<img src="/docs-static/img/how-to-guides/peer-approval-settings.png" alt="peer-approval-settings" className="imagewrapper"/>
</p>

<Note>
When disabling peer approval, all pending approval requests will be automatically approved.
</Note>

## Approve peer
To approve a peer, navigate to the [peers tab](https://app.netbird.io/peers) and click the 'needs approval' button under the peer's name.

<p>
<img src="/docs-static/img/how-to-guides/peer-needs-approval.png" alt="peer-needs-approval" className="imagewrapper"/>
</p>

## 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 Twitter](https://twitter.com/netbird)
- Join our [Slack Channel](https://join.slack.com/t/netbirdio/shared_invite/zt-vrahf41g-ik1v7fV8du6t0RwxSrJ96A)
- NetBird [latest release](https://github.com/netbirdio/netbird/releases) on GitHub

0 comments on commit ab22272

Please sign in to comment.