From 000b13235b557c375148f4ea4411b81381792928 Mon Sep 17 00:00:00 2001 From: hopleus Date: Mon, 28 Oct 2024 13:13:31 +0300 Subject: [PATCH] Added docs --- docs/ref/node-management.md | 38 +++++++++++++++++++++++++++++++++++++ mkdocs.yml | 1 + 2 files changed, 39 insertions(+) create mode 100644 docs/ref/node-management.md diff --git a/docs/ref/node-management.md b/docs/ref/node-management.md new file mode 100644 index 00000000..620d25a2 --- /dev/null +++ b/docs/ref/node-management.md @@ -0,0 +1,38 @@ +# Node management + +See https://tailscale.com/kb/1099/device-approval for more information. + +## Setup + +### 1. Change the configuration + +1. Change the `config.yaml` to contain the desired records like so: + + ```yaml + node_management: + manual_approve_new_node: true + ``` + +2. Restart your headscale instance. + +## Usage + +### Pre-approve a node using preauthkeys + +1. Create preauthkey with a pre-approve option + +```bash +headscale preauthkeys create --user= --pre-approved +``` + +2. Register a node on the headscale using preauthkey (with the pre-approval option enabled) + +```bash +headscale nodes register --user= --mkey=mkey: --auth-key= +``` + +### Node approval after registration without the option to pre-approve the authentication key + +```bash +headscale nodes approve --identifier= +``` \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index d01c94cc..84415c75 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -178,6 +178,7 @@ nav: - Exit node: ref/exit-node.md - TLS: ref/tls.md - ACLs: ref/acls.md + - Node management: ref/node-management.md - DNS: ref/dns.md - Remote CLI: ref/remote-cli.md - Integration: