# headscale ![ci](https://github.com/juanfont/headscale/actions/workflows/test.yml/badge.svg) An open source, self-hosted implementation of the Tailscale control server. Join our [Discord](https://discord.gg/c84AZQhmpx) 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](https://tailscale.com/) built on top of [Wireguard](https://www.wireguard.com/). It [works like an overlay network](https://tailscale.com/blog/how-tailscale-works/) between the computers of your networks - using [NAT traversal](https://tailscale.com/blog/how-nat-traversal-works/). 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)](https://tailscale.com/kb/1136/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](./docs/glossary.md) 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 - [Split DNS](https://tailscale.com/kb/1054/dns/#using-dns-settings-in-the-admin-console) - Node registration - Single-Sign-On (via Open ID Connect) - Pre authenticated key - Taildrop (File Sharing) - [Access control lists](https://tailscale.com/kb/1018/acls/) - [MagicDNS](https://tailscale.com/kb/1081/magicdns) - Support for multiple IP ranges in the tailnet - Dual stack (IPv4 and IPv6) - Routing advertising (including exit nodes) - Ephemeral nodes - Embedded [DERP server](https://tailscale.com/blog/how-tailscale-works/#encrypted-tcp-relays-derp) ## 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](./docs/windows-client.md) | | Android | [You need to compile the client yourself](https://github.com/juanfont/headscale/issues/58#issuecomment-885255270) | | iOS | Not yet | ## Running headscale Please have a look at the documentation under [`docs/`](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](https://golang.org) and [Buf](https://buf.build)(Protobuf generator). We recommend using [Nix](https://nixos.org/) 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`](https://golangci-lint.run) and formatted with [`golines`](https://github.com/segmentio/golines) (width 88) and [`gofumpt`](https://github.com/mvdan/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`](https://docs.buf.build/lint/overview) and formatted with [`clang-format`](https://clang.llvm.org/docs/ClangFormat.html). The **rest** (Markdown, YAML, etc) is formatted with [`prettier`](https://prettier.io). Check out the `.golangci.yaml` and `Makefile` to see the specific configuration. ### Install development tools - Go - Buf - Protobuf tools Install and activate: ```shell 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: ```shell make generate ``` **Note**: Please check in changes from `gen/` in a separate commit to make it easier to review. To run the tests: ```shell make test ``` To build the program: ```shell nix build ``` or ```shell make build ``` ## Contributors
Kristoffer
Kristoffer Dalby
Juan
Juan Font
Adrien
Adrien Raffin-Caboisse
Ward
Ward Vandewege
Jiang
Jiang Zhu
Nico/
Nico
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
GrigoriyMikhalkin/
GrigoriyMikhalkin
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 Han
derelm/
derelm
henning
henning mueller
ignoramous/
ignoramous
lion24/
lion24
pernila/
pernila
Wakeful-Cloud/
Wakeful-Cloud
zy/
zy