juanfont/headscale
1
1
Fork 0
mirror of https://github.com/juanfont/headscale.git synced 2024-11-11 01:22:30 +08:00
Code Issues Projects Releases Packages Wiki Activity
An open source, self-hosted implementation of the Tailscale control server
643 commits 53 branches 130 tags 28 MiB
Go 97.5%
HTML 1.6%
Nix 0.6%
Shell 0.2%
Makefile 0.1%
Find a file
Kristoffer Dalby 4d4d0de356
Start adding comments to config
2021-10-22 18:27:11 +01:00
.github/workflows Contributors again fixed 2021-10-21 23:54:20 +02:00
cmd/headscale Remove the need for multiple config files 2021-10-22 18:14:29 +01:00
docs fix typo 2021-10-21 23:07:35 +02:00
integration_test Merged main 2021-10-04 23:43:42 +02:00
k8s Headscale is not capitalized 2021-10-21 20:48:29 +02:00
scripts fix setting of version 2021-08-24 07:49:15 -06:00
tests/acls
.dockerignore Resolve merge conflict 2021-08-13 10:33:19 +01:00
.gitignore Merge branch 'main' into topic/docker-release 2021-09-12 18:18:34 +02: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
acls_types.go
api.go Added tests, solved some bugs, and code reorg 2021-10-17 23:58:09 +02:00
app.go Apply suggestions from code review 2021-10-20 09:35:56 +02: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
cli.go
cli_test.go Rework getAvailableIp 2021-08-02 21:57:45 +01:00
config-example.yaml Start adding comments to config 2021-10-22 18:27:11 +01:00
db.go Renamed SharedNode to SharedMachine 2021-09-06 14:43:43 +02:00
derp.yaml docs: add notes on how to build own DERP server 2021-09-02 06:08:12 +08: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 Dockerfile: add golang tag 2021-09-13 20:03:03 +02:00
Dockerfile.tailscale Remove non working default 2021-09-21 11:10:26 +01:00
go.mod Merge branch 'main' into magic-dns-support 2021-10-09 12:24:07 +02:00
go.sum Allow multiple namespaces to be checked for state at the same time 2021-10-06 22:06:07 +00:00
integration_test.go Added TODO in waiting 2021-10-16 11:36:16 +02:00
LICENSE
machine.go Preload the Namespace from SharedMachines 2021-10-17 11:59:08 +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
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.go Solved merge 2021-10-17 23:59:44 +02:00
namespaces_test.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.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 Headscale is not capitalized 2021-10-21 20:48:29 +02: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 Add cli support for unsharing a node from a namespace. 2021-10-17 16:29:46 -04:00
sharing_test.go Apply some DRY to the sharing tests. 2021-10-18 17:52:38 -04:00
utils.go Resolve merge conflict 2021-08-13 10:33:19 +01:00
utils_test.go Do not issue "network" or "broadcast" addresses (0 or 255) 2021-08-03 10:06:42 +01:00

README.md

headscale

ci

An open source, self-hosted implementation of the Tailscale coordination server.

Join our Discord server for a chat.

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