2021-10-10 12:00:45 +01:00
# headscale
2021-04-24 21:26:38 +00:00
2021-10-10 12:00:45 +01:00
2021-04-24 21:26:38 +00:00
2021-07-03 16:10:22 +02:00
An open source, self-hosted implementation of the Tailscale coordination server.
2020-06-21 11:58:25 +02:00
2021-10-10 12:00:45 +01:00
Join our [Discord ](https://discord.gg/XcQxk2VHjx ) server for a chat.
2021-03-17 21:58:38 +01:00
## Overview
2021-05-08 16:56:27 +02:00
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 all kinds of [NAT traversal sorcery ](https://tailscale.com/blog/how-nat-traversal-works/ ).
2021-03-17 21:58:38 +01:00
2021-05-08 16:56:27 +02:00
Everything in Tailscale is Open Source, except the GUI clients for proprietary OS (Windows and macOS/iOS), and the 'coordination/control server'.
2021-03-17 21:58:38 +01:00
2021-07-03 12:01:19 +02:00
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.
2021-03-17 21:58:38 +01:00
2021-10-21 20:48:29 +02:00
headscale implements this coordination server.
2020-06-21 11:58:25 +02:00
2021-02-24 22:23:36 +01:00
## Status
2021-07-03 12:01:19 +02:00
- [x] Base functionality (nodes can communicate with each other)
2021-02-24 22:23:36 +01:00
- [x] Node registration through the web flow
2021-09-19 12:07:17 +02:00
- [x] Network changes are relayed to the nodes
2021-10-21 20:48:29 +02:00
- [x] Namespaces support (~tailnets in Tailscale.com naming)
2021-07-03 12:01:19 +02:00
- [x] Routing (advertise & accept, including exit nodes)
- [x] Node registration via pre-auth keys (including reusable keys, and ephemeral node support)
2021-09-26 20:47:39 +01:00
- [x] JSON-formatted output
- [x] ACLs
2021-09-26 20:51:07 +01:00
- [x] Taildrop (File Sharing)
2021-09-26 20:47:39 +01:00
- [x] Support for alternative IP ranges in the tailnets (default Tailscale's 100.64.0.0/10)
- [x] DNS (passing DNS servers to nodes)
2021-10-19 21:01:36 +02:00
- [x] Share nodes between namespaces
2021-10-04 20:27:45 +02:00
- [x] MagicDNS (see `docs/` )
2021-02-24 22:23:36 +01:00
2021-10-04 14:58:36 +03:00
## Client OS support
2021-10-04 20:27:45 +02:00
| OS | Supports headscale |
| ------- | ----------------------------------------------------------------------------------------------------------------- |
| Linux | Yes |
| OpenBSD | Yes |
| macOS | Yes (see `/apple` on your headscale for more information) |
| Windows | Yes |
2021-10-04 14:58:36 +03:00
| Android | [You need to compile the client yourself ](https://github.com/juanfont/headscale/issues/58#issuecomment-885255270 ) |
2021-10-04 20:27:45 +02:00
| iOS | Not yet |
2021-10-04 14:58:36 +03:00
2021-02-24 22:23:36 +01:00
## Roadmap 🤷
Suggestions/PRs welcomed!
2020-06-21 11:58:25 +02:00
2021-07-11 13:04:33 +02:00
2021-10-19 21:02:45 +02:00
## Running headscale
2021-10-19 23:22:56 +02:00
Please have a look at the documentation under [`docs/` ](docs/ ).
2021-10-19 21:02:45 +02:00
2021-02-24 22:23:36 +01:00
## Disclaimer
2021-05-08 16:56:27 +02:00
1. We have nothing to do with Tailscale, or Tailscale Inc.
2021-02-24 22:23:36 +01:00
2. The purpose of writing this was to learn how Tailscale works.
2021-05-08 14:12:22 +02:00
2021-10-21 20:36:26 +02:00
## Contributors
2021-10-19 20:59:33 +02:00
