diff --git a/public/docs-static/img/how-to-guides/account-settings-danger-zone.png b/public/docs-static/img/how-to-guides/account-settings-danger-zone.png index c8d3f316..796fdc1f 100644 Binary files a/public/docs-static/img/how-to-guides/account-settings-danger-zone.png and b/public/docs-static/img/how-to-guides/account-settings-danger-zone.png differ diff --git a/public/docs-static/img/how-to-guides/account-settings-delete-account-confirm.png b/public/docs-static/img/how-to-guides/account-settings-delete-account-confirm.png index e4ef926e..18ea9609 100644 Binary files a/public/docs-static/img/how-to-guides/account-settings-delete-account-confirm.png and b/public/docs-static/img/how-to-guides/account-settings-delete-account-confirm.png differ diff --git a/public/docs-static/img/how-to-guides/activity-monitoring.png b/public/docs-static/img/how-to-guides/activity-monitoring.png index 3b9967c9..5173e53b 100644 Binary files a/public/docs-static/img/how-to-guides/activity-monitoring.png and b/public/docs-static/img/how-to-guides/activity-monitoring.png differ diff --git a/public/docs-static/img/how-to-guides/activity-monitoring.webp b/public/docs-static/img/how-to-guides/activity-monitoring.webp new file mode 100644 index 00000000..6c7de1be Binary files /dev/null and b/public/docs-static/img/how-to-guides/activity-monitoring.webp differ diff --git a/public/docs-static/img/how-to-guides/individual-peer-login-expiration.png b/public/docs-static/img/how-to-guides/individual-peer-login-expiration.png index 808e74fc..37b0bc05 100644 Binary files a/public/docs-static/img/how-to-guides/individual-peer-login-expiration.png and b/public/docs-static/img/how-to-guides/individual-peer-login-expiration.png differ diff --git a/public/docs-static/img/how-to-guides/netbird-network-routes-create-groups.png b/public/docs-static/img/how-to-guides/netbird-network-routes-create-groups.png new file mode 100644 index 00000000..20727f73 Binary files /dev/null and b/public/docs-static/img/how-to-guides/netbird-network-routes-create-groups.png differ diff --git a/public/docs-static/img/how-to-guides/netbird-network-routes-create-ha.png b/public/docs-static/img/how-to-guides/netbird-network-routes-create-ha.png index 98a5ace9..29f99ae6 100644 Binary files a/public/docs-static/img/how-to-guides/netbird-network-routes-create-ha.png and b/public/docs-static/img/how-to-guides/netbird-network-routes-create-ha.png differ diff --git a/public/docs-static/img/how-to-guides/netbird-network-routes-create.png b/public/docs-static/img/how-to-guides/netbird-network-routes-create.png index 75fb44d7..44dffcb1 100644 Binary files a/public/docs-static/img/how-to-guides/netbird-network-routes-create.png and b/public/docs-static/img/how-to-guides/netbird-network-routes-create.png differ diff --git a/public/docs-static/img/how-to-guides/netbird-network-routes-groups-attribution.png b/public/docs-static/img/how-to-guides/netbird-network-routes-groups-attribution.png index 98dd0939..cb9841bd 100644 Binary files a/public/docs-static/img/how-to-guides/netbird-network-routes-groups-attribution.png and b/public/docs-static/img/how-to-guides/netbird-network-routes-groups-attribution.png differ diff --git a/public/docs-static/img/how-to-guides/netbird-network-routes-groups-create.png b/public/docs-static/img/how-to-guides/netbird-network-routes-groups-create.png index 966b2082..9b6ab196 100644 Binary files a/public/docs-static/img/how-to-guides/netbird-network-routes-groups-create.png and b/public/docs-static/img/how-to-guides/netbird-network-routes-groups-create.png differ diff --git a/public/docs-static/img/how-to-guides/netbird-network-routes-saved-new-ha.png b/public/docs-static/img/how-to-guides/netbird-network-routes-saved-new-ha.png index 2f5ad959..33870fc7 100644 Binary files a/public/docs-static/img/how-to-guides/netbird-network-routes-saved-new-ha.png and b/public/docs-static/img/how-to-guides/netbird-network-routes-saved-new-ha.png differ diff --git a/public/docs-static/img/how-to-guides/peer-login-expiration.png b/public/docs-static/img/how-to-guides/peer-login-expiration.png index e0a4029d..0b93686b 100644 Binary files a/public/docs-static/img/how-to-guides/peer-login-expiration.png and b/public/docs-static/img/how-to-guides/peer-login-expiration.png differ diff --git a/public/docs-static/img/how-to-guides/peer-needs-login.png b/public/docs-static/img/how-to-guides/peer-needs-login.png index b3075aa6..bb4a20f1 100644 Binary files a/public/docs-static/img/how-to-guides/peer-needs-login.png and b/public/docs-static/img/how-to-guides/peer-needs-login.png differ diff --git a/public/docs-static/img/how-to-guides/user-invites.png b/public/docs-static/img/how-to-guides/user-invites.png index 4ebf6334..8daa4b2a 100644 Binary files a/public/docs-static/img/how-to-guides/user-invites.png and b/public/docs-static/img/how-to-guides/user-invites.png differ diff --git a/public/docs-static/img/how-to-guides/user-tab-list.png b/public/docs-static/img/how-to-guides/user-tab-list.png index bca590d5..e061a41d 100644 Binary files a/public/docs-static/img/how-to-guides/user-tab-list.png and b/public/docs-static/img/how-to-guides/user-tab-list.png differ diff --git a/public/docs-static/img/how-to-guides/user-update-role.png b/public/docs-static/img/how-to-guides/user-update-role.png index ad18f80f..83c83e30 100644 Binary files a/public/docs-static/img/how-to-guides/user-update-role.png and b/public/docs-static/img/how-to-guides/user-update-role.png differ diff --git a/src/pages/how-to/add-users-to-your-network.mdx b/src/pages/how-to/add-users-to-your-network.mdx index c3b39d59..96b5825f 100644 --- a/src/pages/how-to/add-users-to-your-network.mdx +++ b/src/pages/how-to/add-users-to-your-network.mdx @@ -32,8 +32,8 @@ Public domains are the ones of the public email providers like Gmail. ## Direct user invites As the name stands, this way of inviting users is straightforward and works through the web UI. -To invite a new user, proceed to the `Users` tab and click the button. -A user window will pop up where you can specify the name and email address of the invited user. Optionally, you could select a set of groups with which you want this user to be associated. +To invite a new user, proceed to `Team` then select the `Users` tab and click the button. +A window will appear, allowing you to specify the name and email address of the user you want to invite. Optionally, you could select a set of groups with which you want this user to be associated. The invited users will receive an email invitation that they have to confirm. After logging in to the system, they will join your network automatically. @@ -48,9 +48,9 @@ After logging in to the system, they will join your network automatically. ## Manage user roles -NetBird has three user roles - `Owner`, `Admin`, and `User`. The roles allow you to control the level of access to the management API of your account. +NetBird has three user roles - `Owner`, `Admin`, and `User`. The roles allow you to control the level of access to the management API of your account. -- `Owner` role - has full access to the account and can manage all aspects of the account. There can be only one account owner in NetBird. Users with the owner role can delete their organization account. See the [Delete NetBird account](/how-to/delete-account) section. +- `Owner` role - has full access to the account and can manage all aspects of the account. There can be only one account owner in NetBird. Users with the owner role can delete their organization account. See the [Delete NetBird account](/how-to/delete-account) section for more. - `Admin` role - has full access to the account except that administrators can't delete or update the role of the Owner user and delete the organization account. - `User` role - has limited access to the account, allowing users to view peers they own and others they can connect to. Users can create personal access tokens for programmatic access. diff --git a/src/pages/how-to/delete-account.mdx b/src/pages/how-to/delete-account.mdx index be693629..bf92508e 100644 --- a/src/pages/how-to/delete-account.mdx +++ b/src/pages/how-to/delete-account.mdx @@ -7,19 +7,15 @@ To delete your NetBird organization account, you must be a user with the [owner 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. - Go to your account Settings tab. -

