2022-01-03 02:11:36 +08:00
|
|
|
# headscale documentation
|
2021-11-29 21:36:47 +08:00
|
|
|
|
2022-01-03 02:11:36 +08:00
|
|
|
This page contains the official and community contributed documentation for `headscale`.
|
|
|
|
|
|
|
|
|
|
If you are having trouble with following the documentation or get unexpected results,
|
2022-04-21 16:06:30 +08:00
|
|
|
please ask on [Discord](https://discord.gg/c84AZQhmpx) instead of opening an Issue.
|
2022-01-03 02:11:36 +08:00
|
|
|
|
|
|
|
|
## Official documentation
|
|
|
|
|
|
|
|
|
|
### How-to
|
|
|
|
|
|
|
|
|
|
- [Running headscale on Linux](running-headscale-linux.md)
|
2022-02-20 01:14:51 +08:00
|
|
|
- [Control headscale remotely](remote-cli.md)
|
2022-02-12 02:39:41 +08:00
|
|
|
- [Using a Windows client with headscale](windows-client.md)
|
2023-01-03 22:06:00 +08:00
|
|
|
- [Configuring OIDC](oidc.md)
|
2022-01-03 02:11:36 +08:00
|
|
|
|
|
|
|
|
### References
|
|
|
|
|
|
2022-01-03 03:43:06 +08:00
|
|
|
- [Configuration](../config-example.yaml)
|
2022-01-03 03:39:51 +08:00
|
|
|
- [Glossary](glossary.md)
|
2022-01-03 03:43:06 +08:00
|
|
|
- [TLS](tls.md)
|
2022-01-03 02:11:36 +08:00
|
|
|
|
|
|
|
|
## 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**.
|
|
|
|
|
|
2022-01-03 07:17:48 +08:00
|
|
|
- [Running headscale in a container](running-headscale-container.md)
|
2022-06-05 15:45:38 +08:00
|
|
|
- [Running headscale on OpenBSD](running-headscale-openbsd.md)
|
2022-09-05 00:42:23 +08:00
|
|
|
- [Running headscale behind a reverse proxy](reverse-proxy.md)
|
2022-12-31 19:08:55 +08:00
|
|
|
- [Set Custom DNS records](dns-records.md)
|
2022-01-03 03:42:35 +08:00
|
|
|
|
|
|
|
|
## 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
|
2023-01-18 02:03:40 +08:00
|
|
|
use users (which are the equivalent to user/logins in Tailscale.com).
|
2022-01-03 03:42:35 +08:00
|
|
|
|
|
|
|
|
Please check https://tailscale.com/kb/1018/acls/, and `./tests/acls/` in this repo for working examples.
|
|
|
|
|
|
2023-01-18 02:03:40 +08:00
|
|
|
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
|
2022-02-14 20:54:44 +08:00
|
|
|
long as the ACL's permits this exchange.
|
|
|
|
|
|
|
|
|
|
The [ACLs](acls.md) 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.
|
|
|
|
|
|
2022-01-03 03:42:35 +08:00
|
|
|
### Apple devices
|
|
|
|
|
|
|
|
|
|
An endpoint with information on how to connect your Apple devices (currently macOS only) is available at `/apple` on your running instance.
|
