headscale/docs/README.md
Kristoffer Dalby f9e6722635 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 19:11:36 +01:00

816 B

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.