fc65ded2d5
|
||
|---|---|---|
| .github | ||
| cmd/headscale | ||
| docs | ||
| gen | ||
| integration_test | ||
| proto | ||
| tests/acls | ||
| .dockerignore | ||
| .envrc | ||
| .gitignore | ||
| .golangci.yaml | ||
| .goreleaser.yml | ||
| CHANGELOG.md | ||
| Dockerfile | ||
| Dockerfile.alpine | ||
| Dockerfile.debug | ||
| Dockerfile.tailscale | ||
| Dockerfile.tailscale-HEAD | ||
| LICENSE | ||
| Makefile | ||
| README.md | ||
| acls.go | ||
| acls_test.go | ||
| acls_types.go | ||
| api.go | ||
| api_key.go | ||
| api_key_test.go | ||
| app.go | ||
| app_test.go | ||
| buf.gen.yaml | ||
| config-example.yaml | ||
| config.go | ||
| db.go | ||
| derp-example.yaml | ||
| derp.go | ||
| derp_server.go | ||
| dns.go | ||
| dns_test.go | ||
| flake.lock | ||
| flake.nix | ||
| go.mod | ||
| go.sum | ||
| grpcv1.go | ||
| grpcv1_test.go | ||
| integration_cli_test.go | ||
| integration_common_test.go | ||
| integration_embedded_derp_test.go | ||
| integration_general_test.go | ||
| machine.go | ||
| machine_test.go | ||
| metrics.go | ||
| namespaces.go | ||
| namespaces_test.go | ||
| oidc.go | ||
| platform_config.go | ||
| poll.go | ||
| preauth_keys.go | ||
| preauth_keys_test.go | ||
| routes.go | ||
| routes_test.go | ||
| swagger.go | ||
| utils.go | ||
| utils_test.go | ||
README.md
headscale
An open source, self-hosted implementation of the Tailscale control 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.
What is Tailscale
Tailscale is a modern VPN built on top of Wireguard. It works like an overlay network between the computers of your networks - using NAT traversal.
Everything in Tailscale is Open Source, except the GUI clients for proprietary OS (Windows and macOS/iOS), and the control server.
The control server works as an exchange point of Wireguard public keys for the nodes in the Tailscale network. It 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.
A Tailscale network (tailnet) is private network which Tailscale assigns to a user in terms of private users or an organisation.
Design goal
headscale aims to implement a self-hosted, open source alternative to the Tailscale
control server. headscale has a narrower scope and an instance of headscale
implements a single Tailnet, which is typically what a single organisation, or
home/personal setup would use.
headscale uses terms that maps to Tailscale's control server, consult the
glossary for explainations.
Support
If you like headscale and find it useful, there is a sponsorship and donation
buttons available in the repo.
If you would like to sponsor features, bugs or prioritisation, reach out to one of the maintainers.
Features
- Full "base" support of Tailscale's features
- Configurable DNS
- Node registration
- Single-Sign-On (via Open ID Connect)
- Pre authenticated key
- Taildrop (File Sharing)
- Access control lists
- MagicDNS
- Support for multiple IP ranges in the tailnet
- Dual stack (IPv4 and IPv6)
- Routing advertising (including exit nodes)
- Ephemeral nodes
- Embedded DERP server
Client OS support
| OS | Supports headscale |
|---|---|
| Linux | Yes |
| OpenBSD | Yes |
| FreeBSD | Yes |
| macOS | Yes (see /apple on your headscale for more information) |
| Windows | Yes docs |
| Android | You need to compile the client yourself |
| iOS | Not yet |
Running headscale
Please have a look at the documentation under docs/.
Disclaimer
- We have nothing to do with Tailscale, or Tailscale Inc.
- The purpose of Headscale is maintaining a working, self-hosted Tailscale control panel.
Contributing
To contribute to headscale you would need the lastest version of Go and Buf(Protobuf generator).
We recommend using Nix to setup a development environment. This can
be done with nix develop, which will install the tools and give you a shell.
This guarantees that you will have the same dev env as headscale maintainers.
PRs and suggestions are welcome.
Code style
To ensure we have some consistency with a growing number of contributions, this project has adopted linting and style/formatting rules:
The Go code is linted with golangci-lint and
formatted with golines (width 88) and
gofumpt.
Please configure your editor to run the tools while developing and make sure to
run make lint and make fmt before committing any code.
The Proto code is linted with buf and
formatted with clang-format.
The rest (Markdown, YAML, etc) is formatted with prettier.
Check out the .golangci.yaml and Makefile to see the specific configuration.
Install development tools
- Go
- Buf
- Protobuf tools
Install and activate:
nix develop
Testing and building
Some parts of the project require the generation of Go code from Protobuf
(if changes are 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:
nix build
or
make build
