diff --git a/public/docs-static/img/architecture/netbird-peer-auto-tagging-newkey.png b/public/docs-static/img/architecture/netbird-peer-auto-tagging-newkey.png index 5be065eb..52ac13b0 100644 Binary files a/public/docs-static/img/architecture/netbird-peer-auto-tagging-newkey.png and b/public/docs-static/img/architecture/netbird-peer-auto-tagging-newkey.png differ diff --git a/public/docs-static/img/architecture/peer-auto-tagging-setupkey.gif b/public/docs-static/img/architecture/peer-auto-tagging-setupkey.gif index e9902166..9e1a2be3 100644 Binary files a/public/docs-static/img/architecture/peer-auto-tagging-setupkey.gif and b/public/docs-static/img/architecture/peer-auto-tagging-setupkey.gif differ diff --git a/public/docs-static/img/how-to-guides/add-setup-key.png b/public/docs-static/img/how-to-guides/add-setup-key.png new file mode 100644 index 00000000..8f70a6ab Binary files /dev/null and b/public/docs-static/img/how-to-guides/add-setup-key.png differ diff --git a/public/docs-static/img/how-to-guides/setup-key-created.png b/public/docs-static/img/how-to-guides/setup-key-created.png new file mode 100644 index 00000000..2fb16665 Binary files /dev/null and b/public/docs-static/img/how-to-guides/setup-key-created.png differ diff --git a/public/docs-static/img/how-to-guides/setup-keys.png b/public/docs-static/img/how-to-guides/setup-keys.png new file mode 100644 index 00000000..5fc4eebf Binary files /dev/null and b/public/docs-static/img/how-to-guides/setup-keys.png differ diff --git a/src/pages/how-to/register-machines-using-setup-keys.mdx b/src/pages/how-to/register-machines-using-setup-keys.mdx index 69d8e0a6..543090bf 100644 --- a/src/pages/how-to/register-machines-using-setup-keys.mdx +++ b/src/pages/how-to/register-machines-using-setup-keys.mdx @@ -11,33 +11,38 @@ This makes it possible to run automated deployments with infrastructure-as-code sudo netbird up --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.

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

- 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. -### 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

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

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. +## 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. + +

+ high-level-dia +

+ +After your key has been successfully created, copy and store it in a secure location. + +

+ high-level-dia +

\ No newline at end of file