mirror of
https://github.com/juanfont/headscale.git
synced 2024-11-30 02:43:05 +00:00
Added docs
This commit is contained in:
parent
dbd14deb40
commit
000b13235b
2 changed files with 39 additions and 0 deletions
38
docs/ref/node-management.md
Normal file
38
docs/ref/node-management.md
Normal file
|
@ -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=<USER_NAME> --pre-approved
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Register a node on the headscale using preauthkey (with the pre-approval option enabled)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
headscale nodes register --user=<USER_NAME> --mkey=mkey:<MACHINE_KEY> --auth-key=<PREAUTHKEY_PRE_APPROVED>
|
||||||
|
```
|
||||||
|
|
||||||
|
### Node approval after registration without the option to pre-approve the authentication key
|
||||||
|
|
||||||
|
```bash
|
||||||
|
headscale nodes approve --identifier=<NODE_ID>
|
||||||
|
```
|
|
@ -178,6 +178,7 @@ nav:
|
||||||
- Exit node: ref/exit-node.md
|
- Exit node: ref/exit-node.md
|
||||||
- TLS: ref/tls.md
|
- TLS: ref/tls.md
|
||||||
- ACLs: ref/acls.md
|
- ACLs: ref/acls.md
|
||||||
|
- Node management: ref/node-management.md
|
||||||
- DNS: ref/dns.md
|
- DNS: ref/dns.md
|
||||||
- Remote CLI: ref/remote-cli.md
|
- Remote CLI: ref/remote-cli.md
|
||||||
- Integration:
|
- Integration:
|
||||||
|
|
Loading…
Reference in a new issue