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

Update setup keys doc

Browse Source
This commit is contained in:
braginini
2023-07-01 16:26:08 +02:00
parent 717d1a69f6
commit 5ceb5959ab
6 changed files with 30 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
src/pages/how-to/register-machines-using-setup-keys.mdx
View File

@@ -11,33 +11,38 @@ This makes it possible to run automated deployments with infrastructure-as-code
sudo netbird up --setup-key <SETUP KEY>
```
## Types of Setup Keys
## Types of setup seys
There are 2 types of setup keys:
* **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.
## 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).
By default, we generate 2 setup keys right after account creation. You can easily add new or revoke 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.
<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>
<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>
### 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
<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>
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.
</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>