docs: document updating clients remotely

This commit is contained in:
Martín Gómez authored and Kristoffer Dalby committed 2026-11-05 15:51:04 +01:00
1 parent 215844e5b7
commit f203c003eb
3 files changed
+28

No files matched your search

+9
View File
@@ -84,6 +84,15 @@ clients, and how to run the same setup without Nix.
the ACME DNS-01 challenge through a built-in DNS provider: `acmedns`,
`cloudflare`, `gigahost`, `hetzner`, `powerdns` or `rfc2136`. `dns.base_domain` must be a public domain you control. [#3554](https://github.com/juanfont/headscale/pull/3554)
### Update clients remotely
`headscale nodes update-client` and `POST /api/v2/device/{id}/update-client` ask a
connected node to update its Tailscale client, like the "Start update" button of
the Tailscale admin console. The request is sent over c2n, and the node only
starts the update if it has auto-updates enabled and its platform supports them;
otherwise its reason is reported back. `--force` updates even with active
Tailscale SSH sessions. See [the client docs](https://headscale.net/stable/about/clients/#update-clients).
### BREAKING
#### Database
+18
View File
@@ -14,3 +14,21 @@ headscale.
| macOS | Yes (see [docs](../usage/connect/apple.md#macos) and `/apple` on your headscale for more information) |
| iOS | Yes (see [docs](../usage/connect/apple.md#ios) and `/apple` on your headscale for more information) |
| tvOS | Yes (see [docs](../usage/connect/apple.md#tvos) and `/apple` on your headscale for more information) |
## Update clients
Tailscale clients can update themselves. Set `auto_update.enabled: true` in the configuration file to turn auto-updates
on by default for nodes that have not made a local choice with `tailscale set --auto-update`.
A connected node can also be asked to update right away:
```console
headscale nodes update-client --identifier <NODE_ID>
```
The node only starts the update if auto-updates are enabled on it and its platform supports them. Otherwise the command
reports why the node refused. A node with active Tailscale SSH sessions refuses as well, unless `--force` is given. The
command returns once the update has started; the node reconnects with the new version when it is done.
The same request is available in the API as `POST /api/v2/device/<NODE_ID>/update-client` with an optional
`{"force": true}` body. It needs an API key or an OAuth token with the `devices:core` scope.
+1
View File
@@ -23,6 +23,7 @@ provides on overview of Headscale's feature and compatibility with the Tailscale
- [x] [Route filtering with Via](https://tailscale.com/docs/features/access-control/grants/grants-via)
- [x] Dual stack (IPv4 and IPv6)
- [x] Ephemeral nodes
- [x] [Client updates](clients.md#update-clients)
- [x] Embedded [DERP server](../ref/derp.md)
- [x] [Peer relays](https://tailscale.com/docs/features/peer-relay)
- [x] [Policy](../ref/policy.md) ([GitHub label "policy"](https://github.com/juanfont/headscale/labels/policy%20%F0%9F%93%9D))