diff --git a/public/docs-static/img/how-to-guides/peer-approval-settings.png b/public/docs-static/img/how-to-guides/peer-approval-settings.png new file mode 100644 index 00000000..94de0e6f Binary files /dev/null and b/public/docs-static/img/how-to-guides/peer-approval-settings.png differ diff --git a/public/docs-static/img/how-to-guides/peer-needs-approval.png b/public/docs-static/img/how-to-guides/peer-needs-approval.png new file mode 100644 index 00000000..c7730db3 Binary files /dev/null and b/public/docs-static/img/how-to-guides/peer-needs-approval.png differ diff --git a/src/components/NavigationDocs.jsx b/src/components/NavigationDocs.jsx index a2002aa7..808ea234 100644 --- a/src/components/NavigationDocs.jsx +++ b/src/components/NavigationDocs.jsx @@ -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' }, diff --git a/src/pages/how-to/approve-peers.mdx b/src/pages/how-to/approve-peers.mdx new file mode 100644 index 00000000..b203c363 --- /dev/null +++ b/src/pages/how-to/approve-peers.mdx @@ -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. + + + This feature is only available in the [NetBird cloud](https://app.netbird.io/) version. + + +## Enable peer approval +To enable peer approval, navigate to [Settings » Authentication](https://app.netbird.io/settings) and enable 'Peer approval'. + +

+ peer-approval-settings +

+ + + When disabling peer approval, all pending approval requests will be automatically approved. + + +## 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. + +

+ peer-needs-approval +

+ +## Get started +

+ +

+ +- 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 \ No newline at end of file