An open source, self-hosted implementation of the Tailscale control server https://github.com/juanfont/headscale
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.
 
 
 
Juan Font 4a200c308b
Merge pull request #656 from juanfont/abandon-gin
12 hours ago
.github chore: use docker-meta version 1 week ago
cmd/headscale Update cmd/headscale/cli/utils.go 18 hours ago
docs Merge branch 'main' into acl-syntax-fixes 2 weeks ago
gen Merge master 1 month ago
integration_test Update integration dump tests 2 weeks ago
proto Merge master 1 month ago
tests/acls Added missing file 3 weeks ago
.dockerignore Added integration tests for the embedded DERP server 4 months ago
.envrc Add direnv flake support 3 months ago
.gitignore Ignore new dump file 2 weeks ago
.golangci.yaml fix: ignore exhaust linter 1 month ago
.goreleaser.yml Drop arm32 (armhf) for linux and add Darwin arm64 3 weeks ago
CHANGELOG.md Merge branch 'main' into abandon-gin 17 hours ago
Dockerfile chore: add version to binary in containers 1 week ago
Dockerfile.alpine chore: add version to binary in containers 1 week ago
Dockerfile.debug chore: add version to binary in containers 1 week ago
Dockerfile.tailscale Added default values in Dockerfile.tailscale 3 months ago
Dockerfile.tailscale-HEAD Added missing package 3 months ago
LICENSE Initial commit 2 years ago
Makefile fix issue 635 2 weeks ago
README.md docs(README): update contributors 17 hours ago
acls.go Lint fixes 1/n 16 hours ago
acls_test.go Use constants in tests 2 weeks ago
acls_types.go Improve ACLs by adding protocol parsing support 3 weeks ago
api.go Lint fixes 7/n 15 hours ago
api_key.go Use strings.Cut to simplify logic 3 weeks ago
api_key_test.go Add api key data model and helpers 5 months ago
app.go Lint fixes 5/n 16 hours ago
app_test.go Switch config to pointer 3 weeks ago
buf.gen.yaml Create an initial gRPC service 8 months ago
config-example.yaml add ability to set randomizeClientPort 2 weeks ago
config.go Remove debug output, it runs before we disable it 2 weeks ago
db.go Fix implicit memory aliasing in for loop (lint 8/n) 15 hours ago
derp-example.yaml Fix key name about derp port 3 months ago
derp.go Use new update state logic for derp maps 2 weeks ago
derp_server.go Lint fixes 5/n 16 hours ago
dns.go Change to a go generics set implementation, no more casting 🎉 4 weeks ago
dns_test.go Tailscale 1.26 uses dnstype pointer 2 weeks ago
flake.lock Update build system 2 weeks ago
flake.nix updated nix flake go.sum 16 hours ago
go.mod Added mux dependency 6 days ago
go.sum Switch to use gorilla's mux as muxer 1 week ago
grpcv1.go Merge master 1 month ago
integration_cli_test.go add integration test for headscale -c 3 weeks ago
integration_common_test.go Add 1.26 to tests 2 weeks ago
integration_embedded_derp_test.go Retreive hostnames from headscale, now that they are random 1 month ago
integration_test.go Fix some issues in testing with new hostname handling 4 weeks ago
machine.go Lint fixes 1/n 16 hours ago
machine_test.go Lint fixes 7/n 15 hours ago
metrics.go Go format with shorter lines 8 months ago
namespaces.go Change Set state change function to filter instead of single namespace 2 weeks ago
namespaces_test.go Merge master 1 month ago
oidc.go Lint fixes 7/n 15 hours ago
platform_config.go Lint fixes 5/n 16 hours ago
poll.go Fixed issue when in linting rampage 13 hours ago
preauth_keys.go Check all errors for db.Save 4 weeks ago
preauth_keys_test.go Rename name -> hostname, nickname -> givenname 2 months ago
routes.go Check all errors for db.Save 4 weeks ago
routes_test.go Lint fixes 1/n 16 hours ago
swagger.go Lint fixes 5/n 16 hours ago
utils.go Lint fixes 2/n 16 hours ago
utils_test.go fix occasional panic on registration 2 weeks ago

README.md

headscale

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 has a narrower scope and an instance of headscale implements a single Tailnet, which is typically what a single organisation, or home/personal setup would use.

headscale uses terms that maps to Tailscale's control server, consult the glossary for explainations.

Support

If you like headscale and find it useful, there is a sponsorship and donation buttons available in the repo.

If you would like to sponsor features, bugs or prioritisation, reach out to one of the maintainers.

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 You need to compile the client yourself
iOS Not yet

Running headscale

Please have a look at the documentation under docs/.

Disclaimer

  1. We have nothing to do with Tailscale, or Tailscale Inc.
  2. The purpose of Headscale is maintaining a working, self-hosted Tailscale control panel.

Contributing

To contribute to headscale you would need the lastest 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.

PRs and suggestions are welcome.

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

Kristoffer
Kristoffer Dalby
Juan
Juan Font
Adrien
Adrien Raffin-Caboisse
Ward
Ward Vandewege
Nico/
Nico
Jiang
Jiang Zhu
e-zk/
e-zk
Justin
Justin Angel
Alessandro
Alessandro (Ale) Segala
unreality/
unreality
Moritz
Moritz Poldrack
ohdearaugustin/
ohdearaugustin
Niek
Niek van der Maas
Eugen
Eugen Biegler
Aaron
Aaron Bieber
Anton
Anton Schubert
Fernando
Fernando De Lucchi
Hoàng
Hoàng Đức Hiếu
bravechamp/
bravechamp
Deon
Deon Thomas
ChibangLW/
ChibangLW
Mevan
Mevan Samaratunga
Michael
Michael G.
Paul
Paul Tötterman
Samuel
Samuel Lock
Stefan
Stefan Majer
Artem
Artem Klevtsov
Casey
Casey Marshall
Pavlos
Pavlos Vinieratos
Silver
Silver Bullet
lachy2849/
lachy2849
thomas/
thomas
Abraham
Abraham Ingersoll
Antoine
Antoine POPINEAU
Aofei
Aofei Sheng
Arthur
Arthur Woimbée
Bryan
Bryan Stenson
Carson
Carson Yang
kundel/
kundel
Felix
Felix Kronlage-Dammers
Felix
Felix Yan
JJGadgets/
JJGadgets
Jamie
Jamie Greeff
Jim
Jim Tittsler
Pierre
Pierre Carru
rcursaru/
rcursaru
WhiteSource
WhiteSource Renovate
Ryan
Ryan Fowler
Shaanan
Shaanan Cohney
Tanner/
Tanner
Teteros/
Teteros
The
The Gitter Badger
Tianon
Tianon Gravi
Tjerk
Tjerk Woudsma
Yang
Yang Bin
Zakhar
Zakhar Bessarab
ZiYuan/
ZiYuan
derelm/
derelm
henning
henning mueller
ignoramous/
ignoramous
lion24/
lion24
pernila/
pernila
Wakeful-Cloud/
Wakeful-Cloud
zy/
zy