Add docs for peer approval (#115)

This commit is contained in:
pascal-fischer
2023-12-30 13:32:14 +01:00
committed by GitHub
parent e26737f502
commit ab22272390
4 changed files with 41 additions and 0 deletions

View File

@@ -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' },

View File

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