1
0
mirror of https://github.com/juanfont/headscale.git synced 2024-12-20 19:09:07 +01:00
An open source, self-hosted implementation of the Tailscale control server
Go to file
Adrien Raffin-Caboisse b3d0fb7a93 fix(machine): revert modifications
Using h.ListAllMachines also listed the current machine in the result. It's unnecessary (I don't know if it's harmful).

Breaking the check with the `matchSourceAndDestinationWithRule` broke the tests. We have a specificity with the '*' destination that isn't symetrical.
I need to think of a better way to do this. It too hard to read.
2022-02-20 23:47:04 +01:00
.github github/workflows: set specific go version 2022-02-14 21:31:49 +01:00
cmd/headscale Allow gRPC server to run insecure 2022-02-13 09:08:46 +00:00
docs chore(fmt): apply make fmt command 2022-02-17 09:32:54 +01:00
gen Generate code from proto 2022-01-25 22:11:15 +00:00
integration_test integration-test: add IPv6 prefix to configuration 2022-01-16 14:18:22 +01:00
proto Add proto model for api key 2022-01-25 22:11:15 +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 Add log_level to config, more ACL debug log 2021-12-01 20:02:00 +01:00
.golangci.yaml Fix prettier 2021-11-24 10:47:20 +00:00
.goreleaser.yml Fix type according to config schema 2022-01-30 08:59:25 +00:00
acls_test.go fix(tests): fix naming issues related to code review 2022-02-20 23:00:31 +01:00
acls_types.go Add and fix stylecheck (golint replacement) 2021-11-15 17:24:24 +00:00
acls.go fix(acls,machines): apply code review suggestions 2022-02-20 21:26:20 +01:00
api_key_test.go Add api key data model and helpers 2022-01-25 22:11:05 +00:00
api_key.go Add api key data model and helpers 2022-01-25 22:11:05 +00:00
api.go chore(all): update some files for linter 2022-02-17 09:32:51 +01:00
app_test.go Add support for multiple IP prefixes 2022-01-16 14:18:22 +01:00
app.go Merge branch 'main' into apiwork 2022-02-14 22:29:20 +00:00
apple_mobileconfig.go Template Fixes 2021-12-22 19:43:53 -07:00
buf.gen.yaml Create an initial gRPC service 2021-10-26 20:37:37 +00:00
CHANGELOG.md Apply suggestions from code review on changelog 2022-02-20 20:47:12 +01:00
cli_test.go Add support for multiple IP prefixes 2022-01-16 14:18:22 +01:00
config-example.yaml Allow gRPC server to run insecure 2022-02-13 09:08:46 +00:00
db.go Simplify postgres uuid-ossp stirng 2022-01-30 14:53:40 +00:00
derp-example.yaml fix(derp-example): change regionid in nodes 2021-11-24 15:54:22 +01:00
derp.go Add and fix stylecheck (golint replacement) 2021-11-15 17:24:24 +00:00
dns_test.go Formatting of DNS files 2022-01-25 22:11:15 +00:00
dns.go chore(lint): more lint fixing 2022-02-17 09:32:54 +01:00
Dockerfile Dockerfiles: update go version to 1.17.7 2022-02-14 21:32:20 +01:00
Dockerfile.alpine Dockerfiles: update go version to 1.17.7 2022-02-14 21:32:20 +01:00
Dockerfile.debug Dockerfiles: update go version to 1.17.7 2022-02-14 21:32:20 +01:00
Dockerfile.tailscale integration-test: taildrop test refactor 2022-01-16 14:18:22 +01:00
go.mod Upgrade all dependencies 2022-02-11 08:43:31 +00:00
go.sum Upgrade all dependencies 2022-02-11 08:43:31 +00:00
grpcv1.go Create helper functions around gRPC interface 2022-01-25 22:11:15 +00:00
integration_cli_test.go Add apikeys command integration test 2022-01-25 22:11:15 +00:00
integration_common_test.go Formatting of integration tests 2022-01-25 22:11:15 +00:00
integration_test.go Upgrade to tailscale 1.20.4 2022-02-11 08:39:00 +00:00
LICENSE Initial commit 2020-06-21 11:21:07 +02:00
machine_test.go chore(fmt): apply make fmt command 2022-02-17 09:32:54 +01:00
machine.go fix(machine): revert modifications 2022-02-20 23:47:04 +01:00
Makefile PollNetMapHandler: refactor with chan lifetimes in mind 2022-01-16 14:18:22 +01:00
metrics.go Go format with shorter lines 2021-11-13 08:36:45 +00:00
namespaces_test.go Add support for multiple IP prefixes 2022-01-16 14:18:22 +01:00
namespaces.go Remove RequestMapUpdates function 2022-02-12 21:04:00 +00:00
oidc_test.go Remove non-existing field from oidc test 2021-11-28 09:25:27 +00:00
oidc.go Add support for multiple IP prefixes 2022-01-16 14:18:22 +01:00
poll.go chore(fmt): apply make fmt command 2022-02-17 09:32:54 +01:00
preauth_keys_test.go Make "authKey" a constant 2021-11-18 08:49:55 +00:00
preauth_keys.go Get rid of dynamic errors 2021-11-15 19:18:14 +00:00
README.md Update README.md 2022-02-17 17:55:40 -08:00
routes_test.go Make "authKey" a constant 2021-11-18 08:49:55 +00:00
routes.go Remove RequestMapUpdates function 2022-02-12 21:04:00 +00:00
sharing_test.go Add support for multiple IP prefixes 2022-01-16 14:18:22 +01:00
sharing.go Remove RequestMapUpdates function 2022-02-12 21:04:00 +00:00
swagger.go Template Fixes 2021-12-22 19:43:53 -07:00
tools.go Create an initial gRPC service 2021-10-26 20:37:37 +00:00
utils_test.go Add support for multiple IP prefixes 2022-01-16 14:18:22 +01:00
utils.go chore(lint): more lint fixing 2022-02-17 09:32:54 +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 NAT traversal.

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.

Support

If you like headscale and find it useful, there is 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.

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 docs
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 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).

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:
make install-protobuf-plugins

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:

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