History

Gabe Cook 56a7b1e349 Add SVG logos (#1286 )		2023-03-27 15:33:25 +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
logo	Add SVG logos (#1286 )	2023-03-27 15:33:25 +02:00
proposals	Initial proposal for better routing	2022-11-21 21:58:22 +01:00
README.md	Rename namespace to user in docs	2023-01-18 15:40:04 +01:00
acls.md	updated to ACL doc (#1278 )	2023-03-27 11:25:55 +02:00
android-client.md	add details on how to use the android app	2022-08-02 09:49:28 +03:00
dns-records.md	permalink in the limitations section to tailscale	2023-01-20 09:19:26 +01:00
exit-node.md	document running exit nodes	2023-03-19 11:02:01 +01:00
glossary.md	Rename namespace to user in docs	2023-01-18 15:40:04 +01:00
iOS-client.md	Update iOS compatibility and added iOS docs (#1264 )	2023-03-17 15:56:15 +01:00
oidc.md	Run prettier	2023-02-27 10:28:49 +01:00
remote-cli.md	Update remote-cli.md	2022-12-19 19:16:48 +01:00
reverse-proxy.md	Add hint for reverse proxying with Apache	2023-01-23 15:51:20 +01:00
running-headscale-container.md	Rename namespace to user in docs	2023-01-18 15:40:04 +01:00
running-headscale-linux.md	Update running-headscale-linux.md	2023-02-09 08:17:28 -05:00
running-headscale-openbsd.md	Fix OpenBSD build docs	2023-02-26 12:54:47 +01:00
tls.md	Remove mTLS from doc and config example	2022-11-19 19:50:34 +01: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 users (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 User borders are no longer applied. All machines whichever the User 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.