Ryan Malloy
32ea1c1c84
Bugs found by running the real test suite after merging upstream: - types/types_clone.go, types/types_view.go: extend the regeneration guard struct literals to include the new Groups field, and add a UserView.Groups() accessor. Generated files normally rebuilt via cloner / viewer; touched by hand here pending make generate. - db/db.go: the migration adding the groups column ran after 202505141324, which calls ListUsers() through the User struct that now includes Groups. Move the column-add to 202505141323 so the schema is in place before any migration loads users. Register the new ID in the FK-disabled migration list. - db/db.go: 202507021200 recreates all tables from inline SQL during the SQLite schema migration; add groups to both the CREATE TABLE users statement and the INSERT INTO users ... SELECT FROM users_old so the column survives the recreation. Also fix a copy-paste bug in the Rollback closure that referenced tx instead of db. - db/schema.sql: add the groups column to the canonical schema so squibble.Validate accepts databases produced by the new migration chain. Verified against all 7 historical sqlite dumps in hscontrol/db/testdata/sqlite. - types/users_test.go: the casby-oidc-claim case now exercises group storage; update the want to include the JSON-encoded groups column. - integration/oidc_groups_test.go: replace the aspirational draft (which referenced assertNoErr, scenario.usernames, hsic.WithTLS and other symbols that do not exist) with a focused test that follows the auth_oidc_test.go pattern. Verifies the groups column directly via sqlite3 inside the headscale container since the gRPC User message does not expose Groups.
An open source, self-hosted implementation of the Tailscale control server.
Join our Discord server for a chat.
Note: Always select the same GitHub tag as the released version you use
to ensure you have the correct example configuration. The main branch might
contain unreleased changes. The documentation is available for stable and
development versions:
What is Tailscale
Tailscale is a modern VPN built on top of Wireguard. It works like an overlay network between the computers of your networks - using NAT traversal.
Everything in Tailscale is Open Source, except the GUI clients for proprietary OS (Windows and macOS/iOS), and the control server.
The control server works as an exchange point of Wireguard public keys for the nodes in the Tailscale network. It assigns the IP addresses of the clients, creates the boundaries between each user, enables sharing machines between users, and exposes the advertised routes of your nodes.
A Tailscale network (tailnet) is private network which Tailscale assigns to a user in terms of private users or an organisation.
Design goal
Headscale aims to implement a self-hosted, open source alternative to the Tailscale control server. Headscale's goal is to provide self-hosters and hobbyists with an open-source server they can use for their projects and labs. It implements a narrow scope, a single Tailscale network (tailnet), suitable for a personal use, or a small open-source organisation.
Supporting Headscale
If you like headscale and find it useful, there is a sponsorship and donation
buttons available in the repo.
Features
Please see "Features" in the documentation.
Client OS support
Please see "Client and operating system support" in the documentation.
Running headscale
Please note that we do not support nor encourage the use of reverse proxies and container to run Headscale.
Please have a look at the documentation.
For NixOS users, a module is available in nix/.
Builds from main
Development builds from the main branch are available as container images and
binaries. See the development builds
documentation for details.
Talks
- Fosdem 2026 (video): Headscale & Tailscale: The complementary open source clone
- presented by Kristoffer Dalby
- Fosdem 2023 (video): Headscale: How we are using integration testing to reimplement Tailscale
- presented by Juan Font Alonso and Kristoffer Dalby
Disclaimer
This project is not associated with Tailscale Inc.
However, one of the active maintainers for Headscale is employed by Tailscale and he is allowed to spend work hours contributing to the project. Contributions from this maintainer are reviewed by other maintainers.
The maintainers work together on setting the direction for the project. The underlying principle is to serve the community of self-hosters, enthusiasts and hobbyists - while having a sustainable project.
Contributing
Please read the CONTRIBUTING.md file.
Requirements
To contribute to headscale you would need the latest version of Go and Buf (Protobuf generator).
We recommend using Nix to setup a development environment. This can
be done with nix develop, which will install the tools and give you a shell.
This guarantees that you will have the same dev env as headscale maintainers.
Code style
To ensure we have some consistency with a growing number of contributions, this project has adopted linting and style/formatting rules:
The Go code is linted with golangci-lint and
formatted with golines (width 88) and
gofumpt.
Please configure your editor to run the tools while developing and make sure to
run make lint and make fmt before committing any code.
The Proto code is linted with buf and
formatted with clang-format.
The docs are formatted with mdformat.
The rest (Markdown, YAML, etc) is formatted with prettier.
Check out the .golangci.yaml and Makefile to see the specific configuration.
Install development tools
- Go
- Buf
- Protobuf tools
Install and activate:
nix develop
Testing and building
Some parts of the project require the generation of Go code from Protobuf
(if changes are made in proto/) and it must be (re-)generated with:
make generate
Note: Please check in changes from gen/ in a separate commit to make it easier to review.
To run the tests:
make test
To build the program:
make build
Development workflow
We recommend using Nix for dependency management to ensure you have all required tools. If you prefer to manage dependencies yourself, you can use Make directly:
With Nix (recommended):
nix develop
make test
make build
With your own dependencies:
make test
make build
The Makefile will warn you if any required tools are missing and suggest running nix develop. Run make help to see all available targets.
Contributors
Made with contrib.rocks.