Update setup keys doc
|
Before Width: | Height: | Size: 51 KiB After Width: | Height: | Size: 33 KiB |
|
Before Width: | Height: | Size: 2.0 MiB After Width: | Height: | Size: 696 KiB |
|
After Width: | Height: | Size: 84 KiB |
|
After Width: | Height: | Size: 62 KiB |
|
After Width: | Height: | Size: 57 KiB |
@@ -11,33 +11,38 @@ This makes it possible to run automated deployments with infrastructure-as-code
|
|||||||
sudo netbird up --setup-key <SETUP KEY>
|
sudo netbird up --setup-key <SETUP KEY>
|
||||||
```
|
```
|
||||||
|
|
||||||
## Types of Setup Keys
|
## Types of setup seys
|
||||||
|
|
||||||
There are 2 types of setup keys:
|
There are 2 types of setup keys:
|
||||||
* **One-off key**. This type of key can be used only once to authenticate a machine.
|
* **One-off key**. This type of key can be used only once to authenticate a machine.
|
||||||
* **Reusable key**. This type of key can be used multiple times to authenticate machines.
|
* **Reusable key**. This type of key can be used multiple times to authenticate machines.
|
||||||
|
|
||||||
## Using Setup Keys
|
## Using setup keys
|
||||||
|
|
||||||
Setup keys are available in the NetBird Management dashboard under the Setup Keys tab [https://app.netbird.io/setup-keys](https://app.netbird.io/setup-keys).
|
Setup keys are available in the NetBird Management Dashboard under the `Setup Keys` tab [https://app.netbird.io/setup-keys](https://app.netbird.io/setup-keys).
|
||||||
|
You can easily add new or revoke keys.
|
||||||
By default, we generate 2 setup keys right after account creation. You can easily add new or revoke keys.
|
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
<img src="/docs-static/img/architecture/setup-keys.png" alt="high-level-dia" className="imagewrapper"/>
|
<img src="/docs-static/img/how-to-guides/setup-keys.png" alt="high-level-dia" className="imagewrapper"/>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<Note>
|
<Note>
|
||||||
When revoking a key, all machines authenticated with this key will remain connected in the network. The same logic applies when the key expires.
|
When revoking a key, all machines authenticated with this key will remain connected to the network. The same logic applies when the key expires.
|
||||||
</Note>
|
</Note>
|
||||||
### Expiration
|
|
||||||
|
|
||||||
Setup keys are set to expire after 30 days. When expired, the setup key can't be used anymore.
|
## Expiration
|
||||||
|
|
||||||
|
You can set expiration when creating a key. When expired, the setup key can't be used anymore.
|
||||||
|
|
||||||
|
## Usage limit
|
||||||
|
|
||||||
|
By default, every reusable key has unlimited usage.
|
||||||
|
We recommend limiting the number of times the key can be used, e.g., set it to 30 if you need to enroll only 30 machines.
|
||||||
|
|
||||||
## Peer Auto-grouping
|
## Peer Auto-grouping
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
<img src="/docs-static/img/architecture/peer-auto-tagging-setupkey.gif" alt="high-level-dia" width="800" className="imagewrapper"/>
|
<img src="/docs-static/img/architecture/peer-auto-tagging-setupkey.gif" alt="high-level-dia" className="imagewrapper"/>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
NetBird offers a powerful [access control feature](/how-to/manage-network-access) that allows easy access management of your resources.
|
NetBird offers a powerful [access control feature](/how-to/manage-network-access) that allows easy access management of your resources.
|
||||||
@@ -59,3 +64,18 @@ Then use this key to enroll new machine.
|
|||||||
Auto-assign groups will apply only to newly registered machines.
|
Auto-assign groups will apply only to newly registered machines.
|
||||||
</Note>
|
</Note>
|
||||||
|
|
||||||
|
## Create setup key
|
||||||
|
|
||||||
|
Click the `Add Key` button in the `Setup Keys'.
|
||||||
|
In the opened popup, give your new key an easily identifiable name, choose type, set usage limit, and assign auto groups.
|
||||||
|
The defaults should be suitable for most of the cases. We recommend using one-off keys for security reasons.
|
||||||
|
|
||||||
|
<p>
|
||||||
|
<img src="/docs-static/img/how-to-guides/add-setup-key.png" alt="high-level-dia" className="imagewrapper"/>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
After your key has been successfully created, copy and store it in a secure location.
|
||||||
|
|
||||||
|
<p>
|
||||||
|
<img src="/docs-static/img/how-to-guides/setup-key-created.png" alt="high-level-dia" className="imagewrapper"/>
|
||||||
|
</p>
|
||||||