Skip to content

Files

Latest commit

913a94d · Aug 9, 2022

History

History
This branch is 1259 commits behind juanfont/headscale:main.

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Feb 28, 2022
Mar 17, 2022
Feb 16, 2022
Jun 5, 2022
Aug 5, 2022
Aug 2, 2022
Feb 25, 2022
May 7, 2022
Mar 28, 2022
Apr 21, 2022
Jun 11, 2022
Feb 24, 2022
Feb 11, 2022

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.

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.