# headscale ![ci](https://github.com/juanfont/headscale/actions/workflows/test.yml/badge.svg) An open source, self-hosted implementation of the Tailscale coordination server. Join our [Discord](https://discord.gg/XcQxk2VHjx) 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. ## Overview 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 'coordination/control server'. The control server works as an exchange point of Wireguard public keys for the nodes in the Tailscale network. It also 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. headscale implements this coordination server. ## Support If you like `headscale` and find it useful, there is 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. ## Status - [x] Base functionality (nodes can communicate with each other) - [x] Node registration through the web flow - [x] Network changes are relayed to the nodes - [x] Namespaces support (~tailnets in Tailscale.com naming) - [x] Routing (advertise & accept, including exit nodes) - [x] Node registration via pre-auth keys (including reusable keys, and ephemeral node support) - [x] JSON-formatted output - [x] ACLs - [x] Taildrop (File Sharing) - [x] Support for alternative IP ranges in the tailnets (default Tailscale's 100.64.0.0/10) - [x] DNS (passing DNS servers to nodes) - [x] Single-Sign-On (via Open ID Connect) - [x] Share nodes between namespaces - [x] MagicDNS (see `docs/`) ## 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 | ## Roadmap Suggestions/PRs welcomed! ## 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). ### 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: ```shell make install-protobuf-plugins ``` ### 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 make build ``` ## Contributors
Kristoffer
Kristoffer Dalby
Juan
Juan Font
Ward
Ward Vandewege
ohdearaugustin/
ohdearaugustin
Alessandro
Alessandro (Ale) Segala
unreality/
unreality
Eugen
Eugen Biegler
Aaron
Aaron Bieber
Fernando
Fernando De Lucchi
Hoàng
Hoàng Đức Hiếu
Michael
Michael G.
Paul
Paul Tötterman
Casey
Casey Marshall
Silver
Silver Bullet
Stefan
Stefan Majer
lachy-2849/
lachy-2849
thomas/
thomas
Abraham
Abraham Ingersoll
Adrien
Adrien Raffin-Caboisse
Artem
Artem Klevtsov
Arthur
Arthur Woimbée
Bryan
Bryan Stenson
Felix
Felix Kronlage-Dammers
Felix
Felix Yan
JJGadgets/
JJGadgets
Jim
Jim Tittsler
Pierre
Pierre Carru
rcursaru/
rcursaru
Ryan
Ryan Fowler
Shaanan
Shaanan Cohney
Tanner/
Tanner
Teteros/
Teteros
The
The Gitter Badger
Tianon
Tianon Gravi
Tjerk
Tjerk Woudsma
Zakhar
Zakhar Bessarab
ZiYuan/
ZiYuan
derelm/
derelm
e-zk/
e-zk
ignoramous/
ignoramous
lion24/
lion24
Wakeful-Cloud/
Wakeful-Cloud
zy/
zy