myriation/headscale
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity
headscale/docs/README.md

44 lines
1.4 KiB
Markdown
Raw Normal View History

Rewrite main documentation This commit starts restructuring the documentation and updating it to be compliant with 0.12.x+ releases. The main change is that the documentation has been rewritten for the ground up, and hopefully simplified. The documentation has been split into an official documentation for running headscale as a binary under Linux with SystemD and a "community" provided documentation for Docker. This should make the two documents a lot easier to read and follow than the mishmash document we had.
2022-01-02 11:11:36 -07:00
# headscale documentation
Add simple overview README for docs
2021-11-29 06:36:47 -07:00
Rewrite main documentation This commit starts restructuring the documentation and updating it to be compliant with 0.12.x+ releases. The main change is that the documentation has been rewritten for the ground up, and hopefully simplified. The documentation has been split into an official documentation for running headscale as a binary under Linux with SystemD and a "community" provided documentation for Docker. This should make the two documents a lot easier to read and follow than the mishmash document we had.
2022-01-02 11:11:36 -07: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,
please ask on [Discord](https://discord.gg/XcQxk2VHjx) instead of opening an Issue.
## Official documentation
### How-to
- [Running headscale on Linux](running-headscale-linux.md)
Add link from the docs readme
2022-02-11 11:39:41 -07:00
- [Using a Windows client with headscale](windows-client.md)
Rewrite main documentation This commit starts restructuring the documentation and updating it to be compliant with 0.12.x+ releases. The main change is that the documentation has been rewritten for the ground up, and hopefully simplified. The documentation has been split into an official documentation for running headscale as a binary under Linux with SystemD and a "community" provided documentation for Docker. This should make the two documents a lot easier to read and follow than the mishmash document we had.
2022-01-02 11:11:36 -07:00
### References
Link to example config from docs
2022-01-02 12:43:06 -07:00
- [Configuration](../config-example.yaml)
update case in readme
2022-01-02 12:39:51 -07:00
- [Glossary](glossary.md)
Link to example config from docs
2022-01-02 12:43:06 -07:00
- [TLS](tls.md)
Rewrite main documentation This commit starts restructuring the documentation and updating it to be compliant with 0.12.x+ releases. The main change is that the documentation has been rewritten for the ground up, and hopefully simplified. The documentation has been split into an official documentation for running headscale as a binary under Linux with SystemD and a "community" provided documentation for Docker. This should make the two documents a lot easier to read and follow than the mishmash document we had.
2022-01-02 11:11:36 -07: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**.
Fix typo
2022-01-02 16:17:48 -07:00
- [Running headscale in a container](running-headscale-container.md)
Remove outdated configuration page in favour of config-example
2022-01-02 12:42:35 -07: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
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.
### Apple devices
An endpoint with information on how to connect your Apple devices (currently macOS only) is available at `/apple` on your running instance.
Copy permalink