62f89ca25d
cli: accept a user name in preauthkeys create --user
...
Resolved through lookupUser like the users commands, so scripts skip the
users list round trip. Digit-only values stay IDs.
2026-09-28 21:42:19 +02:00
906016beb4
dns: pick the extra_records_path format by file extension
...
HuJSON and YAML records work too; an unknown extension fails instead of being
parsed as JSON.
2026-09-28 21:42:19 +02:00
dd8ce695cf
derp: pick the derp.paths format by file extension
...
Adds JSON and HuJSON maps. JSON read as YAML decoded to an empty map; unknown
extensions and empty maps now fail at startup.
2026-09-28 21:42:19 +02:00
8548583f0e
docs: raise 3 docs requirement floors
2026-09-28 07:28:19 +02:00
eebeab3c1e
docs: document joining nodes with an OAuth client
...
Prefix swap, baseURL, every attribute; examples for tailscale up,
container, tsnet, GitHub Action.
2026-09-25 17:09:19 +02:00
616c9b6495
docs: warn about listen_addr / ACME port collision
...
Add a callout under the HTTP-01 docs so operators see the
constraint before they hit the validation error at startup.
Updates #3227
2026-09-23 15:18:34 +02:00
4087d1fee9
Use tmpfs for /tmp
...
This is relevant when docker is used as container runtime as it does not
set /tmp as tmpfs. With podman /tmp is mounted as tmpfs due to
`--read-only-tmpfs` (enabled by default).
Fixes : #3463
2026-09-10 14:12:53 +02:00
38722e5eeb
Document automatic exit node selection and related node attributes
...
- Add "Automatic exit node selection" to route docs
- Add suggest-exit-node and suggest-exit-node-ui as supported nodeAttrs
Fixes : #3444
2026-09-08 10:32:27 +02:00
febe3ee341
Document how to disable remote client logging on mobile
2026-09-08 10:32:27 +02:00
89fa72e08f
docs: add repository star count and activity badges to web UI list
2026-09-02 13:33:22 +02:00
cbe30304dc
docs: reword the tvOS warning to match the new step order
...
The steps now open the Tailscale app first to install the VPN
configuration, which contradicted the warning against opening the app
after installation. The actual constraint is not signing in before the
headscale URL is set.
2026-08-29 18:18:35 +02:00
fad937c062
Update AppleTV configuration steps
...
The instructions didn't work for tvOS 26.6 / Tailscale 1.102.2. When the `ALTERNATE COORDINATION SERVER URL` is set, the `Install VPN Configuration` breaks.
Clicking does nothing and the tvOS app logs showed `addUser: backendManager does not exist`.
Instead I first started tailscale and installed the vpn profile and then add the headscale url and then signed. Which seemed to have worked
2026-08-29 18:18:35 +02:00
f06ff1cf81
all: build with Go 1.27
...
Bump every remaining toolchain reference: images, goreleaser, the hi
runner fallback and docs.
2026-08-25 21:59:00 +02:00
ec0cb6f63a
docs: fix typos
2026-06-24 11:23:20 +02:00
a066a06bef
Fix invalid ip syntax
...
The "ip" field needs to be a list.
2026-06-24 08:27:33 +02:00
3c504af2be
Fix placeholder in curl example
2026-06-20 10:41:57 +02:00
7af39a6798
Add headscale-panel to webui docs
2026-06-20 10:41:57 +02:00
d7150755d4
TLS is not strictly required
2026-06-19 18:52:30 +02:00
88234d4046
Replace /swagger with /api/v1/docs
2026-06-19 18:52:30 +02:00
72adc5ff2a
docs: add changelog and refresh the API reference for the v1 API
2026-06-19 15:21:00 +02:00
6777a82ee6
Rewrite reverse proxy documentation
...
- Restructure and cleanup reverse proxy docs
- Update examples for Apache, Caddy, Nginx
- Provide some basic usage examples
2026-06-04 09:59:19 +02:00
e285f3c932
The headscale service is enabled by default
2026-05-18 17:21:58 +02:00
f3f84a5a63
Add docs for policy-wide options and node attributes
2026-05-18 17:21:58 +02:00
4eb5899154
Add taildrive, tests, sshTests as supported features
2026-05-18 17:21:58 +02:00
963daf8908
docs: document trusted_proxies config option
...
Cover the option in config-example.yaml, the reverse-proxy
integration guide, and the 0.29.0 CHANGELOG.
2026-05-18 17:17:55 +02:00
c4ab267c36
Refresh features page
2026-05-12 14:12:29 +02:00
109bfc404c
Refresh docs for Grants
...
- Mention policy as generic term that covers ACLs or Grants
- Refresh routes policy examples
- Remove Headscale specific exit node separation. Use via instead.
Fixes : #3087
2026-05-12 14:12:29 +02:00
1a64d950fd
Document supported autogroups once
2026-05-12 14:12:29 +02:00
edb7ad0f81
Rewrite ACL docs as policy
...
- Rename from acl.md to policy.md and setup redirect links
- Mention both ACLs and Grants
- Remove most old ACL docs and replace with links to Tailscale docs
- Add "Getting started" section
- Add section about notable differences
2026-05-12 14:12:29 +02:00
e13f0458bb
Remove redundant prefix
2026-05-12 14:12:29 +02:00
68b0014871
Use distroless without quotes
2026-05-12 14:12:29 +02:00
484462898b
Remove link to sqlite
...
Other mentions of SQLite don't link either.
2026-05-12 14:12:29 +02:00
45b698dbac
Shorten container introduction
2026-05-12 14:12:29 +02:00
14ce7e9106
Remove link to Arch AUR headscale-git
...
Its outdated and unmaintained.
2026-05-12 14:12:29 +02:00
84c7f0d450
Link to development builds
2026-05-12 14:12:29 +02:00
c7f221dd0a
Fix typo and wording
2026-05-12 14:12:29 +02:00
01eb5402f9
docs(setup): fix typo in requirements.md
...
Fix the typo in spelling of "Let's Encrypt".
2026-05-09 05:14:08 +02:00
e597f4c8a0
Add Headscale UI to web UI documentation
2026-05-09 05:02:44 +02:00
f1494a32ce
Update links to Tailscale documentation
2026-04-18 09:33:41 +02:00
7e6c7924ad
Document availability of autgroup:internet
2026-04-18 09:33:41 +02:00
813eb2d733
Update docs for new HA tracking
...
Also shorten the description in config-example.yaml a bit.
2026-04-17 16:59:57 +02:00
32e1d77663
Install config-example.yaml as example for the debian package
...
The directory /usr/share/doc/headscale/examples may be used to install
arbitrary example files. This is useful to get a matching configuration
for the release which gets also overwritten automatically.
2026-04-13 20:49:39 +02:00
4d0b273b90
types: add node.expiry config, deprecate oidc.expiry
...
Introduce a structured NodeConfig that replaces the flat
EphemeralNodeInactivityTimeout field with a nested Node section.
Add node.expiry config (default: no expiry) as the unified default key
expiry for all non-tagged nodes regardless of registration method.
Remove oidc.expiry entirely — node.expiry now applies to OIDC nodes
the same as all other registration methods. Using oidc.expiry in the
config is a hard error. determineNodeExpiry() returns nil (no expiry)
unless use_expiry_from_token is enabled, letting state.go apply the
node.expiry default uniformly.
The old ephemeral_node_inactivity_timeout key is preserved for
backwards compatibility.
Updates #1711
2026-04-08 13:00:22 +01:00
fda72ad1a3
Update main.md
...
Co-authored-by: nblock <nblock@users.noreply.github.com >
2026-03-31 13:36:31 +02:00
dfaf120f2a
docs: add development builds install page
...
Move the container image and binary download details from the README
into a dedicated documentation page at setup/install/main. This gives
development builds a proper home in the docs site alongside the other
install methods. The README now links to the docs page instead.
2026-03-31 13:36:31 +02:00
f3512d50df
Switch to mkdocs-materialx
...
The project mkdocs-material is in maintenance-only mode and their
successor is not ready yet.
Use the modern, refreshed theme and drop the pymdownx.magiclink
extension.
2026-03-25 22:30:03 +01:00
efd83da14e
Explicitly mention that a headscale username should *not* end with @
...
See: #3149
2026-03-20 19:44:33 +01:00
9baa795ddb
Update docs for auth-id changes
...
Build / build-nix (push) Has been cancelled
Build / build-cross (GOARCH=amd64 GOOS=darwin) (push) Has been cancelled
Build / build-cross (GOARCH=amd64 GOOS=linux) (push) Has been cancelled
Build / build-cross (GOARCH=arm64 GOOS=darwin) (push) Has been cancelled
Build / build-cross (GOARCH=arm64 GOOS=linux) (push) Has been cancelled
Check Generated Files / check-generated (push) Has been cancelled
Deploy docs / deploy (push) Has been cancelled
NixOS Module Tests / nix-module-check (push) Has been cancelled
Tests / test (push) Has been cancelled
Needs More Info - Timer / remove-label-on-response (push) Has been cancelled
Needs More Info - Timer / close-stale (push) Has been cancelled
Close inactive issues / close-issues (push) Has been cancelled
- Replace "headscale nodes register" with "headscale auth register"
- Update from registration key to Auth ID
- Fix API example to register a node
2026-03-01 13:38:22 +01:00
acddd73183
Reformat docs with mdformat
2026-03-01 09:24:52 +01:00
0f12e414a6
Explain one approach to update OIDC provider info
...
Build / build-nix (push) Has been cancelled
Build / build-cross (GOARCH=amd64 GOOS=darwin) (push) Has been cancelled
Build / build-cross (GOARCH=amd64 GOOS=linux) (push) Has been cancelled
Build / build-cross (GOARCH=arm64 GOOS=darwin) (push) Has been cancelled
Build / build-cross (GOARCH=arm64 GOOS=linux) (push) Has been cancelled
Check Generated Files / check-generated (push) Has been cancelled
NixOS Module Tests / nix-module-check (push) Has been cancelled
Tests / test (push) Has been cancelled
Deploy docs / deploy (push) Has been cancelled
See #3112
2026-02-27 10:06:50 +01:00
Kristoffer Dalby
github-actions[bot]
Kristoffer Dalby
Florian Preinstorfer
Lukas Wolfsteiner
Igor Bernstein
Baptiste Fontaine
Möhsün Babayev
MunMunMiao
Stefan Bethke