TheArchive/headscale
1
0
Fork 0
mirror of https://github.com/juanfont/headscale.git synced 2024-11-23 18:15:26 +00:00
Code Issues Packages Projects Releases Wiki Activity
An open source, self-hosted implementation of the Tailscale control server
57 Commits 52 Branches 130 Tags 30 MiB
Go 97.6%
HTML 1.5%
Nix 0.6%
Shell 0.2%
Makefile 0.1%
683b151f19
Go to file
Ward Vandewege 683b151f19 If the configuration file contains relative paths (e.g. in the values 
for private_key_path or derp_map_path), interpret them as relative to
the directory where the config.json file was read from.
2021-04-22 21:10:50 -04:00
cmd/headscale If the configuration file contains relative paths (e.g. in the values 2021-04-22 21:10:50 -04:00
docker added dockerfile 2020-07-27 22:07:23 +10:00
.gitignore Fixed gitignore 2021-02-21 01:31:50 +01:00
api.go Minor fix on already defer db close 2021-04-22 23:55:07 +02:00
app.go Minor code reorg 2021-04-08 23:57:31 +02:00
cli.go Minor code reorg 2021-04-08 23:57:31 +02:00
config.json.example If the configuration file contains relative paths (e.g. in the values 2021-04-22 21:10:50 -04:00
db.go WIP on PreAuthKeys 2021-04-23 00:25:01 +02:00
derp.yaml Load DERP servers from file 2021-02-20 23:57:06 +01:00
go.mod Create preauthkeys kinda working (not usable yet) 2021-04-23 00:40:42 +02:00
go.sum Create preauthkeys kinda working (not usable yet) 2021-04-23 00:40:42 +02:00
LICENSE Initial commit 2020-06-21 11:21:07 +02:00
machine.go Removed log message 2021-03-17 23:09:45 +01:00
namespaces.go Initial multi-user support using namespaces 2021-02-28 00:58:09 +01:00
preauth_keys.go WIP on PreAuthKeys 2021-04-23 00:25:01 +02:00
README.md Minor readme fixes 2021-03-18 23:02:36 +00:00
utils.go Seed the random IP address generator 2021-02-21 22:11:27 +01:00

README.md

Headscale

An open source implementation of the Tailscale coordination server.

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 cryptographic 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

  • Basic functionality (nodes can communicate with each other)
  • Node registration through the web flow
  • Network changes are relied to the nodes
  • Multiuser Namespace support
  • Basic routing (advertise & accept)
  • Share nodes between users namespaces
  • Node registration via pre-auth keys
  • ACLs
  • DNS

... and probably lots of stuff missing

Roadmap 🤷

Basic multiuser support (multinamespace, actually) is now implemented. No node sharing or ACLs between namespaces yet though...

Pre-auth keys should also be feasible.

Suggestions/PRs welcomed!

Running it

  1. Compile the headscale binary
go build cmd/headscale/headscale.go
  1. Get youself a PostgreSQL DB running (yes, I know)
docker run --name headscale -e POSTGRES_DB=headscale -e \
  POSTGRES_USER=foo -e POSTGRES_PASSWORD=bar -p 5432:5432 -d postgres
  1. Sort some stuff up (headscale Wireguard keys & the config.json file)
wg genkey > private.key
wg pubkey < private.key > public.key  # not needed 
cp config.json.example config.json
  1. Create a namespace (equivalent to a user in tailscale.com)
./headscale namespace create myfirstnamespace
  1. Run the server
./headscale serve
  1. Add your first machine
tailscale up -login-server YOUR_HEADSCALE_URL

  1. Navigate to the URL you will get with tailscale up, where you'll find your machine key.

  2. In the server, register your machine to a namespace with the CLI

./headscale register YOURMACHINEKEY myfirstnamespace

Disclaimer

  1. I have nothing to do with Tailscale, or Tailscale Inc.
  2. The purpose of writing this was to learn how Tailscale works.
  3. I don't use Headscale myself.