Peers docs reworked 2
|
Before Width: | Height: | Size: 110 KiB After Width: | Height: | Size: 164 KiB |
|
Before Width: | Height: | Size: 34 KiB After Width: | Height: | Size: 486 KiB |
|
Before Width: | Height: | Size: 44 KiB After Width: | Height: | Size: 486 KiB |
|
Before Width: | Height: | Size: 132 KiB After Width: | Height: | Size: 230 KiB |
|
Before Width: | Height: | Size: 54 KiB After Width: | Height: | Size: 68 KiB |
|
Before Width: | Height: | Size: 68 KiB After Width: | Height: | Size: 40 KiB |
|
Before Width: | Height: | Size: 73 KiB After Width: | Height: | Size: 109 KiB |
|
Before Width: | Height: | Size: 64 KiB After Width: | Height: | Size: 124 KiB |
BIN
public/docs-static/img/overview/disable-rule.png
Normal file
|
After Width: | Height: | Size: 33 KiB |
|
Before Width: | Height: | Size: 123 KiB After Width: | Height: | Size: 190 KiB |
@@ -1,5 +1,5 @@
|
||||
|
||||
# Add machines to your NetBird network
|
||||
# Add peers to your NetBird network
|
||||
|
||||
Whether you have a network for personal use or manage your company's corporate network, you'd probably want to add machines
|
||||
(or peers in NetBird's terms) to your network.
|
||||
@@ -11,8 +11,8 @@ an Android or iOS device, a personal laptop, a single-board computer like Raspbe
|
||||
## Use NetBird web UI to add new peers
|
||||
|
||||
To add a new peer to your network follow these steps:
|
||||
1. Sign-in you NetBird account at https://app.netbird.io/ and go to the Peers tab.
|
||||
2. Hit `Add new peer` button
|
||||
1. Sign-in to your NetBird account at https://app.netbird.io/ and go to the Peers tab.
|
||||
2. Hit `Add Peer` button
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/how-to-guides/add-new-peer-empty.png" alt="high-level-dia" className="imagewrapper"/>
|
||||
|
||||
@@ -19,11 +19,11 @@ To enable peer approval, navigate to [Settings » Authentication](https://a
|
||||
</p>
|
||||
|
||||
<Note>
|
||||
When disabling peer approval, all pending approval requests will be automatically approved.
|
||||
When disabling the peer approval, all pending approval requests will automatically be 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.
|
||||
To approve a peer, navigate to the [peers tab](https://app.netbird.io/peers) and click the `Approve` button on the right side of the peers table.
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/how-to-guides/peer-needs-approval.png" alt="peer-needs-approval" className="imagewrapper"/>
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
NetBird enables administrators to oversee and manage access between resources (peers) through access policies. These policies specify which peers and peer groups are permitted to connect to each other, detail the protocols and ports for these connections, and offer the option to include posture checks to apply zero trust principles, helping to adapt access control to specific contexts.
|
||||
|
||||
## Introduction
|
||||
Intitially, a NetBird account is configured with a `Default` policy which allows peers to connect via any protocol, resulting in the formation of a full mesh network. This setup often suits small networks or those requiring minimal security. In scenarios where higher security is needed or access to specific resources must be restricted for certain users or services, policies can be set up to determine access permissions.
|
||||
Initially, a NetBird account is configured with a `Default` policy which allows peers to connect via any protocol, resulting in the formation of a full mesh network. This setup often suits small networks or those requiring minimal security. In scenarios where higher security is needed or access to specific resources must be restricted for certain users or services, policies can be set up to determine access permissions.
|
||||
|
||||
|
||||
|
||||
@@ -82,7 +82,7 @@ Protocol type All or ICMP must be bi-directional. Also unidirectional traffic fo
|
||||
|
||||
### Adding peers to groups
|
||||
If you create a new group when defining a policy, you will need to add a peer to the group for the policy to take effect.
|
||||
You can do it by accessing the `Peers` tab and clicking the `Groups` column of any peer you want to associate with the new group.
|
||||
You can assign a peer to a group by accessing the `Peer` section. Then, choose the specific peer you want to assign to a group. Click on the `Assigned Groups` select box and select the group(s) you wish to assign to this peer.
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/overview/associate-peer-groups.png" alt="high-level-dia" className="imagewrapper"/>
|
||||
@@ -93,15 +93,17 @@ You can do it by accessing the `Peers` tab and clicking the `Groups` column of a
|
||||
</Note>
|
||||
|
||||
### Updating Policies
|
||||
To update a policy, you can click on the policy's Name` or on either `Sources` and `Destinations` columns. You could also click the menu
|
||||
button of a policy and select `View`. This will open the same screen where you can update policy groups, description, and status or change allowed
|
||||
traffic direction and protocols with ports.
|
||||
|
||||
To update a policy, just click on its Name and customize it according to your requirements. This action will open the same screen where you can update policy groups, descriptions, and status, or modify allowed traffic direction, protocols with ports, and posture checks, similar to the information described in the "Creating Policies" section above.
|
||||
|
||||
### Disabling Policies
|
||||
To disable a policy, use the switch in the `Enabled` column of the table.
|
||||
To disable a policy, use the switch in the `Active` column of the table.
|
||||
<p>
|
||||
<img src="/docs-static/img/overview/disable-rule.png" alt="high-level-dia" className="imagewrapper"/>
|
||||
</p>
|
||||
|
||||
### Deleting Policies
|
||||
To delete a policy, click `Delete` in the table. A confirmation window will pop up.
|
||||
To delete a policy, click on `Delete` in the table, and confirm the message that appears.
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/overview/delete-rule-menu.png" alt="high-level-dia" className="imagewrapper"/>
|
||||
|
||||