The custom version of headscale utilized by myriation. This follows upstream main, with a couple of open PRs manually merged in. https://ts.myriation.xyz
Find a file
Alessandro (Ale) Segala 3b34c7b89a
Removed / from docker commands in docs
Essentially reverts 6076656373
2021-11-09 16:23:36 +00:00
.github/workflows Fix step naming error 2021-10-31 19:54:38 +00:00
cmd/headscale Move context per cure's suggestion 2021-10-31 16:26:51 +00:00
docs Removed / from docker commands in docs 2021-11-09 16:23:36 +00:00
gen Rename protofile 2021-10-30 14:29:41 +00: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 Rename protofile 2021-10-30 14:29:41 +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 Switch from gRPC localhost to socket 2021-10-30 14:08:16 +00:00
.gitignore Prepare for checking in generated code 2021-10-27 06:40:39 +00:00
.golangci.yaml Add gen explicitly to skip list 2021-10-27 07:08:24 +00:00
.goreleaser.yml PRettier on the yamls 2021-10-21 21:18:50 +02:00
acls.go Convert acls.go 2021-08-05 18:18:18 +01: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
api.go Resolve merge conflict 2021-10-30 15:33:01 +00:00
app.go Remove flag that cant be trapped 2021-11-02 21:49:19 +00:00
app_test.go Rework getAvailableIp 2021-08-02 21:57:45 +01: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.go updates from code review 2021-10-10 17:22:42 +08:00
cli_test.go Fix broken machine test 2021-10-18 19:26:43 +00:00
config-example.yaml Resolve merge conflict 2021-10-31 09:40:43 +00: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.go Added tests, solved some bugs, and code reorg 2021-10-17 23:58:09 +02:00
dns_test.go Added tests, solved some bugs, and code reorg 2021-10-17 23:58:09 +02:00
Dockerfile Allow running headscale without leading / 2021-11-09 16:20:58 +00:00
Dockerfile.tailscale Remove non working default 2021-09-21 11:10:26 +01:00
go.mod Resolve merge conflict 2021-10-30 15:33:01 +00:00
go.sum Resolve merge conflict 2021-10-30 15:33:01 +00:00
grpcv1.go Setup create, delete and list namespace over grpc 2021-10-29 16:44:32 +00:00
integration_test.go Fixed integration tests 2021-11-07 19:09:51 +00:00
LICENSE Initial commit 2020-06-21 11:21:07 +02:00
machine.go Resolve merge conflict 2021-10-30 15:33:01 +00: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
Makefile Setup proto linting 2021-10-29 16:42:56 +00:00
metrics.go Update metrics for new code 2021-10-05 21:59:15 +00:00
namespaces.go Merge branch 'main' into main 2021-10-19 15:26:18 +01:00
namespaces_test.go Solved merge 2021-10-17 23:59:44 +02:00
oidc.go Fix up leftovers from kradalby PR 2021-10-19 18:25:59 +01:00
oidc_test.go Remove lint from generated testcode 2021-10-30 15:39:05 +00:00
poll.go Update metrics for new code 2021-10-05 21:59:15 +00:00
preauth_keys.go Fixed merge 2021-10-13 23:28:47 +02:00
preauth_keys_test.go Fixed merge 2021-10-13 23:28:47 +02:00
README.md Typo in golang URL 2021-11-06 07:43:41 +00:00
routes.go Minor linting issues 2021-09-02 17:08:39 +02:00
routes_test.go Update test machine name properly 2021-08-21 15:35:26 +01:00
sharing.go When attempting to unshare a node from the primary namespace, return 2021-10-24 17:50:21 -04:00
sharing_test.go When attempting to unshare a node from the primary namespace, return 2021-10-24 17:50:21 -04:00
swagger.go Setup swagger and swagger UI properly 2021-10-30 14:29:53 +00:00
tools.go Create an initial gRPC service 2021-10-26 20:37:37 +00:00
utils.go Fix lint error 2021-10-30 14:29:03 +00:00
utils_test.go Do not issue "network" or "broadcast" addresses (0 or 255) 2021-08-03 10:06:42 +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)
  • Single-Sign-On (via Open ID Connect)
  • 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.

Contributing

To contribute to Headscale you would need the lastest version of Go and Buf(Protobuf generator).

Install development tools

  • Go
  • Buf
  • Protobuf tools:
make install-protobuf-plugins

Testing and building

Some parts of the project requires the generation of Go code from Protobuf (if changes is 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:

make build

Contributors

Juan
Juan Font
Kristoffer
Kristoffer Dalby
Ward
Ward Vandewege
ohdearaugustin/
ohdearaugustin
unreality/
unreality
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