67e0f34527
cmd/headscale: rename the database-bypass flag off gRPC
...
--bypass-grpc-and-access-database-directly is now
--bypass-server-and-access-database-directly; the gRPC server it named is
gone.
2026-06-19 05:58:10 +00:00
92048385c2
servertest: cover API error translation for missing and invalid input
...
Asserts not-found nodes/users/keys return 404 and invalid CIDR/policy
return 400. These caught the node-500 and pre-auth-key silent-success
bugs fixed alongside.
2026-06-19 05:58:10 +00:00
d955cd6262
docs: replace gRPC remote-control with HTTP API
...
The remote CLI speaks HTTP to the API URL now; drop the gRPC port,
grpc_listen_addr, and #grpc anchors.
2026-06-19 05:58:10 +00:00
08885c33da
docs: mark v1-ogen conversion complete
2026-06-19 05:57:04 +00:00
bbb171d02f
docs: reconcile v1-ogen plan with delivered state
2026-06-19 05:57:04 +00:00
29fc14dd73
cmd/headscale: run the CLI on the generated v1 HTTP client
...
Serve the API over the unix socket (auth bypassed; socket permissions are the
trust boundary) and convert every CLI command from the gRPC client to the
generated ogen client. Remote CLI now uses the HTTP API URL.
2026-06-19 05:57:04 +00:00
83fb0a4548
hscontrol/api/v1: implement node endpoints
...
Register, Get, List, Delete, Rename, Expire, SetTags, SetApprovedRoutes (with
exit-route expansion), BackfillNodeIPs, DebugCreateNode over the state layer.
Tagged nodes present as TaggedDevices; client errors map to 4xx.
2026-06-19 05:57:04 +00:00
fe76fe0f57
hscontrol/api/v1: implement user endpoints
...
CreateUser, ListUsers (with filters), RenameUser, DeleteUser over the state
layer; unknown users now 404. HTTP-parity tests via the generated client.
2026-06-19 05:57:04 +00:00
1eabd70567
docs: add v1-ogen migration plan and changelog
2026-06-19 05:57:04 +00: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
df339cd290
Add a link to Authentik's integration guide
2026-02-27 09:56:18 +01:00
a0d6802d5b
Fix minor formatting issue in FAQ
...
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
Needs More Info - Timer / remove-label-on-response (push) Has been cancelled
Needs More Info - Timer / close-stale (push) Has been cancelled
Deploy docs / deploy (push) Has been cancelled
Close inactive issues / close-issues (push) Has been cancelled
This just fixes a small issue I noticed reading the docs: the two 'scenarios' listed in the scaling section end up showing up as a numbered list of five items, instead of the desired two items + their descriptions.
2026-02-20 16:59:14 +01:00
cfb308b4a7
Add FAQ entry to migrate back to default IP prefixes
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
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
2026-02-19 17:16:40 +01:00
4bb0241257
Require to update from one version to the next
2026-02-19 17:16:40 +01:00
d556df1c36
Extend upgrade guide with backup instructions
2026-02-19 17:16:40 +01:00
faf55f5e8f
Document how to use the provider identifier in the policy
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
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
2026-02-18 10:24:05 +01:00
e3323b65e5
Describe how to set username instead of SPN for Kanidm
2026-02-18 10:24:05 +01:00
8f60b819ec
Refresh update path
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
2026-02-16 15:22:46 +01:00
c29bcd2eaf
Release planning happens in milestones
2026-02-16 15:22:46 +01:00
890a044ef6
Add more UIs
2026-02-16 15:22:46 +01:00
8028fa5483
No longer consider autogroup:self experimental
2026-02-16 15:22:46 +01:00
Kristoffer Dalby
Florian Preinstorfer
Möhsün Babayev
MunMunMiao
Stefan Bethke
Brandon Sprague