sendnrw/netbird-docs
2
0
Fork 0
mirror of https://github.com/netbirdio/docs.git synced 2026-04-22 02:16:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

Final Doc Restructure (#497)

Browse Source
This commit is contained in:
Brandon Hopkins
2025-11-27 09:50:03 -08:00
committed by GitHub
parent 846cae1fb0
commit e45bb7ce11
372 changed files with 353 additions and 536 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
src/pages/manage/settings/delete-account.mdx Normal file
View File

@@ -0,0 +1,32 @@
import {Note} from "@/components/mdx";
# Delete your NetBird account
To delete your NetBird organization account, you must be a user with the [owner role](/manage/team/add-users-to-your-network#manage-user-roles). You can ask the owner to delete the organization account if you are not the account owner.
## Delete your account
<Note>
Before proceeding to delete your Netbird account, please be aware that this action is irreversible. Once your account is deleted, you will permanently lose access to all associated data, including your peers, users, groups, policies, and routes.
</Note>
Go to the `Settings` tab, then click on `Danger Zone`. Review the message and click on the `Delete Account` button.
<p>
<img src="/docs-static/img/manage/settings/account-settings-danger-zone.png" alt="high-level-dia" className="imagewrapper-big"/>
</p>
To confirm, click on the `Delete` button.
<p>
<img src="/docs-static/img/manage/settings/account-settings-delete-account-confirm.png" alt="high-level-dia" className="imagewrapper"/>
</p>
After you delete your account, your session will end, and you will be redirected to the login page.
<Note>
If you log in again, a new account will be created.
</Note>
## 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 X](https://x.com/netbird)
- Join our [Slack Channel](/slack-url)
- NetBird [latest release](https://github.com/netbirdio/netbird/releases) on GitHub

50
src/pages/manage/settings/enforce-periodic-user-authentication.mdx Normal file
View File

@@ -0,0 +1,50 @@
# Enforce periodic user authentication
To ensure a high level of security, NetBird offers a peer login expiration feature that requires users to periodically reauthenticate their devices.
Every new network has this feature enabled, and the expiration period is set to 24 hours by default. You can disable this feature and configure the expiration period in the account settings in the web UI https://app.netbird.io/settings.
<Note>
This feature is only applied to peers added with the [interactive SSO login feature](/get-started/install#running-net-bird-with-sso-login). Peers, added with a setup key, won't be affected.
</Note>
Expired peers will appear in the peers' view with the status `Login required`.
<p>
<img src="/docs-static/img/manage/team/peer-needs-login.png" alt="peer-needs-login.png" className="imagewrapper-big"/>
</p>
## Configure and disable expiration
The expiration period can be set to anything between one hour and 180 days.
Go to the Web UI `Settings` tab and set the desired period in the Authentication section.
You can also disable the expiration for the whole network in the same section.
<p>
<img src="/docs-static/img/manage/team/peer-login-expiration.png" alt="peer-login-expiration" className="imagewrapper-big"/>
</p>
<Note>
Enabling peer expiration or changing the expiration period will cause some peers added with the SSO login to disconnect,
and re-authentication will be required.
</Note>
## Disable expiration individually per peer
Sometimes, you might want to disable peer expiration for some peers.
With NetBird you can disable login expiration per peer without disabling expiration globally.
In the Peers tab of the web UI click on the peer you want to disable expiration for and use the Login Expiration switch.
Peers with `Expiration disabled` will be marked with a corresponding label in the Peers table.
<p>
<img src="/docs-static/img/manage/team/individual-peer-login-expiration.png" alt="peer-login-expiration" 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 X](https://x.com/netbird)
- Join our [Slack Channel](/slack-url)
- NetBird [latest release](https://github.com/netbirdio/netbird/releases) on GitHub

64
src/pages/manage/settings/multi-factor-authentication.mdx Normal file
View 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 reused 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/manage/settings/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/manage/settings/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/manage/settings/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 X](https://x.com/netbird)
- Join our [Slack Channel](/slack-url)
- NetBird [latest release](https://github.com/netbirdio/netbird/releases) on GitHub

101
src/pages/manage/settings/plans-and-billing.mdx Normal file
View File

@@ -0,0 +1,101 @@
# Plans and billing
## NetBird Plans
NetBird offers diverse plans to accommodate various networking needs, ensuring scalable and secure connectivity.
- **Free Plan:** The Free plan provides secure connectivity for up to 5 users and 100 machines suitable for individuals or small teams.
It features peer-to-peer connections and encryption, access control, routing, and private DNS. This plan includes Single Sign-On (SSO) integration with identity providers like Google Workspace, Azure, and Okta.
- **Team Plan:** Priced at **$5 per user per month**, the Team Plan offers unlimited admin and regular users, multi-factor authentication (MFA), access and connection logging, user and group provisioning and sync from your identity provider (IdP), and custom SSO login options, making it ideal for larger teams seeking scalable and secure connectivity.
- **Business Plan:** At **$12 per user per month**, the Business Plan offers enhanced network security with a Zero Trust approach. It supports unlimited users and includes features like device approvals and integrations (MDM and EDR) for comprehensive control, device posture checks and activity events streaming, making it an excellent choice for organizations seeking advanced security solutions.
<p>
<img src="/docs-static/img/manage/settings/pricing-overview.png" alt="pricing-overview" className="imagewrapper-big"/>
</p>
Details can be found on our [pricing page](https://netbird.io/pricing).
## Usage-based Billing
NetBird uses a pay-as-you-go model, charging only for active users or machines.
We bill you at the end of each monthly cycle based on actual usage:
* A user or machine counts as "active" only if it connects or logs in (including the admin dashboard) at least once during the billing period.
* If you integrate NetBird with your [Identity Provider (IdP)](/manage/team/idp-sync),
we automatically sync your users and machines. Inactive synced user accounts that never connect or log in won't incur charges.
Example:
You sync 300 users from Entra ID, but only 100 connect during the month. You're billed for 100 users, not 300.
If the next month only 70 connect, you pay for 70 users.
Refer to our pricing calculator on the [pricing page](https://netbird.io/pricing#calculator) to estimate your monthly costs based on your expected usage.
<p>
<img src="/docs-static/img/manage/settings/plans-and-billing/calculator.png" alt="pricing-calculator" className="imagewrapper-big"/>
</p>
## Machine-based Usage
NetBird offers scalable plans for networks with a machine-based usage model. This approach is relevant, among other scenarios,
for IoT use cases where there is a large number of machines on the network but comparatively fewer users.
This option is available under both Team and Business plans. Simply subscribe to the Team or Business plan, and we'll
automatically adjust the machine costs as detailed in the following sections.
### Inclusive Machine Allowance
- **Team and Business plans**: Start with 100 free machines and an extra 10 machines for each paid user.
- **Example**: a Team plan with 10 users provides:
- `(10 users × 10 machines/user) + 100 base machines = 200 machines`
### Additional Machine Billing
- Extra machines are billed at a set rate per machine.
- **Example**: Adding 20 extra machines to a Team plan with 10 users:
- Base plan cost: `(10 users × €5/user) = €50`
- Extra machines cost: `(20 extra machines × €0.5/machine) = €10`
- **Total monthly cost**: `€50 + €10 = €60`
## Starting a Subscription
To start or change your current plan, navigate to `Settings` > `Plans & Billing` and choose the plan you wish to upgrade or downgrade to.
<p>
<img src="/docs-static/img/manage/settings/plans-and-billing/chose-plan.png" alt="chose-plan" width="780" className="imagewrapper-big"/>
</p>
**Payment Information**
Next, you'll be directed to enter your payment information. Available payment options currently include credit cards, Google Pay, and Link.
<p>
<img src="/docs-static/img/manage/settings/payment-information.png" alt="payment-information" className="imagewrapper-big"/>
</p>
**Confirmation and Billing Cycle**
After successfully submitting your payment information, the updated version of your plan will be reflected in your account.
<p>
<img src="/docs-static/img/manage/settings/plans-and-billing/plans-billing-overview.png" alt="plans-billing-overview" className="imagewrapper-big"/>
</p>
<Note>
Please note that changes to the number of peers and user counts are updated in our system daily at 2 AM UTC. So, it might take up to 24 hours for these changes to show in your account.
</Note>
## Changing a Subscription
Based on your current plan, you have the flexibility to upgrade or downgrade at any time as your needs change.
<Note>
Your subscription cycle starts on the first day of your original subscription. If you adjust your plan during the billing cycle, and since billing occurs at the end of the subscription month, you will be charged for the plan you are on at the end of the billing cycle.
</Note>
## Deleting an Account
If you [delete your account](/manage/settings/delete-account), the final charge for your usage will be processed during the next daily statistics update cycle at 2 AM UTC.