mirror of https://github.com/juanfont/headscale.git synced 2024-12-20 19:09:07 +01:00

Restructure headscale documentation (#2163 )

* Setup mkdocs-redirects

* Restructure existing documentation

* Move client OS support into the documentation

* Move existing Client OS support table into its own documentation page
* Link from README.md to the rendered documentation
* Document minimum Tailscale client version

* Reuse CONTRIBUTING.md" in the documentation

* Include "CONTRIBUTING.md" from the repository root
* Update FAQ and index page and link to the contributing docs

* Add configuration reference

* Add a getting started page and explain the first steps with headscale

* Use the existing "Using headscale" sections and combine them into a
  single getting started guide with a little bit more explanation.
* Explain how to get help from the command line client.
* Remove duplicated sections from existing installation guides

* Document requirements and assumptions

* Document packages provided by the community

* Move deb install guide to official releases

* Move manual install guide to official releases

* Move container documentation to setup section

* Move sealos documentation to cloud install page

* Move OpenBSD docs to build from source

* Simplify DNS documentation

* Add sponsor page

* Add releases page

* Add features page

* Add help page

* Add upgrading page

* Adjust mkdocs nav

* Update wording

Use the term headscale for the project, Headscale on the beginning of a
sentence and `headscale` when refering to the CLI.

* Welcome to headscale

* Link to existing documentation in the FAQ

* Remove the goal header and use the text as opener

* Indent code block in OIDC

* Make a few pages linter compatible

Also update ignored files for prettier

* Recommend HTTPS on port 443

Fixes: #2164

* Use hosts in acl documentation

thx @efficacy38 for noticing this

Ref: #1863

* Use mkdocs-macros to set headscale version once

2024-10-10 15:24:04 +02:00

1.5 KiB

Raw Blame History

Headscale web interface

!!! warning "Community contributions"

This page contains community contributions. The projects listed here are not
maintained by the headscale authors and are written by community members.

Name	Repository Link	Description	Status
headscale-webui	Github	A simple headscale web UI for small-scale deployments.	Alpha
headscale-ui	Github	A web frontend for the headscale Tailscale-compatible coordination server	Alpha
HeadscaleUi	GitHub	A static headscale admin ui, no backend enviroment required	Alpha
headscale-admin	Github	Headscale-Admin is meant to be a simple, modern web interface for headscale	Beta
ouroboros	Github	Ouroboros is designed for users to manage their own devices, rather than for admins	Stable

You can ask for support on our dedicated Discord channel.

1.5 KiB Raw Blame History

Headscale web interface

1.5 KiB

Raw Blame History