mirror of
https://github.com/netbirdio/docs.git
synced 2026-04-16 15:36:36 +00:00
Add MFA docs (#248)
This commit is contained in:
@@ -159,6 +159,7 @@ export const docsNavigation = [
|
||||
isOpen: false,
|
||||
links: [
|
||||
{title: 'Authentication', href: '/how-to/enforce-periodic-user-authentication' },
|
||||
{title: 'Multi-Factor Authentication', href: '/how-to/multi-factor-authentication' },
|
||||
{title: 'Delete account/danger zone', href: '/how-to/delete-account' },
|
||||
{title: 'Plans and billing', href: '/how-to/plans-and-billing' }
|
||||
|
||||
|
||||
64
src/pages/how-to/multi-factor-authentication.mdx
Normal file
64
src/pages/how-to/multi-factor-authentication.mdx
Normal file
@@ -0,0 +1,64 @@
|
||||
# Multi-Factor Authentication (MFA)
|
||||
|
||||
NetBird supports Multi-Factor Authentication (MFA) to enhance the security of your account by requiring a second form of verification during login.
|
||||
This works automatically if you have enabled MFA in your SSO Provider (Google, Microsoft etc.) and use the **interactive SSO login** feature in NetBird.
|
||||
|
||||
NetBird MFA is primarily for users with **email / password login**. It is available for all users and can be enabled from the Dashboard on the Settings page [https://app.netbird.io/settings](https://app.netbird.io/settings).
|
||||
|
||||
<Note>
|
||||
You may not need NetBird MFA. Your SSO Provider (Google, Microsoft etc.) may already have MFA enabled. Enabling this setting could result in duplicated MFA checks.
|
||||
</Note>
|
||||
<Note>
|
||||
This feature is only available in the cloud version of NetBird. <br />Self-Hosted users can use their own Identity Provider for MFA.
|
||||
</Note>
|
||||
|
||||
## Enabling and Disabling MFA
|
||||
Navigate to the Dashboard's `Settings` page and the `Authentication` tab and enable or disable MFA. <br />
|
||||
After enabling, you can `Logout` and log back in to see the MFA prompt.
|
||||
|
||||
- When disabling MFA, the current active MFA devices of all users will not be removed and will be re-used when MFA is enabled again. To remove MFA devices from users, check the [Reset MFA](#reset-mfa) section below.
|
||||
- If a user is not part of the account and MFA is enabled, the first-time `Sign Up` will not require MFA. <br /> Only subsequent logins will require MFA.
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/how-to-guides/mfa/mfa-settings.png" alt="MFA Settings" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
|
||||
### Remember Browser for MFA
|
||||
When you enable MFA, you can choose to remember your browser for 30 days. This means you will only need to enter the MFA code once every 30 days.
|
||||
When disabled, you will need to enter the MFA code every time you log in.<br />
|
||||
Once enabled you will see a checkbox to remember your browser for 30 days while entering the MFA code during login.
|
||||
|
||||
|
||||
## Checking User MFA Status
|
||||
You can check individual user MFA status by going to the `Users` page of the Dashboard.<br />
|
||||
Click on a specific user to see their MFA status.
|
||||
- `Active` - MFA is enabled and user **has completed** the MFA setup.
|
||||
- `Not enrolled` - MFA is enabled but user **has not completed** the MFA setup yet.
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/how-to-guides/mfa/mfa-not-enrolled.png" alt="MFA Status" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
## Reset MFA
|
||||
To reset MFA for a specific user, click on the user in the `Users` tab and click on the `Reset MFA` button.<br />
|
||||
This will reset MFA for the user, and they will need to set it up again during the next login.
|
||||
|
||||
<Note>
|
||||
Currently NetBird does not provide recovery codes for MFA. Make sure to have multiple administrators configured to prevent lockout situations.
|
||||
If all `Owners` or `Admins` lose access to the Dashboard, you should contact [support@netbird.io](mailto:support@netbird.io) for assistance.
|
||||
</Note>
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/how-to-guides/mfa/mfa-reset-mfa.png" alt="MFA Reset" className="imagewrapper-big"/>
|
||||
</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-2p5zwhm4g-8fHollzrQa5y4PZF5AEpvQ)
|
||||
- NetBird [latest release](https://github.com/netbirdio/netbird/releases) on GitHub
|
||||
Reference in New Issue
Block a user