v0.25.0-beta.1

Help beta testing:

We would like to encourage users, and especially companies/organisations using headscale to join testing of every release.
Headscale is open source and it is maintained by a small group of volunteers. We need your help to ensure that the software is stable and secure.
The previous release had some issues that was only found after release, we would like to avoid that in the future. This could have been avoided if
companies and organisations had helped tested the release before it was released.

This release improves and fixes some long standing bugs in the authentication flow, we need help testing this release to ensure new bugs are not introduced.
The interesting things would be to test the following:

• Logging in and out with the same user (with all auth methods)
• Changing user with the same node

BREAKING

• Authentication flow has been rewritten
  #2374 This change should be
  transparent to users with the exception of some buxfixes that has been
  discovered and was fixed as part of the rewrite.
  • When a node is registered with a new user, it will be registered as a new
    node (#2327 and
    #1310).
  • A logged out node logging in with the same user will replace the existing
    node.
• Remove support for Tailscale clients older than 1.62 (Capability version 87)
  #2405

Changes

• oidc.map_legacy_users is now false by default
  #2350
• Print Tailscale version instead of capability versions for outdated nodes
  #2391
• Do not allow renaming of users from OIDC
  #2393
• Change minimum hostname length to 2
  #2393
• Pre auth keys belonging to a user are no longer deleted with the user
  #2396
• Pre auth keys that are used by a node can no longer be deleted
  #2396
• Rehaul HTTP errors, return better status code and errors to users
  #2398

Changelog

• 8c09afe Headscale implements a single tailnet
• f12cb2e Headscale now updates the user profile
• 8076c94 Release docs 0.24 (#2349)
• f44b1d3 Remove routes without a node_id (#2386)
• 45752db Return better web errors to the user (#2398)
• d57a55c Rewrite authentication flow (#2374)
• 8b92c01 add 1.80 to capver and update deps (#2394)
• cd3b8e6 clean up handler methods, common logging (#2384)
• 2c279e0 create and rename usernames validated by new func (#2381)
• 9bd1438 do not allow preauth keys to be deleted if assigned to node (#2396)
• 9ae3570 drop versions older than 1.62 (#2405)
• d1dbe4e fix panic if derp update is 0 (#2368)
• 9e3f945 fix postgres migration issue with 0.24 (#2367)
• aa76980 flake.lock: Update (#2353)
• 97e5d95 flake.lock: Update (#2378)
• 9a7890d flake.lock: Update (#2402)
• e172c29 initial capver packet tracking version (#2391)
• 615ee5d make it harder to insert invalid routes (#2371)
• 1c7f3bc no edit of oidc users, minimum hostname length (#2393)
• c1f42cd relax user validation to allow emails, add tests from various oidc providers (#2364)
• 5b986ed set oidc.map_legacy_users false (#2350)
• 7ba6ad3 simplify findUserByToken in ACL, add missing testcases (#2388)
• 4c8e847 use dedicated registration ID for auth flow (#2337)

v0.24.2

Changes

• Fix issue where email and username being equal fails to match in Policy
  #2388
• Delete invalid routes before adding a NOT NULL constraint on node_id
  #2386

Changelog

• 341a3d3 Remove routes without a node_id (#2386)
• 46b8226 simplify findUserByToken in ACL, add missing testcases (#2388)

v0.24.1

Changes

• Fix migration issue with user table for PostgreSQL
  #2367
• Relax username validation to allow emails
  #2364
• Remove invalid routes and add stronger constraints for routes to avoid API panic
  #2371
• Fix panic when derp.update_frequency is 0
  #2368

Changelog

• 6cd8d99 fix panic if derp update is 0 (#2368)
• 84431f2 fix postgres migration issue with 0.24 (#2367)
• 5164b27 make it harder to insert invalid routes (#2371)
• 479f799 relax user validation to allow emails, add tests from various oidc providers (#2364)
• f22a48b set date for 0.24.1 release

v0.24.0

Security fix: OIDC changes in Headscale 0.24.0

The following issue only affects Headscale installations which authenticate
with OIDC.

Headscale v0.23.0 and earlier identified OIDC users by the "username" part of
their email address (when strip_email_domain: true, the default) or whole
email address (when strip_email_domain: false).

Depending on how Headscale and your Identity Provider (IdP) were configured,
only using the email claim could allow a malicious user with an IdP account to
take over another Headscale user's account, even when
strip_email_domain: false.

This would also cause a user to lose access to their Headscale account if they
changed their email address.

Headscale v0.24.0 now identifies OIDC users by the iss and sub claims.
These are guaranteed by the OIDC specification to be stable and unique,
even if a user changes email address. A well-designed IdP will typically set
sub to an opaque identifier like a UUID or numeric ID, which has no relation
to the user's name or email address.

Headscale v0.24.0 and later will also automatically update profile fields with
OIDC data on login. This means that users can change those details in your IdP,
and have it populate to Headscale automatically the next time they log in.
However, this may affect the way you reference users in policies.

Headscale v0.23.0 and earlier never recorded the iss and sub fields, so all
legacy (existing) OIDC accounts need to be migrated to be properly
secured.

What do I need to do to migrate?

Headscale v0.24.0 has an automatic migration feature, which is enabled by
default (map_legacy_users: true). This will be disabled by default in a
future version of Headscale – any unmigrated users will get new accounts.

The migration will mostly be done automatically, with one exception. If your
OIDC does not provide an email_verified claim, Headscale will ignore the
email. This means that either the administrator will have to mark the user
emails as verified, or ensure the users verify their emails. Any unverified
emails will be ignored, meaning that the users will get new accounts instead
of being migrated.

After this exception is ensured, make all users log into Headscale with their
account, and Headscale will automatically update the account record. This will
be transparent to the users.

When all users have logged in, you can disable the automatic migration by
setting map_legacy_users: false in your configuration file.

Please note that map_legacy_users will be set to false by default in v0.25.0
and the migration mechanism will be removed in v0.26.0.

What does automatic migration do?

What does automatic migration do?

When automatic migration is enabled (map_legacy_users: true), Headscale will
first match an OIDC account to a Headscale account by iss and sub, and then
fall back to matching OIDC users similarly to how Headscale v0.23.0 did:

• If strip_email_domain: true (the default): the Headscale username matches
  the "username" part of their email address.
• If strip_email_domain: false: the Headscale username matches the whole
  email address.

On migration, Headscale will change the account's username to their
preferred_username. This could break any ACLs or policies which are
configured to match by username.

Like with Headscale v0.23.0 and earlier, this migration only works for users who
haven't changed their email address since their last Headscale login.

A successful automated migration should otherwise be transparent to users.

Once a Headscale account has been migrated, it will be unavailable to be
matched by the legacy process. An OIDC login with a matching username, but
non-matching iss and sub will instead get a new Headscale account.

Because of the way OIDC works, Headscale's automated migration process can
only work when a user tries to log in after the update.

Legacy account migration should have no effect on new installations where all
users have a recorded sub and iss.

What happens when automatic migration is disabled?

What happens when automatic migration is disabled?

When automatic migration is disabled (map_legacy_users: false), Headscale will
only try to match an OIDC account to a Headscale account by iss and sub.

If there is no match, it will get a new Headscale account – even if there was
a legacy account which could have matched and migrated.

We recommend new Headscale users explicitly disable automatic migration – but it
should otherwise have no effect if every account has a recorded iss and sub.

When automatic migration is disabled, the strip_email_domain setting will have
no effect.

Special thanks to @micolous for reviewing, proposing and working with us on
these changes.

Other OIDC changes

Headscale now uses
the standard OIDC claims
to populate and update user information every time they log in:

Headscale profile field	OIDC claim	Notes / examples
email address	email	Only used when "email_verified": true
display name	name	eg: Sam Smith
username	preferred_username	Varies depending on IdP and configuration, eg: ssmith, [email protected], \\example.com\ssmith
profile picture	picture	URL to a profile picture or avatar

These should show up nicely in the Tailscale client.

This will also affect the way you
reference users in policies.

BREAKING

• Remove dns.use_username_in_magic_dns configuration option
  #2020,
  #2279
  • Having usernames in magic DNS is no longer possible.
• Remove versions older than 1.56
  #2149
  • Clean up old code required by old versions
• User gRPC/API #2261:
  • If you depend on a Headscale Web UI, you should wait with this update until
    the UI have been updated to match the new API.
  • GET /api/v1/user/{name} and GetUser have been removed in favour of ListUsers with an ID parameter
  • RenameUser and DeleteUser now require an ID instead of a name.

Changes

• Improved compatibility of built-in DERP server with clients connecting over
  WebSocket #2132
• Allow nodes to use SSH agent forwarding
  #2145
• Fixed processing of fields in post request in MoveNode rpc
  #2179
• Added conversion of 'Hostname' to 'givenName' in a node with FQDN rules
  applied #2198
• Fixed updating of hostname and givenName when it is updated in HostInfo
  #2199
• Fixed missing stable-debug container tag
  #2232
• Loosened up server_url and base_domain check. It was overly strict in some
  cases. #2248
• CLI for managing users now accepts --identifier in addition to --name,
  usage of --identifier is recommended
  #2261
• Add dns.extra_records_path configuration option #2262
• Support client verify for DERP #2046
• Add PKCE Verifier for OIDC #2314

Changelog

• ede4f97 Fix typos
• fa641e3 Set CSRF cookies for OIDC (#2328)
• 1ab7b31 Update apple.md for latest version of iOS (#2321)
• 38aef77 allow @ and Log if OIDC username is not consider valid (#2340)
• b81420b feat: Add PKCE Verifier for OIDC (#2314)
• caad5c6 fix nil pointer deref (#2339)
• 9313e5b flake.lock: Update (#2313)
• f9bbfa5 flake.lock: Update (#2320)
• 41bad2b flake.lock: Update (#2324)
• 610597b flake.lock: Update (#2342)
• e88406e set changelog date (#2347)
• e4a3dcc use headscale server url as domain instead of base_domain (#2338)

v0.24.0-beta.2

Security fix: OIDC changes in Headscale 0.24.0

The following issue only affects Headscale installations which authenticate
with OIDC.

Headscale v0.23.0 and earlier identified OIDC users by the "username" part of
their email address (when strip_email_domain: true, the default) or whole
email address (when strip_email_domain: false).

Depending on how Headscale and your Identity Provider (IdP) were configured,
only using the email claim could allow a malicious user with an IdP account to
take over another Headscale user's account, even when
strip_email_domain: false.

This would also cause a user to lose access to their Headscale account if they
changed their email address.

Headscale v0.24.0 now identifies OIDC users by the iss and sub claims.
These are guaranteed by the OIDC specification to be stable and unique,
even if a user changes email address. A well-designed IdP will typically set
sub to an opaque identifier like a UUID or numeric ID, which has no relation
to the user's name or email address.

Headscale v0.24.0 and later will also automatically update profile fields with
OIDC data on login. This means that users can change those details in your IdP,
and have it populate to Headscale automatically the next time they log in.
However, this may affect the way you reference users in policies.

Headscale v0.23.0 and earlier never recorded the iss and sub fields, so all
legacy (existing) OIDC accounts need to be migrated to be properly
secured.

What do I need to do to migrate?

Headscale v0.24.0 has an automatic migration feature, which is enabled by
default (map_legacy_users: true). This will be disabled by default in a
future version of Headscale – any unmigrated users will get new accounts.

The migration will mostly be done automatically, with one exception. If your
OIDC does not provide an email_verified claim, Headscale will ignore the
email. This means that either the administrator will have to mark the user
emails as verified, or ensure the users verify their emails. Any unverified
emails will be ignored, meaning that the users will get new accounts instead
of being migrated.

After this exception is ensured, make all users log into Headscale with their
account, and Headscale will automatically update the account record. This will
be transparent to the users.

When all users have logged in, you can disable the automatic migration by
setting map_legacy_users: false in your configuration file.

Please note that map_legacy_users will be set to false by default in v0.25.0
and the migration mechanism will be removed in v0.26.0.

What does automatic migration do?

What does automatic migration do?

When automatic migration is enabled (map_legacy_users: true), Headscale will
first match an OIDC account to a Headscale account by iss and sub, and then
fall back to matching OIDC users similarly to how Headscale v0.23.0 did:

• If strip_email_domain: true (the default): the Headscale username matches
  the "username" part of their email address.
• If strip_email_domain: false: the Headscale username matches the whole
  email address.

On migration, Headscale will change the account's username to their
preferred_username. This could break any ACLs or policies which are
configured to match by username.

Like with Headscale v0.23.0 and earlier, this migration only works for users who
haven't changed their email address since their last Headscale login.

A successful automated migration should otherwise be transparent to users.

Once a Headscale account has been migrated, it will be unavailable to be
matched by the legacy process. An OIDC login with a matching username, but
non-matching iss and sub will instead get a new Headscale account.

Because of the way OIDC works, Headscale's automated migration process can
only work when a user tries to log in after the update.

Legacy account migration should have no effect on new installations where all
users have a recorded sub and iss.

What happens when automatic migration is disabled?

What happens when automatic migration is disabled?

When automatic migration is disabled (map_legacy_users: false), Headscale will
only try to match an OIDC account to a Headscale account by iss and sub.

If there is no match, it will get a new Headscale account – even if there was
a legacy account which could have matched and migrated.

We recommend new Headscale users explicitly disable automatic migration – but it
should otherwise have no effect if every account has a recorded iss and sub.

When automatic migration is disabled, the strip_email_domain setting will have
no effect.

Special thanks to @micolous for reviewing, proposing and working with us on
these changes.

Other OIDC changes

Headscale now uses
the standard OIDC claims
to populate and update user information every time they log in:

Headscale profile field	OIDC claim	Notes / examples
email address	email	Only used when "email_verified": true
display name	name	eg: Sam Smith
username	preferred_username	Varies depending on IdP and configuration, eg: ssmith, [email protected], \\example.com\ssmith
profile picture	picture	URL to a profile picture or avatar

These should show up nicely in the Tailscale client.

This will also affect the way you
reference users in policies.

BREAKING

• Remove dns.use_username_in_magic_dns configuration option
  #2020,
  #2279
  • Having usernames in magic DNS is no longer possible.
• Remove versions older than 1.56
  #2149
  • Clean up old code required by old versions
• User gRPC/API #2261:
  • If you depend on a Headscale Web UI, you should wait with this update until
    the UI have been updated to match the new API.
  • GET /api/v1/user/{name} and GetUser have been removed in favour of ListUsers with an ID parameter
  • RenameUser and DeleteUser now require an ID instead of a name.

Changes

• Improved compatibilty of built-in DERP server with clients connecting over
  WebSocket #2132
• Allow nodes to use SSH agent forwarding
  #2145
• Fixed processing of fields in post request in MoveNode rpc
  #2179
• Added conversion of 'Hostname' to 'givenName' in a node with FQDN rules
  applied #2198
• Fixed updating of hostname and givenName when it is updated in HostInfo
  #2199
• Fixed missing stable-debug container tag
  #2232
• Loosened up server_url and base_domain check. It was overly strict in some
  cases. #2248
• CLI for managing users now accepts --identifier in addition to --name,
  usage of --identifier is recommended
  #2261
• Add dns.extra_records_path configuration option #2262
• Support client verify for DERP #2046

Changelog

• e270169 Add -race Flag to GitHub Action and Fix Data Race in CreateTailscaleNodesInUser (#2038)
• 47b405d Changelog: support client verify for DERP
• 7d937c6 Correct macOS GUI connect guide because there's no ALT key on a mac (#2306)
• 3269cfd Mention reload and SIGHUP when editing the ACL policy file
• 0acb2b5 Misc doc updates
• 65304a0 Remove sealos documentation
• bbc93a9 Set title for code listings
• 319ce67 Update DNS documentation for dns.extra_records_path
• af4508b bump deps (#2308)
• 5345f19 fix issue where some oidc claim bools are sent as string (#2297)
• ec8729b fix sighup issue with empty acl (#2296)
• 770f3dc fix tags not resolving to username if email is present (#2309)
• ccc895b fixes to extra-record file watcher (#2298)
• e00b9d9 flake.lock: Update (#2294)

v0.24.0-beta.1

Security fix: OIDC changes in Headscale 0.24.0

The following issue only affects Headscale installations which authenticate
with OIDC.

Headscale v0.23.0 and earlier identified OIDC users by the "username" part of
their email address (when strip_email_domain: true, the default) or whole
email address (when strip_email_domain: false).

Depending on how Headscale and your Identity Provider (IdP) were configured,
only using the email claim could allow a malicious user with an IdP account to
take over another Headscale user's account, even when
strip_email_domain: false.

This would also cause a user to lose access to their Headscale account if they
changed their email address.

Headscale v0.24.0 now identifies OIDC users by the iss and sub claims.
These are guaranteed by the OIDC specification to be stable and unique,
even if a user changes email address. A well-designed IdP will typically set
sub to an opaque identifier like a UUID or numeric ID, which has no relation
to the user's name or email address.

Headscale v0.24.0 and later will also automatically update profile fields with
OIDC data on login. This means that users can change those details in your IdP,
and have it populate to Headscale automatically the next time they log in.
However, this may affect the way you reference users in policies.

Headscale v0.23.0 and earlier never recorded the iss and sub fields, so all
legacy (existing) OIDC accounts need to be migrated to be properly
secured.

What do I need to do to migrate?

Headscale v0.24.0 has an automatic migration feature, which is enabled by
default (map_legacy_users: true). This will be disabled by default in a
future version of Headscale – any unmigrated users will get new accounts.

The migration will mostly be done automatically, with one exception. If your
OIDC does not provide an email_verified claim, Headscale will ignore the
email. This means that either the administrator will have to mark the user
emails as verified, or ensure the users verify their emails. Any unverified
emails will be ignored, meaning that the users will get new accounts instead
of being migrated.

After this exception is ensured, make all users log into Headscale with their
account, and Headscale will automatically update the account record. This will
be transparent to the users.

When all users have logged in, you can disable the automatic migration by
setting map_legacy_users: false in your configuration file.

Please note that map_legacy_users will be set to false by default in v0.25.0
and the migration mechanism will be removed in v0.26.0.

What does automatic migration do?

What does automatic migration do?

When automatic migration is enabled (map_legacy_users: true), Headscale will
first match an OIDC account to a Headscale account by iss and sub, and then
fall back to matching OIDC users similarly to how Headscale v0.23.0 did:

• If strip_email_domain: true (the default): the Headscale username matches
  the "username" part of their email address.
• If strip_email_domain: false: the Headscale username matches the whole
  email address.

On migration, Headscale will change the account's username to their
preferred_username. This could break any ACLs or policies which are
configured to match by username.

Like with Headscale v0.23.0 and earlier, this migration only works for users who
haven't changed their email address since their last Headscale login.

A successful automated migration should otherwise be transparent to users.

Once a Headscale account has been migrated, it will be unavailable to be
matched by the legacy process. An OIDC login with a matching username, but
non-matching iss and sub will instead get a new Headscale account.

Because of the way OIDC works, Headscale's automated migration process can
only work when a user tries to log in after the update.

Legacy account migration should have no effect on new installations where all
users have a recorded sub and iss.

What happens when automatic migration is disabled?

What happens when automatic migration is disabled?

When automatic migration is disabled (map_legacy_users: false), Headscale will
only try to match an OIDC account to a Headscale account by iss and sub.

If there is no match, it will get a new Headscale account – even if there was
a legacy account which could have matched and migrated.

We recommend new Headscale users explicitly disable automatic migration – but it
should otherwise have no effect if every account has a recorded iss and sub.

When automatic migration is disabled, the strip_email_domain setting will have
no effect.

Special thanks to @micolous for reviewing, proposing and working with us on
these changes.

Other OIDC changes

Headscale now uses
the standard OIDC claims
to populate and update user information every time they log in:

Headscale profile field	OIDC claim	Notes / examples
email address	email	Only used when "email_verified": true
display name	name	eg: Sam Smith
username	preferred_username	Varies depending on IdP and configuration, eg: ssmith, [email protected], \\example.com\ssmith
profile picture	picture	URL to a profile picture or avatar

These should show up nicely in the Tailscale client.

This will also affect the way you
reference users in policies.

BREAKING

• Remove dns.use_username_in_magic_dns configuration option
  #2020,
  #2279
  • Having usernames in magic DNS is no longer possible.
• Remove versions older than 1.56
  #2149
  • Clean up old code required by old versions
• User gRPC/API #2261:
  • If you depend on a Headscale Web UI, you should wait with this update until
    the UI have been updated to match the new API.
  • GET /api/v1/user/{name} and GetUser have been removed in favour of ListUsers with an ID parameter
  • RenameUser and DeleteUser now require an ID instead of a name.

Changes

• Improved compatibilty of built-in DERP server with clients connecting over
  WebSocket #2132
• Allow nodes to use SSH agent forwarding
  #2145
• Fixed processing of fields in post request in MoveNode rpc
  #2179
• Added conversion of 'Hostname' to 'givenName' in a node with FQDN rules
  applied #2198
• Fixed updating of hostname and givenName when it is updated in HostInfo
  #2199
• Fixed missing stable-debug container tag
  #2232
• Loosened up server_url and base_domain check. It was overly strict in some
  cases. #2248
• CLI for managing users now accepts --identifier in addition to --name,
  usage of --identifier is recommended
  #2261
• Add dns.extra_records_path configuration option #2262

Changelog

• b6dc6eb #2140 Fixed reflection of hostname change (#2199)
• cc42fc3 #2177 Added conversion of 'Hostname' to 'givenName' in a node with FQDN rules applied (#2198)
• b3cda08 #2178 Fixed processing of fields in post request in MoveNode rpc (#2179)
• e367454 Add -it to docker exec (#2148)
• 75e7411 Add FAQ entry on which database to use
• 2345c38 Add a page for third-party tools (#2217)
• 1e61084 Add compatibility with only websocket-capable clients (#2132)
• 0602304 Add headplane
• 204a102 Add ouroboros to web ui list (#2154)
• 4445649 Add versioned documentation
• 380fcdb Add worker reading extra_records_path from file (#2271)
• 07b596d Allow nodes to use SSH agent forwarding (#2145)
• 7512e23 Bump deprecated github actions
• 24e7851 Changed all the html into go using go-elem (#2161)
• dc17b4d Documentation dependencies (#2252)
• 0089cea Feature tvos documentation (#2226)
• 0d3cf74 Fix README links to point to the stable version
• d2a86b1...

v0.23.0

This release was intended to be mainly a code reorganisation and refactoring, significantly improving the maintainability of the codebase. This should allow us to improve further and make it easier for the maintainers to keep on top of the project.
However, as you all have noticed, it turned out to become a much larger, much longer release cycle than anticipated. It has ended up to be a release with a lot of rewrites and changes to the code base and functionality of Headscale, cleaning up a lot of technical debt and introducing a lot of improvements. This does come with some breaking changes,

Please remember to always back up your database between versions

Here is a short summary of the broad topics of changes:

Code has been organised into modules, reducing use of global variables/objects, isolating concerns and “putting the right things in the logical place”.

The new policy and mapper package, containing the ACL/Policy logic and the logic for creating the data served to clients (the network “map”) has been rewritten and improved. This change has allowed us to finish SSH support and add additional tests throughout the code to ensure correctness.

The “poller”, or streaming logic has been rewritten and instead of keeping track of the latest updates, checking at a fixed interval, it now uses go channels, implemented in our new notifier package and it allows us to send updates to connected clients immediately. This should both improve performance and potential latency before a client picks up an update.

Headscale now supports sending “delta” updates, thanks to the new mapper and poller logic, allowing us to only inform nodes about new nodes, changed nodes and removed nodes. Previously we sent the entire state of the network every time an update was due.

While we have a pretty good test harness for validating our changes, the changes came down to 284 changed files with 32,316 additions and 24,245 deletions and bugs are expected. We need help testing this release. In addition, while we think the performance should in general be better, there might be regressions in parts of the platform, particularly where we prioritised correctness over speed.

There are also several bugfixes that has been encountered and fixed as part of implementing these changes, particularly
after improving the test harness as part of adopting #1460.

BREAKING

• Code reorganisation, a lot of code has moved, please review the following PRs accordingly #1473
• Change the structure of database configuration, see config-example.yaml for the new structure. #1700
  • Old structure has been remove and the configuration must be converted.
  • Adds additional configuration for PostgreSQL for setting max open, idle connection and idle connection lifetime.
• API: Machine is now Node #1553
• Remove support for older Tailscale clients #1611
  • The oldest supported client is 1.42
• Headscale checks that at least one DERP is defined at start #1564
  • If no DERP is configured, the server will fail to start, this can be because it cannot load the DERPMap from file or url.
• Embedded DERP server requires a private key #1611
  • Add a filepath entry to derp.server.private_key_path
• Docker images are now built with goreleaser (ko) #1716 #1763
  • Entrypoint of container image has changed from shell to headscale, require change from headscale serve to serve
  • /var/lib/headscale and /var/run/headscale is no longer created automatically, see container docs
• Prefixes are now defined per v4 and v6 range. #1756
  • ip_prefixes option is now prefixes.v4 and prefixes.v6
  • prefixes.allocation can be set to assign IPs at sequential or random. #1869
• MagicDNS domains no longer contain usernames
  • This is in preperation to fix Headscales implementation of tags which currently does not correctly remove the link between a tagged device and a user. As tagged devices will not have a user, this will require a change to the DNS generation, removing the username, see #1369 for more information.
  • use_username_in_magic_dns can be used to turn this behaviour on again, but note that this option will be removed when tags are fixed.
    • dns.base_domain can no longer be the same as (or part of) server_url.
    • This option brings Headscales behaviour in line with Tailscale.
• YAML files are no longer supported for headscale policy. #1792
  • HuJSON is now the only supported format for policy.
• DNS configuration has been restructured #2034
  • Please review the new config-example.yaml for the new structure.

Changes

• Use versioned migrations #1644
• Make the OIDC callback page better #1484
• SSH support #1487
• State management has been improved #1492
• Use error group handling to ensure tests actually pass #1535 based on #1460
• Fix hang on SIGTERM #1492 taken from #1480
• Send logs to stderr by default #1524
• Fix TS-2023-006 security UPnP issue #1563
• Turn off gRPC logging #1640 fixes #1259
• Added the possibility to manually create a DERP-map entry which can be customized, instead of automatically creating it. #1565
• Add support for deleting api keys #1702
• Add command to backfill IP addresses for nodes missing IPs from configured prefixes. #1869
• Log available update as warning #1877
• Add autogroup:internet to Policy #1917
• Restore foreign keys and add constraints #1562
• Make registration page easier to use on mobile devices
• Make write-ahead-log default on and configurable for SQLite #1985
• Add APIs for managing headscale policy. #1792
• Fix for registering nodes using preauthkeys when running on a postgres database in a non-UTC timezone. #764
• Make sure integration tests cover postgres for all scenarios
• CLI commands (all except serve) only requires minimal configuration, no more errors or warnings from unset settings #2109
• CLI results are now concistently sent to stdout and errors to stderr #2109
• Fix issue where shutting down headscale would hang #2113

Changelog

• e9d9c07 Exclude irrelevant files from mkdocs rendering (#2136)
• ed78ecd add shutdown that asserts if headscale had panics (#2126)
• 6cbbcd8 flake.lock: Update (#2135)
• 10a72e8 update changelog for 0.23 release (#2138)

v0.23.0-rc.1

This release is mainly a code reorganisation and refactoring, significantly improving the maintainability of the codebase. This should allow us to improve further and make it easier for the maintainers to keep on top of the project.

Please remember to always back up your database between versions

Here is a short summary of the broad topics of changes:

Code has been organised into modules, reducing use of global variables/objects, isolating concerns and “putting the right things in the logical place”.

The new policy and mapper package, containing the ACL/Policy logic and the logic for creating the data served to clients (the network “map”) has been rewritten and improved. This change has allowed us to finish SSH support and add additional tests throughout the code to ensure correctness.

The “poller”, or streaming logic has been rewritten and instead of keeping track of the latest updates, checking at a fixed interval, it now uses go channels, implemented in our new notifier package and it allows us to send updates to connected clients immediately. This should both improve performance and potential latency before a client picks up an update.

Headscale now supports sending “delta” updates, thanks to the new mapper and poller logic, allowing us to only inform nodes about new nodes, changed nodes and removed nodes. Previously we sent the entire state of the network every time an update was due.

While we have a pretty good test harness for validating our changes, we have rewritten over 10000 lines of code and bugs are expected. We need help testing this release. In addition, while we think the performance should in general be better, there might be regressions in parts of the platform, particularly where we prioritised correctness over speed.

There are also several bugfixes that has been encountered and fixed as part of implementing these changes, particularly
after improving the test harness as part of adopting #1460.

BREAKING

• Code reorganisation, a lot of code has moved, please review the following PRs accordingly #1473
• Change the structure of database configuration, see config-example.yaml for the new structure. #1700
  • Old structure has been remove and the configuration must be converted.
  • Adds additional configuration for PostgreSQL for setting max open, idle connection and idle connection lifetime.
• API: Machine is now Node #1553
• Remove support for older Tailscale clients #1611
  • The oldest supported client is 1.42
• Headscale checks that at least one DERP is defined at start #1564
  • If no DERP is configured, the server will fail to start, this can be because it cannot load the DERPMap from file or url.
• Embedded DERP server requires a private key #1611
  • Add a filepath entry to derp.server.private_key_path
• Docker images are now built with goreleaser (ko) #1716 #1763
  • Entrypoint of container image has changed from shell to headscale, require change from headscale serve to serve
  • /var/lib/headscale and /var/run/headscale is no longer created automatically, see container docs
• Prefixes are now defined per v4 and v6 range. #1756
  • ip_prefixes option is now prefixes.v4 and prefixes.v6
  • prefixes.allocation can be set to assign IPs at sequential or random. #1869
• MagicDNS domains no longer contain usernames
  • This is in preperation to fix Headscales implementation of tags which currently does not correctly remove the link between a tagged device and a user. As tagged devices will not have a user, this will require a change to the DNS generation, removing the username, see #1369 for more information.
  • use_username_in_magic_dns can be used to turn this behaviour on again, but note that this option will be removed when tags are fixed.
    • dns.base_domain can no longer be the same as (or part of) server_url.
    • This option brings Headscales behaviour in line with Tailscale.
• YAML files are no longer supported for headscale policy. #1792
  • HuJSON is now the only supported format for policy.
• DNS configuration has been restructured #2034
  • Please review the new config-example.yaml for the new structure.

Changes

• Use versioned migrations #1644
• Make the OIDC callback page better #1484
• SSH support #1487
• State management has been improved #1492
• Use error group handling to ensure tests actually pass #1535 based on #1460
• Fix hang on SIGTERM #1492 taken from #1480
• Send logs to stderr by default #1524
• Fix TS-2023-006 security UPnP issue #1563
• Turn off gRPC logging #1640 fixes #1259
• Added the possibility to manually create a DERP-map entry which can be customized, instead of automatically creating it. #1565
• Add support for deleting api keys #1702
• Add command to backfill IP addresses for nodes missing IPs from configured prefixes. #1869
• Log available update as warning #1877
• Add autogroup:internet to Policy #1917
• Restore foreign keys and add constraints #1562
• Make registration page easier to use on mobile devices
• Make write-ahead-log default on and configurable for SQLite #1985
• Add APIs for managing headscale policy. #1792
• Fix for registering nodes using preauthkeys when running on a postgres database in a non-UTC timezone. #764
• Make sure integration tests cover postgres for all scenarios
• CLI commands (all except serve) only requires minimal configuration, no more errors or warnings from unset settings #2109
• CLI results are now concistently sent to stdout and errors to stderr #2109
• Fix issue where shutting down headscale would hang #2113

Changelog

• c3ef90a Update documentation for Apple (#2117)
• fe68f50 Use headscale.example.com (#2122)

v0.23.0-beta.5

This release is mainly a code reorganisation and refactoring, significantly improving the maintainability of the codebase. This should allow us to improve further and make it easier for the maintainers to keep on top of the project.

Please remember to always back up your database between versions

Here is a short summary of the broad topics of changes:

Code has been organised into modules, reducing use of global variables/objects, isolating concerns and “putting the right things in the logical place”.

The new policy and mapper package, containing the ACL/Policy logic and the logic for creating the data served to clients (the network “map”) has been rewritten and improved. This change has allowed us to finish SSH support and add additional tests throughout the code to ensure correctness.

The “poller”, or streaming logic has been rewritten and instead of keeping track of the latest updates, checking at a fixed interval, it now uses go channels, implemented in our new notifier package and it allows us to send updates to connected clients immediately. This should both improve performance and potential latency before a client picks up an update.

Headscale now supports sending “delta” updates, thanks to the new mapper and poller logic, allowing us to only inform nodes about new nodes, changed nodes and removed nodes. Previously we sent the entire state of the network every time an update was due.

While we have a pretty good test harness for validating our changes, we have rewritten over 10000 lines of code and bugs are expected. We need help testing this release. In addition, while we think the performance should in general be better, there might be regressions in parts of the platform, particularly where we prioritised correctness over speed.

There are also several bugfixes that has been encountered and fixed as part of implementing these changes, particularly
after improving the test harness as part of adopting #1460.

BREAKING

• Code reorganisation, a lot of code has moved, please review the following PRs accordingly #1473
• Change the structure of database configuration, see config-example.yaml for the new structure. #1700
  • Old structure has been remove and the configuration must be converted.
  • Adds additional configuration for PostgreSQL for setting max open, idle connection and idle connection lifetime.
• API: Machine is now Node #1553
• Remove support for older Tailscale clients #1611
  • The oldest supported client is 1.42
• Headscale checks that at least one DERP is defined at start #1564
  • If no DERP is configured, the server will fail to start, this can be because it cannot load the DERPMap from file or url.
• Embedded DERP server requires a private key #1611
  • Add a filepath entry to derp.server.private_key_path
• Docker images are now built with goreleaser (ko) #1716 #1763
  • Entrypoint of container image has changed from shell to headscale, require change from headscale serve to serve
  • /var/lib/headscale and /var/run/headscale is no longer created automatically, see container docs
• Prefixes are now defined per v4 and v6 range. #1756
  • ip_prefixes option is now prefixes.v4 and prefixes.v6
  • prefixes.allocation can be set to assign IPs at sequential or random. #1869
• MagicDNS domains no longer contain usernames
  • This is in preperation to fix Headscales implementation of tags which currently does not correctly remove the link between a tagged device and a user. As tagged devices will not have a user, this will require a change to the DNS generation, removing the username, see #1369 for more information.
  • use_username_in_magic_dns can be used to turn this behaviour on again, but note that this option will be removed when tags are fixed.
    • dns.base_domain can no longer be the same as (or part of) server_url.
    • This option brings Headscales behaviour in line with Tailscale.
• YAML files are no longer supported for headscale policy. #1792
  • HuJSON is now the only supported format for policy.
• DNS configuration has been restructured #2034
  • Please review the new config-example.yaml for the new structure.

Changes

• Use versioned migrations #1644
• Make the OIDC callback page better #1484
• SSH support #1487
• State management has been improved #1492
• Use error group handling to ensure tests actually pass #1535 based on #1460
• Fix hang on SIGTERM #1492 taken from #1480
• Send logs to stderr by default #1524
• Fix TS-2023-006 security UPnP issue #1563
• Turn off gRPC logging #1640 fixes #1259
• Added the possibility to manually create a DERP-map entry which can be customized, instead of automatically creating it. #1565
• Add support for deleting api keys #1702
• Add command to backfill IP addresses for nodes missing IPs from configured prefixes. #1869
• Log available update as warning #1877
• Add autogroup:internet to Policy #1917
• Restore foreign keys and add constraints #1562
• Make registration page easier to use on mobile devices
• Make write-ahead-log default on and configurable for SQLite #1985
• Add APIs for managing headscale policy. #1792
• Fix for registering nodes using preauthkeys when running on a postgres database in a non-UTC timezone. #764
• Make sure integration tests cover postgres for all scenarios
• CLI commands (all except serve) only requires minimal configuration, no more errors or warnings from unset settings #2109
• CLI results are now concistently sent to stdout and errors to stderr #2109
• Fix issue where shutting down headscale would hang #2113

Changelog

• 4b02dc9 make cli mode respect log.level (#2124)
• 64319f7 make stream shutdown if self-node has been removed (#2125)
• 064c46f move logic for validating node names (#2127)

v0.23.0-beta.4

This release is mainly a code reorganisation and refactoring, significantly improving the maintainability of the codebase. This should allow us to improve further and make it easier for the maintainers to keep on top of the project.

Please remember to always back up your database between versions

Here is a short summary of the broad topics of changes:

Code has been organised into modules, reducing use of global variables/objects, isolating concerns and “putting the right things in the logical place”.

The new policy and mapper package, containing the ACL/Policy logic and the logic for creating the data served to clients (the network “map”) has been rewritten and improved. This change has allowed us to finish SSH support and add additional tests throughout the code to ensure correctness.

The “poller”, or streaming logic has been rewritten and instead of keeping track of the latest updates, checking at a fixed interval, it now uses go channels, implemented in our new notifier package and it allows us to send updates to connected clients immediately. This should both improve performance and potential latency before a client picks up an update.

Headscale now supports sending “delta” updates, thanks to the new mapper and poller logic, allowing us to only inform nodes about new nodes, changed nodes and removed nodes. Previously we sent the entire state of the network every time an update was due.

While we have a pretty good test harness for validating our changes, we have rewritten over 10000 lines of code and bugs are expected. We need help testing this release. In addition, while we think the performance should in general be better, there might be regressions in parts of the platform, particularly where we prioritised correctness over speed.

There are also several bugfixes that has been encountered and fixed as part of implementing these changes, particularly
after improving the test harness as part of adopting #1460.

BREAKING

• Code reorganisation, a lot of code has moved, please review the following PRs accordingly #1473
• Change the structure of database configuration, see config-example.yaml for the new structure. #1700
  • Old structure has been remove and the configuration must be converted.
  • Adds additional configuration for PostgreSQL for setting max open, idle connection and idle connection lifetime.
• API: Machine is now Node #1553
• Remove support for older Tailscale clients #1611
  • The oldest supported client is 1.42
• Headscale checks that at least one DERP is defined at start #1564
  • If no DERP is configured, the server will fail to start, this can be because it cannot load the DERPMap from file or url.
• Embedded DERP server requires a private key #1611
  • Add a filepath entry to derp.server.private_key_path
• Docker images are now built with goreleaser (ko) #1716 #1763
  • Entrypoint of container image has changed from shell to headscale, require change from headscale serve to serve
  • /var/lib/headscale and /var/run/headscale is no longer created automatically, see container docs
• Prefixes are now defined per v4 and v6 range. #1756
  • ip_prefixes option is now prefixes.v4 and prefixes.v6
  • prefixes.allocation can be set to assign IPs at sequential or random. #1869
• MagicDNS domains no longer contain usernames
  • This is in preperation to fix Headscales implementation of tags which currently does not correctly remove the link between a tagged device and a user. As tagged devices will not have a user, this will require a change to the DNS generation, removing the username, see #1369 for more information.
  • use_username_in_magic_dns can be used to turn this behaviour on again, but note that this option will be removed when tags are fixed.
    • dns.base_domain can no longer be the same as (or part of) server_url.
    • This option brings Headscales behaviour in line with Tailscale.
• YAML files are no longer supported for headscale policy. #1792
  • HuJSON is now the only supported format for policy.
• DNS configuration has been restructured #2034
  • Please review the new config-example.yaml for the new structure.

Changes

• Use versioned migrations #1644
• Make the OIDC callback page better #1484
• SSH support #1487
• State management has been improved #1492
• Use error group handling to ensure tests actually pass #1535 based on #1460
• Fix hang on SIGTERM #1492 taken from #1480
• Send logs to stderr by default #1524
• Fix TS-2023-006 security UPnP issue #1563
• Turn off gRPC logging #1640 fixes #1259
• Added the possibility to manually create a DERP-map entry which can be customized, instead of automatically creating it. #1565
• Add support for deleting api keys #1702
• Add command to backfill IP addresses for nodes missing IPs from configured prefixes. #1869
• Log available update as warning #1877
• Add autogroup:internet to Policy #1917
• Restore foreign keys and add constraints #1562
• Make registration page easier to use on mobile devices
• Make write-ahead-log default on and configurable for SQLite #1985
• Add APIs for managing headscale policy. #1792
• Fix for registering nodes using preauthkeys when running on a postgres database in a non-UTC timezone. #764
• Make sure integration tests cover postgres for all scenarios
• CLI commands (all except serve) only requires minimal configuration, no more errors or warnings from unset settings #2109
• CLI results are now concistently sent to stdout and errors to stderr #2109
• Fix issue where shutting down headscale would hang #2113

Changelog

• f368ed0 2068 AutoApprovers tests (#2105)
• 35bfe7c Add support for service reload and sync service file (#2102)
• 3101f89 Fix 764 (#2093)
• 60b94b0 Fix slow shutdown (#2113)
• aa0f3d4 Fix typo in example config (#2095)
• e43d6a0 Move flags after the command (#2100)
• 8a3a0fe Only load needed part of configuration (#2109)
• 1c34101 Remove outdated proposals (#2104)
• ed71d23 Remove references to tests/acls from the documentation (#2088)
• 5597eda Remove version and update setup instructions for Android (#2112)
• bac7ea6 Simplify windows setup instructions (#2114)
• d66c5e1 Update documentation for 0.23 (#2096)
• a9a1a07 Use dns: as config key (#2092)
• 6609f60 actually lint file on CI (#2018)
• adc084f add no stalebot exception (#2107)
• 99f18f9 chore: fix some comments (#2069)
• 7be8796 dont override golangci go (#2116)
• 42d2c27 fix goreleaser warnings (#2106)
• 976cbfa flake.lock: Update (#2078)
• c3b260a flake.lock: Update (#2111)
• f039caf...