History

Juan Font Alonso dd3ec84000 Minor doc change		2022-09-03 12:22:03 +02:00
..
examples	Metrics: Disable toggle. Set default port to 9090	2022-02-28 10:40:02 -03:00
images	Docs/ACLs: Add a network diagram to help explain ACLs	2022-03-17 19:58:56 -03:00
proposals	docs(acls-proposal): wording comment	2022-02-16 09:16:25 +01:00
README.md	add openbsd doc	2022-06-05 15:45:38 +08:00
acls.md	typo fixed from advertised to advertise	2022-08-05 15:44:11 -04:00
android-client.md	add details on how to use the android app	2022-08-02 09:49:28 +03:00
glossary.md	Update readme and glossary to reflect features and goals	2022-02-25 10:34:35 +01:00
remote-cli.md	fixed typo	2022-05-07 16:23:26 -04:00
running-headscale-container.md	Noise private key now a nested field in config	2022-08-21 10:42:23 +02:00
running-headscale-linux.md	expanded arguments in useradd to be easier to understand for beginners	2022-04-21 11:00:17 +02:00
running-headscale-openbsd.md	Minor doc change	2022-09-03 12:22:03 +02:00
tls.md	Sort lint	2022-02-24 11:10:40 +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.

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.