docs: note the posture attributes endpoint and its proxy setting

trusted_proxies now feeds a stored, API-visible address, not only logs.

Updates #2272
This commit is contained in:
Kristoffer Dalby committed 2026-11-05 12:38:53 +01:00
1 parent a8c135dc20
commit 459b157c3b
4 files changed
+6 -4

No files matched your search

+1
View File
@@ -193,6 +193,7 @@ the ACME DNS-01 challenge through a built-in DNS provider: `acmedns`,
- Policy `tests` reject `autogroup:member` as a source. [#3649](https://github.com/juanfont/headscale/pull/3649) - Policy `tests` reject `autogroup:member` as a source. [#3649](https://github.com/juanfont/headscale/pull/3649)
- Document `ssh-behavior-v1`. Headscale does not set it. [#3649](https://github.com/juanfont/headscale/pull/3649) - Document `ssh-behavior-v1`. Headscale does not set it. [#3649](https://github.com/juanfont/headscale/pull/3649)
- The v2 API sorts device lists by name. Devices report `connectedToControl`, `lastSeen` and `blocksIncomingConnections`. `fields=all` adds `sshEnabled`, `distro` and `clientConnectivity`. Add `POST /device/{id}/expire`. Settings report `routeSelection`. Errors use Tailscale's text and content types. A JSON policy read returns valid JSON. [#3649](https://github.com/juanfont/headscale/pull/3649) - The v2 API sorts device lists by name. Devices report `connectedToControl`, `lastSeen` and `blocksIncomingConnections`. `fields=all` adds `sshEnabled`, `distro` and `clientConnectivity`. Add `POST /device/{id}/expire`. Settings report `routeSelection`. Errors use Tailscale's text and content types. A JSON policy read returns valid JSON. [#3649](https://github.com/juanfont/headscale/pull/3649)
- The v2 API adds `GET /device/{id}/attributes`, scoped `devices:posture_attributes:read`. It reports `ip:publicAddress`: the source IP of the node's latest control connection, stored on the node. Behind a reverse proxy, set `trusted_proxies` or it reports the proxy. [#3419](https://github.com/juanfont/headscale/pull/3419)
- PostgreSQL connection settings are assembled into a `postgres://` URL with proper escaping, so a password (or host, user, database name) containing spaces, quotes or other reserved characters no longer truncates the DSN [#3477](https://github.com/juanfont/headscale/pull/3477) - PostgreSQL connection settings are assembled into a `postgres://` URL with proper escaping, so a password (or host, user, database name) containing spaces, quotes or other reserved characters no longer truncates the DSN [#3477](https://github.com/juanfont/headscale/pull/3477)
- Expiring or deleting a non-existent pre-auth key now returns an error instead of silently succeeding [#3324](https://github.com/juanfont/headscale/pull/3324) - Expiring or deleting a non-existent pre-auth key now returns an error instead of silently succeeding [#3324](https://github.com/juanfont/headscale/pull/3324)
- Improve systemd service file hardening [#3341](https://github.com/juanfont/headscale/pull/3341) - Improve systemd service file hardening [#3341](https://github.com/juanfont/headscale/pull/3341)
+1 -1
View File
@@ -23,7 +23,7 @@ func init() {
oauthClientsCmd.AddCommand(listOAuthClientsCmd) oauthClientsCmd.AddCommand(listOAuthClientsCmd)
createOAuthClientCmd.Flags(). createOAuthClientCmd.Flags().
StringArrayP("scope", "s", nil, "Scope the client's tokens are granted (repeatable): auth_keys, oauth_keys, devices:core, devices:routes, policy_file, feature_settings, users (each with a :read variant), or all/all:read") StringArrayP("scope", "s", nil, "Scope the client's tokens are granted (repeatable): auth_keys, oauth_keys, devices:core, devices:routes, devices:posture_attributes, policy_file, feature_settings, users (each with a :read variant), or all/all:read")
createOAuthClientCmd.Flags(). createOAuthClientCmd.Flags().
StringArrayP("tag", "t", nil, "Tag the client's tokens may assign to devices (repeatable), e.g. tag:k8s-operator") StringArrayP("tag", "t", nil, "Tag the client's tokens may assign to devices (repeatable), e.g. tag:k8s-operator")
createOAuthClientCmd.Flags().StringP("description", "d", "", "Human-readable description") createOAuthClientCmd.Flags().StringP("description", "d", "", "Human-readable description")
+2 -2
View File
@@ -26,8 +26,8 @@ metrics_listen_addr: 127.0.0.1:9090
# CIDR(s) of reverse proxies (e.g. 127.0.0.1/32) whose # CIDR(s) of reverse proxies (e.g. 127.0.0.1/32) whose
# True-Client-IP, X-Real-IP and X-Forwarded-For headers should # True-Client-IP, X-Real-IP and X-Forwarded-For headers should
# be honoured. Empty (default) ignores those headers; setting # be honoured. Empty (default) ignores those headers; setting
# this without a proxy in front lets clients spoof their logged # this without a proxy in front lets clients spoof their source
# source IP. # IP in logs and in the v2 API's ip:publicAddress.
trusted_proxies: [] trusted_proxies: []
# The Noise section includes specific configuration for the # The Noise section includes specific configuration for the
+2 -1
View File
@@ -50,7 +50,8 @@ and indicates that the reverse proxy is in charge of terminating TLS.
Headscale ignores `True-Client-IP`, `X-Real-IP` and `X-Forwarded-For` headers unless the request's TCP peer matches the Headscale ignores `True-Client-IP`, `X-Real-IP` and `X-Forwarded-For` headers unless the request's TCP peer matches the
`trusted_proxies` configuration option. Set this to the CIDR(s) your reverse proxy connects from so the real client IP `trusted_proxies` configuration option. Set this to the CIDR(s) your reverse proxy connects from so the real client IP
appears in access logs. appears in access logs and in the v2 API's `ip:publicAddress` device attribute. Without it, every node reports the
proxy's address.
```yaml title="config.yaml" ```yaml title="config.yaml"
trusted_proxies: trusted_proxies: