An open source, self-hosted implementation of the Tailscale control server
Go to file
Kristoffer Dalby 161243c787 make generateFilterRules take machine and peers
Signed-off-by: Kristoffer Dalby <kristoffer@tailscale.com>
2023-06-21 10:31:48 +02:00
.github port reminder of integrationv1 test to v2 2023-05-10 20:47:51 +02:00
cmd move Config definitions into types 2023-06-08 16:34:15 +02:00
docs Added web ui section 2023-05-10 16:16:12 +02:00
examples Move examples out of docs/ directory 2023-04-07 15:24:13 +02:00
gen regenerate gen 2023-05-10 20:47:51 +02:00
hscontrol make generateFilterRules take machine and peers 2023-06-21 10:31:48 +02:00
integration Finish SSH 2023-06-21 10:31:48 +02:00
proto Allow to delete routes (#1244) 2023-03-06 09:05:40 +01: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 create DB struct 2023-05-26 12:24:50 +02:00
.golangci.yaml Remove deprecated linters + one casuing issues with imports 2023-04-04 22:37:27 +02:00
.goreleaser.yml Put systemd service file in proper location 2023-04-30 18:25:43 +02:00
.prettierignore make prettier ignore generated test flows 2023-01-06 12:32:24 +01:00
buf.gen.yaml Create an initial gRPC service 2021-10-26 20:37:37 +00:00
CHANGELOG.md Finish SSH 2023-06-21 10:31:48 +02:00
CODE_OF_CONDUCT.md Prettier 2022-08-18 22:32:53 +00:00
config-example.yaml Revert "Revert unix_socket to default value" 2023-05-10 14:25:13 +02:00
derp-example.yaml Fix key name about derp port 2022-04-10 09:53:27 +08:00
Dockerfile Clean apt 2023-05-12 10:09:36 +02:00
Dockerfile.debug Create default sock path in Docker 2023-05-10 18:18:04 +02:00
Dockerfile.tailscale trim dockerfiles, script to rebuild test images (#1403) 2023-05-02 10:51:30 +01:00
Dockerfile.tailscale-HEAD trim dockerfiles, script to rebuild test images (#1403) 2023-05-02 10:51:30 +01:00
flake.lock Update flakes, add some quality of life improvements (#1346) 2023-04-20 07:56:53 +02:00
flake.nix upgrade tailscale 2023-06-21 10:31:48 +02:00
go.mod upgrade tailscale 2023-06-21 10:31:48 +02:00
go.sum upgrade tailscale 2023-06-21 10:31:48 +02:00
LICENSE Initial commit 2020-06-21 11:21:07 +02:00
Makefile port reminder of integrationv1 test to v2 2023-05-10 20:47:51 +02:00
mkdocs.yml Added web ui section 2023-05-10 16:16:12 +02:00
README.md docs(README): update contributors 2023-05-27 16:21:42 +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
  • 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

  1. This project is not associated with Tailscale Inc.
  2. The purpose of Headscale is maintaining a working, self-hosted Tailscale control panel.

Contributing

Headscale is "Open Source, acknowledged contribution", this means that any contribution will have to be discussed with the Maintainers before being submitted.

This model has been chosen to reduce the risk of burnout by limiting the maintenance overhead of reviewing and validating third-party code.

Headscale is open to code contributions for bug fixes without discussion.

If you find mistakes in the documentation, please submit a fix to the documentation.

Requirements

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.

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
Ward
Ward Vandewege
Jiang
Jiang Zhu
Benjamin
Benjamin Roberts
Nico/
Nico
Even
Even Holthe
e-zk/
e-zk
Justin
Justin Angel
Alessandro
Alessandro (Ale) Segala
ohdearaugustin/
ohdearaugustin
unreality/
unreality
Moritz
Moritz Poldrack
Andriy
Andriy Kushnir
Adrien
Adrien Raffin-Caboisse
GrigoriyMikhalkin/
GrigoriyMikhalkin
Christian
Christian Heusel
Mike
Mike Lloyd
Anton
Anton Schubert
Niek
Niek van der Maas
Eugen
Eugen Biegler
Azz/
Azz
Aaron
Aaron Bieber
Igor
Igor Perepilitsyn
Laurent
Laurent Marchaud
Stefan
Stefan Majer
Fernando
Fernando De Lucchi
Orville
Orville Q. Song
hdhoang/
hdhoang
bravechamp/
bravechamp
Deon
Deon Thomas
Jamie
Jamie Greeff
Jonathan
Jonathan Wright
ChibangLW/
ChibangLW
Maja
Maja Bojarska
Mevan
Mevan Samaratunga
Michael
Michael G.
Paul
Paul Tötterman
Samuel
Samuel Lock
loprima-l/
loprima-l
kevinlin/
kevinlin
Snack/
Snack
Artem
Artem Klevtsov
Casey
Casey Marshall
dbevacqua/
dbevacqua
Josh
Josh Taylor
LiuHanCheng/
LiuHanCheng
Motiejus
Motiejus Jakštys
Pavlos
Pavlos Vinieratos
Silver
Silver Bullet
Steven
Steven Honson
Victor
Victor Freire
thomas/
thomas
Sean
Sean Reifschneider
Abraham
Abraham Ingersoll
Albert
Albert Copeland
Andrei
Andrei Pechkurov
Anoop
Anoop Sundaresh
Antoine
Antoine POPINEAU
Antonio
Antonio Fernandez
Aofei
Aofei Sheng
Arnar/
Arnar
Arthur
Arthur Woimbée
Avirut
Avirut Mehta
Bryan
Bryan Stenson
Carson
Carson Yang
Darrell
Darrell Kundel
fatih-acar/
fatih-acar
Felix
Felix Kronlage-Dammers
Felix
Felix Yan
Gabe
Gabe Cook
JJGadgets/
JJGadgets
hrtkpf/
hrtkpf
Jim
Jim Tittsler
Johan
Johan Siebens
John
John Axel Eriksson
Jonathan
Jonathan de Jong
Julien
Julien Zweverink
Kurnia
Kurnia D Win
Marc/
Marc
Maxim
Maxim Gajdaj
Mesar
Mesar Hameed
Michael
Michael Savage
Philipp
Philipp Krivanec
Pierre
Pierre Carru
Pontus
Pontus N
Rasmus
Rasmus Moorats
rcursaru/
rcursaru
Mend
Mend Renovate
Ryan
Ryan Fowler
Sebastian
Sebastian Muszytowski
Shaanan
Shaanan Cohney
Six/
Six
Stefan
Stefan VanBuren
sophware/
sophware
Tanner/
Tanner
Teteros/
Teteros
The
The Gitter Badger
Tianon
Tianon Gravi
Till
Till Hoffmann
Tjerk
Tjerk Woudsma
Yang
Yang Bin
Yujie
Yujie Xia
Zachary
Zachary Newell
Zakhar
Zakhar Bessarab
Zhiyuan
Zhiyuan Zheng
Ziyuan
Ziyuan Han
caelansar/
caelansar
derelm/
derelm
dnaq/
dnaq
henning
henning mueller
ignoramous/
ignoramous
jimyag/
jimyag
suhelen/
suhelen
sharkonet/
sharkonet
ma6174/
ma6174
manju-rn/
manju-rn
nicholas-yap/
nicholas-yap
Tommi
Tommi Pernila
phpmalik/
phpmalik
Wakeful-Cloud/
Wakeful-Cloud
zy/
zy
Àlex
Àlex Torregrosa