- high-level-dia -

-Click on the Danger Zone menu. + Go to the `Settings` tab, then click on `Danger Zone`. Review the message and click on the `Delete Account` button.

high-level-dia

-Review the message and click on the Delete Account button. + To confirm, click on the `Delete` button.

high-level-dia

-To confirm, click on the Delete button. + After you delete your account, your session will end, and you will be redirected to the login page. diff --git a/src/pages/how-to/enforce-periodic-user-authentication.mdx b/src/pages/how-to/enforce-periodic-user-authentication.mdx index dbab1498..7c85d339 100644 --- a/src/pages/how-to/enforce-periodic-user-authentication.mdx +++ b/src/pages/how-to/enforce-periodic-user-authentication.mdx @@ -8,7 +8,7 @@ Every new network has this feature enabled, and the expiration period is set to This feature is only applied to peers added with the [interactive SSO login feature](/how-to/installation#running-net-bird-with-sso-login). Peers, added with a setup key, won't be affected. -Expired peers will appear in the peers' view with the status `needs login`. +Expired peers will appear in the peers' view with the status `Login required`.

peer-needs-login.png @@ -16,7 +16,7 @@ Expired peers will appear in the peers' view with the status `needs login`. ## 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. +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.

@@ -33,7 +33,7 @@ You can also disable the expiration for the whole network in the same section. 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. +Peers with `Expiration disabled` will be marked with a corresponding label in the Peers table.

peer-login-expiration diff --git a/src/pages/how-to/monitor-system-and-network-activity.mdx b/src/pages/how-to/monitor-system-and-network-activity.mdx index df95b191..0bb6c872 100644 --- a/src/pages/how-to/monitor-system-and-network-activity.mdx +++ b/src/pages/how-to/monitor-system-and-network-activity.mdx @@ -10,7 +10,7 @@ Activity monitoring is enabled by default for every network, and you can access You can also use the search bar to filter events by activity type.

- activity-monitoring + activity-monitoring

diff --git a/src/pages/how-to/routing-traffic-to-private-networks.mdx b/src/pages/how-to/routing-traffic-to-private-networks.mdx index 5f24ad00..9394404a 100644 --- a/src/pages/how-to/routing-traffic-to-private-networks.mdx +++ b/src/pages/how-to/routing-traffic-to-private-networks.mdx @@ -53,7 +53,7 @@ If you don't enable this option, you must configure a route to your NetBird netw Metric defines prioritization when choosing the main routing peer in a high availability network. Lower metrics have higher priority. ### Distribution groups -Distribution groups define that peers that belong to groups set in this field will receive the network route. +Distribution groups define that peers that belong to these groups set in this field will receive the network route. It doesn't remove the need for the routing peer to be connected to these peers @@ -78,24 +78,26 @@ In the example below, we are creating a route with the following information: - Distribution Groups: `All`

- high-level-dia + high-level-dia

-Once you fill in the route information, you can click on the `Add route` button to save your new route. + +Once you fill in the route information, you can click on the `Add Route` button to save your new route.

high-level-dia

Done! Now every peer connected to your routing peer will be able to send traffic to your external network. ### Creating a network route with routing group -You can use a peer group to automatically add any Linux peers from the groups as routing peers. To do so, follow the steps above but select the `Peer group` tab. The peer groups should have Linux peers to route traffic. -If groups have more than one peer, you get the [high availability route](#high-availability-routes) out of the box. +You can use a peer group to automatically add any Linux peers from the groups as routing peers. To do so, follow the steps above but select the `Peer group` tab. +Ensure that the peer groups have Linux peers, as traffic routing is only supported on Linux machines. +Groups with multiple peers automatically provide [high availability routing](#high-availability-routes).

- high-level-dia + high-level-dia

-Once you fill in the route information, you can click on the `Add route` button to save your new route. +Once you fill in the route information, you can click on the `Add Route` button to save your new route.

high-level-dia @@ -104,23 +106,22 @@ Once you fill in the route information, you can click on the `Add route` button Done! Now every peer connected to the peer member of the groups will be able to send traffic to your external network. ### Creating highly available routes -To avoid a single point of failure when managing your network, we recommend installing NetBird on every resource. -However, you still want to ensure a reliable connection to your private network when running NetBird on every machine is not feasible. -NetBird Network Routes feature has a High Availability (HA) mode, -allowing one or more NetBird peers to serve as routing peers for the same private network. +To avoid a single point of failure when managing your network, we recommend installing NetBird on every resource. However, when running NetBird on every machine is not feasible, you still want to ensure a reliable connection to your private network. The NetBird Network Routes feature has a High Availability (HA) mode, allowing one or more NetBird peers to serve as routing peers for the same private network. -To highly available routes you have two options: -1. Use a peer group with more than one peer in it. This is covered [above](#creating-a-network-route-with-group-routing). -2. Add more single peers to the route. +There are two options to enable HA routes: +1. Use a peer group with more than one peer in it. +2. Add more individual peers to the route. -Let's cover the second option here. +The first option is covered [above](#creating-a-network-route-with-routing-group). -To enable high-available mode, click on `Configure` in the table and select a new peer in the `Routing Peer` field, then select the distribution groups and click on `Add Route`. +To enable the high-availability mode by adding individual peers, click on `Add Peer` in the High Availability column in the Network Routes +table and select a peer in the `Routing Peer` field. Then select the `Distribution Groups` and click on `Add Route`. This +routing configuration will be distributed to machines in the selected groups `Distribution Groups`. In the following example, we are adding the peer `aws-nb-europe-router-az-b` to the `aws-eu-central-1-vpc` route:

- high-level-dia + high-level-dia

This way, peers connected to `aws-nb-europe-router-az-a` and `aws-nb-europe-router-az-b` will have highly available access to the `172.31.0.0/16` network. @@ -142,7 +143,9 @@ Peers that belong to the specified group will use the route automatically to con Remember to link groups to peers that need to access the route and, if required, add access control rules ensuring connectivity between these peers and the routing peers. -In the following example (see column `Groups`), peers that belong to group `berlin-office` will use `aws-nb-europe-router-az-a` routing peer to access the `aws-eu-central-1-vpc` network. While peers that belong to group `london-office` will use `aws-nb-europe-router-az-b` routing peer. +In the following example (see column `Distribution Groups`), peers that belong to the group `berlin-office` will use +the `aws-nb-europe-router-az-a` routing peer to access the `aws-eu-central-1-vpc` network. +While peers that belong to the `london-office` group will use the `aws-nb-europe-router-az-b` routing peer.

high-level-dia