An open source, self-hosted implementation of the Tailscale control server
Go to file
Kristoffer Dalby ed78ecda12
add shutdown that asserts if headscale had panics (#2126)
Signed-off-by: Kristoffer Dalby <kristoffer@tailscale.com>
2024-09-17 11:44:55 +02:00
.github make stream shutdown if self-node has been removed (#2125) 2024-09-11 12:00:32 +02:00
cmd Fix slow shutdown (#2113) 2024-09-09 14:10:22 +02:00
docs Use headscale.example.com (#2122) 2024-09-11 16:46:06 +00:00
gen update godeps (#2098) 2024-09-04 07:55:16 +02:00
hscontrol Update documentation for Apple (#2117) 2024-09-11 18:43:59 +02:00
integration add shutdown that asserts if headscale had panics (#2126) 2024-09-17 11:44:55 +02:00
proto update godeps (#2098) 2024-09-04 07:55:16 +02:00
.coderabbit.yaml add coderabbit config (#2060) 2024-08-19 10:06:55 +00:00
.dockerignore Added integration tests for the embedded DERP server 2022-03-05 19:34:06 +01:00
.envrc Add direnv flake support 2022-03-19 09:23:03 +00:00
.gitignore Only load needed part of configuration (#2109) 2024-09-07 09:23:58 +02:00
.golangci.yaml Remove deprecated linters from golangci-lint (#2009) 2024-07-17 10:08:41 +02:00
.goreleaser.yml fix goreleaser warnings (#2106) 2024-09-05 14:00:19 +02:00
.prettierignore Fix/improve documentation formatting (#1575) 2024-03-22 19:55:20 +01:00
buf.gen.yaml Create an initial gRPC service 2021-10-26 20:37:37 +00:00
CHANGELOG.md Fix slow shutdown (#2113) 2024-09-09 14:10:22 +02:00
CODE_OF_CONDUCT.md Prettier 2022-08-18 22:32:53 +00:00
config-example.yaml Fix typo in example config (#2095) 2024-09-02 06:18:16 +00:00
CONTRIBUTING.md update godeps (#2098) 2024-09-04 07:55:16 +02:00
derp-example.yaml Fix key name about derp port 2022-04-10 09:53:27 +08:00
Dockerfile.debug upgrade go (1.23) and tailscale (1.72.1) (#2077) 2024-08-23 15:28:54 +02:00
Dockerfile.tailscale-HEAD upgrade go (1.23) and tailscale (1.72.1) (#2077) 2024-08-23 15:28:54 +02:00
flake.lock flake.lock: Update (#2135) 2024-09-16 06:15:45 +00:00
flake.nix dont override golangci go (#2116) 2024-09-09 14:29:09 +02:00
go.mod update godeps (#2098) 2024-09-04 07:55:16 +02:00
go.sum update godeps (#2098) 2024-09-04 07:55:16 +02:00
LICENSE Initial commit 2020-06-21 11:21:07 +02:00
Makefile Restore foreign keys and add constraints (#1562) 2024-05-15 20:40:14 -04:00
mkdocs.yml Exclude irrelevant files from mkdocs rendering (#2136) 2024-09-16 06:13:45 +00:00
README.md Update documentation for Apple (#2117) 2024-09-11 18:43:59 +02:00
swagger.go move swagger to root for now 2023-05-10 20:47:51 +02:00

headscale logo

ci

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 and documentation. The main branch might contain unreleased changes.

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 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

  • Full "base" support of Tailscale's features
  • Configurable DNS
  • Node registration
    • Single-Sign-On (via Open ID Connect)
    • Pre authenticated key
  • Taildrop (File Sharing)
  • Access control lists
  • MagicDNS
  • Dual stack (IPv4 and IPv6)
  • Routing advertising (including exit nodes)
  • Ephemeral nodes
  • Embedded DERP server

Client OS support

OS Supports headscale
Linux Yes
OpenBSD Yes
FreeBSD Yes
Windows Yes (see docs and /windows on your headscale for more information)
Android Yes (see docs)
macOS Yes (see docs and /apple on your headscale for more information)
iOS Yes (see docs and /apple on your headscale for more information)

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.

Talks

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 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:

nix build

or

make build

Contributors

Made with contrib.rocks.