History

Kristoffer Dalby ecb3ee6bfa Merge branch 'main' into feat-improve-acls-usage		2022-02-21 08:51:21 +00:00
..
examples	Add eradme to examples	2022-01-02 20:08:04 +01:00
images	Improve the windows client docs as per discord recommendations	2022-02-11 18:36:53 +00:00
README.md	Merge branch 'main' into feat-improve-acls-usage	2022-02-21 08:51:21 +00:00
acls.md	chore(fmt): apply make fmt command	2022-02-17 09:32:54 +01:00
glossary.md	Lowercase markdown docs	2022-01-02 19:39:03 +00:00
remote-cli.md	Add note about running grpc behind a proxy and combining ports	2022-02-13 09:48:33 +00:00
running-headscale-container.md	prettier: Docker docs	2022-01-06 17:25:07 +08:00
running-headscale-linux.md	Forgot to run Prettier	2022-02-01 19:32:13 -05:00
tls.md	Lowercase markdown docs	2022-01-02 19:39:03 +00:00
windows-client.md	Improve the windows client docs as per discord recommendations	2022-02-11 18:36:53 +00:00

README.md

headscale documentation

This page contains the official and community contributed documentation for headscale.

If you are having trouble with following the documentation or get unexpected results, please ask on Discord instead of opening an Issue.

Official documentation

How-to

References

Community documentation

Community documentation is not actively maintained by the headscale authors and is written by community members. It is not verified by headscale developers.

It might be outdated and it might miss necessary steps.

Running headscale in a container

Misc

Policy ACLs

Headscale implements the same policy ACLs as Tailscale.com, adapted to the self-hosted environment.

For instance, instead of referring to users when defining groups you must use namespaces (which are the equivalent to user/logins in Tailscale.com).

Please check https://tailscale.com/kb/1018/acls/, and ./tests/acls/ in this repo for working examples.

When using ACL's the Namespace borders are no longer applied. All machines whichever the Namespace have the ability to communicate with other hosts as long as the ACL's permits this exchange.

The ACLs document should help understand a fictional case of setting up ACLs in a small company. All concepts presented in this document could be applied outside of business oriented usage.

Apple devices

An endpoint with information on how to connect your Apple devices (currently macOS only) is available at /apple on your running instance.