An open source, self-hosted implementation of the Tailscale control server
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Dongjun Na 5f9c26930c
fixed typo and path (#1960)
2 days ago
.github fix preauth key logging in as previous user (#1920) 4 weeks ago
cmd Initialize log config earlier to prevent trace messages being printed early on (#1939) 2 weeks ago
docs fixed typo and path (#1960) 2 days ago
gen Migrate IP fields in database to dedicated columns (#1869) 1 month ago
hscontrol remove last_successful_update error check (#1959) 3 days ago
integration Simplify map session management (#1931) 6 days ago
proto Migrate IP fields in database to dedicated columns (#1869) 1 month ago
.dockerignore Added integration tests for the embedded DERP server 2 years ago
.envrc Add direnv flake support 2 years ago
.gitignore ensure online status and route changes are propagated (#1564) 6 months ago
.golangci.yaml add annoying linter to golangci 8 months ago
.goreleaser.yml move debug image to distroless (#1950) 2 weeks ago
.prettierignore Fix/improve documentation formatting (#1575) 2 months ago
CHANGELOG.md Fix typos (#1860) 2 weeks ago
CODE_OF_CONDUCT.md Prettier 2 years ago
CONTRIBUTING.md Apply suggestions from code review 1 month ago
Dockerfile.debug remove multistep build, build go last, allowing cached build layers (#1903) 1 month ago
Dockerfile.tailscale-HEAD Simplify map session management (#1931) 6 days ago
LICENSE Initial commit 4 years ago
Makefile Restore foreign keys and add constraints (#1562) 2 weeks ago
README.md Fix typos (#1860) 2 weeks ago
buf.gen.yaml Create an initial gRPC service 3 years ago
config-example.yaml Fix typos (#1860) 2 weeks ago
derp-example.yaml Fix key name about derp port 2 years ago
flake.lock Update flake.lock (#1952) 6 days ago
flake.nix Simplify map session management (#1931) 6 days ago
go.mod Simplify map session management (#1931) 6 days ago
go.sum Simplify map session management (#1931) 6 days ago
mkdocs.yml Fix Github Actions docs pipeline (#1622) 6 months ago
swagger.go move swagger to root for now 1 year ago

README.md

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
  • Support for multiple IP ranges in the tailnet
  • 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
macOS Yes (see /apple on your headscale for more information)
Windows Yes docs
Android Yes docs
iOS Yes docs

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.