History

Adrien Raffin-Caboisse e540679dbd docs(acl-proposals): integrate comments		2022-02-15 09:52:05 +01:00
..
examples	Add eradme to examples	2022-01-02 20:08:04 +01:00
proposals	docs(acl-proposals): integrate comments	2022-02-15 09:52:05 +01:00
README.md	Fix typo	2022-01-02 23:17:48 +00:00
glossary.md	Lowercase markdown docs	2022-01-02 19:39:03 +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

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

Running headscale on Linux

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.

Apple devices

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