An open source, self-hosted implementation of the Tailscale control server
Go to file
Kristoffer Dalby 2f045b20fb Refactor tls and wire up grpc, grpc gateway/api
This commit moves the TLS configuration into a seperate function.

It also wires up the gRPC interface and prepares handing the API
endpoints to the grpc gateway.
2021-10-26 20:42:56 +00:00
.github/workflows Contributors again fixed 2021-10-21 23:54:20 +02:00
cmd/headscale Resolve merge conflict 2021-10-24 21:21:01 +01:00
docs fix typo 2021-10-21 23:07:35 +02:00
integration_test move integration to yaml, add new derp configuration 2021-10-22 16:57:01 +00:00
k8s Headscale is not capitalized 2021-10-21 20:48:29 +02:00
proto Create an initial gRPC service 2021-10-26 20:37:37 +00:00
scripts fix setting of version 2021-08-24 07:49:15 -06:00
tests/acls And more tests 2021-07-04 13:23:31 +02:00
.dockerignore Resolve merge conflict 2021-08-13 10:33:19 +01:00
.gitignore Create an initial gRPC service 2021-10-26 20:37:37 +00:00
.goreleaser.yml PRettier on the yamls 2021-10-21 21:18:50 +02:00
acls_test.go Use gorm connection pool 2021-07-04 21:56:13 +02:00
acls_types.go Fixed linting issues 2021-07-04 13:33:00 +02:00
acls.go Convert acls.go 2021-08-05 18:18:18 +01:00
api.go Use the new derp map 2021-10-22 16:56:00 +00:00
app_test.go Rework getAvailableIp 2021-08-02 21:57:45 +01:00
app.go Refactor tls and wire up grpc, grpc gateway/api 2021-10-26 20:42:56 +00:00
apple_mobileconfig.go Comment out iOS from /apple for now 2021-09-26 20:41:48 +01:00
buf.gen.yaml Create an initial gRPC service 2021-10-26 20:37:37 +00:00
cli_test.go Rework getAvailableIp 2021-08-02 21:57:45 +01:00
cli.go Use gorm connection pool 2021-07-04 21:40:46 +02:00
config-example.yaml Fix config and tests 2021-10-24 21:30:51 +01:00
db.go Renamed SharedNode to SharedMachine 2021-09-06 14:43:43 +02:00
derp-example.yaml Update derp-example.yaml 2021-10-22 23:58:27 +01:00
derp.go Add helper functions for building derp maps from urls and file 2021-10-22 16:55:35 +00:00
dns_test.go Added tests, solved some bugs, and code reorg 2021-10-17 23:58:09 +02:00
dns.go Added tests, solved some bugs, and code reorg 2021-10-17 23:58:09 +02:00
Dockerfile Add certificates to docker image so we can get derpmap from tailscale 2021-10-22 16:56:23 +00:00
Dockerfile.tailscale Remove non working default 2021-09-21 11:10:26 +01:00
go.mod Update go.mod 2021-10-26 20:41:35 +00:00
go.sum Update go.mod 2021-10-26 20:41:35 +00:00
grpcv1.go Add an initial grpcv1 service (implementing the proto generated service) 2021-10-26 20:42:20 +00:00
integration_test.go Remove derpmap volume from integration tests 2021-10-22 16:57:51 +00:00
LICENSE Initial commit 2020-06-21 11:21:07 +02:00
machine_test.go Add more test cases to prove that peers and shared peers work properly 2021-10-04 17:40:21 +00:00
machine.go Preload the Namespace from SharedMachines 2021-10-17 11:59:08 +02:00
Makefile Added version checker on startup 2021-09-27 16:26:18 +02:00
metrics.go Update metrics for new code 2021-10-05 21:59:15 +00:00
namespaces_test.go Solved merge 2021-10-17 23:59:44 +02:00
namespaces.go Solved merge 2021-10-17 23:59:44 +02:00
poll.go Update metrics for new code 2021-10-05 21:59:15 +00:00
preauth_keys_test.go Fixed merge 2021-10-13 23:28:47 +02:00
preauth_keys.go Fixed merge 2021-10-13 23:28:47 +02:00
README.md Add note about main containing unreleased changes 2021-10-25 19:38:11 +01:00
routes_test.go Update test machine name properly 2021-08-21 15:35:26 +01:00
routes.go Minor linting issues 2021-09-02 17:08:39 +02:00
sharing_test.go Apply some DRY to the sharing tests. 2021-10-18 17:52:38 -04:00
sharing.go Add cli support for unsharing a node from a namespace. 2021-10-17 16:29:46 -04:00
tools.go Create an initial gRPC service 2021-10-26 20:37:37 +00:00
utils_test.go Do not issue "network" or "broadcast" addresses (0 or 255) 2021-08-03 10:06:42 +01:00
utils.go Resolve merge conflict 2021-08-13 10:33:19 +01:00

headscale

ci

An open source, self-hosted implementation of the Tailscale coordination 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.

Overview

Tailscale is a modern VPN built on top of Wireguard. It works like an overlay network between the computers of your networks - using all kinds of NAT traversal sorcery.

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.

Status

  • Base functionality (nodes can communicate with each other)
  • Node registration through the web flow
  • Network changes are relayed to the nodes
  • Namespaces support (~tailnets in Tailscale.com naming)
  • Routing (advertise & accept, including exit nodes)
  • Node registration via pre-auth keys (including reusable keys, and ephemeral node support)
  • JSON-formatted output
  • ACLs
  • Taildrop (File Sharing)
  • Support for alternative IP ranges in the tailnets (default Tailscale's 100.64.0.0/10)
  • DNS (passing DNS servers to nodes)
  • Share nodes between namespaces
  • MagicDNS (see docs/)

Client OS support

OS Supports headscale
Linux Yes
OpenBSD Yes
macOS Yes (see /apple on your headscale for more information)
Windows Yes
Android You need to compile the client yourself
iOS Not yet

Roadmap 🤷

Suggestions/PRs welcomed!

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 writing this was to learn how Tailscale works.

Contributors

Juan
Juan Font
Kristoffer
Kristoffer Dalby
Ward
Ward Vandewege
ohdearaugustin/
ohdearaugustin
Aaron
Aaron Bieber
Paul
Paul Tötterman
Casey
Casey Marshall
Silver
Silver Bullet
thomas/
thomas
Arthur
Arthur Woimbée
Felix
Felix Kronlage-Dammers
Felix
Felix Yan
Shaanan
Shaanan Cohney
Teteros/
Teteros
The
The Gitter Badger
Tianon
Tianon Gravi
Tjerk
Tjerk Woudsma
Zakhar
Zakhar Bessarab
derelm/
derelm
ignoramous/
ignoramous
zy/
zy