2022-01-02 18:11:36 +00:00
|
|
|
# headscale documentation
|
2021-11-29 13:36:47 +00:00
|
|
|
|
2022-01-02 18:11:36 +00: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 08:06:30 +00:00
|
|
|
please ask on [Discord](https://discord.gg/c84AZQhmpx) instead of opening an Issue.
|
2022-01-02 18:11:36 +00:00
|
|
|
|
|
|
|
|
## Official documentation
|
|
|
|
|
|
|
|
|
|
### How-to
|
|
|
|
|
|
|
|
|
|
- [Running headscale on Linux](running-headscale-linux.md)
|
2022-02-19 17:14:51 +00:00
|
|
|
- [Control headscale remotely](remote-cli.md)
|
2022-02-11 18:39:41 +00:00
|
|
|
- [Using a Windows client with headscale](windows-client.md)
|
2023-01-03 14:06:00 +00:00
|
|
|
- [Configuring OIDC](oidc.md)
|
2022-01-02 18:11:36 +00:00
|
|
|
|
|
|
|
|
### References
|
|
|
|
|
|
2022-01-02 19:43:06 +00:00
|
|
|
- [Configuration](../config-example.yaml)
|
2022-01-02 19:39:51 +00:00
|
|
|
- [Glossary](glossary.md)
|
2022-01-02 19:43:06 +00:00
|
|
|
- [TLS](tls.md)
|
2022-01-02 18:11:36 +00: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-02 23:17:48 +00:00
|
|
|
- [Running headscale in a container](running-headscale-container.md)
|
2022-06-05 07:45:38 +00:00
|
|
|
- [Running headscale on OpenBSD](running-headscale-openbsd.md)
|
2022-09-04 16:42:23 +00:00
|
|
|
- [Running headscale behind a reverse proxy](reverse-proxy.md)
|
2022-12-31 11:08:55 +00:00
|
|
|
- [Set Custom DNS records](dns-records.md)
|
2022-01-02 19:42:35 +00: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-17 18:03:40 +00:00
|
|
|
use users (which are the equivalent to user/logins in Tailscale.com).
|
2022-01-02 19:42:35 +00:00
|
|
|
|
|
|
|
|
Please check https://tailscale.com/kb/1018/acls/, and `./tests/acls/` in this repo for working examples.
|
|
|
|
|
|
2023-01-17 18:03:40 +00: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 12:54:44 +00: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-02 19:42:35 +00: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.
|
