-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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
- Loading branch information
Showing
41 changed files
with
867 additions
and
942 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,2 @@ | ||
| .github/workflows/test-integration-v2* | ||
| docs/dns-records.md | ||
| docs/running-headscale-container.md | ||
| docs/running-headscale-linux-manual.md | ||
| docs/running-headscale-linux.md | ||
| docs/running-headscale-openbsd.md | ||
| docs/about/features.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| # Client and operating system support | ||
|
|
||
| We aim to support the [**last 10 releases** of the Tailscale client](https://tailscale.com/changelog#client) on all | ||
| provided operating systems and platforms. Some platforms might require additional configuration to connect with | ||
| headscale. | ||
|
|
||
| | OS | Supports headscale | | ||
| | ------- | ----------------------------------------------------------------------------------------------------- | | ||
| | Linux | Yes | | ||
| | OpenBSD | Yes | | ||
| | FreeBSD | Yes | | ||
| | Windows | Yes (see [docs](../usage/connect/windows.md) and `/windows` on your headscale for more information) | | ||
| | Android | Yes (see [docs](../usage/connect/android.md)) | | ||
| | macOS | Yes (see [docs](../usage/connect/apple.md#macos) and `/apple` on your headscale for more information) | | ||
| | iOS | Yes (see [docs](../usage/connect/apple.md#ios) and `/apple` on your headscale for more information) | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| {% | ||
| include-markdown "../../CONTRIBUTING.md" | ||
| %} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| # Features | ||
|
|
||
| Headscale aims to implement a self-hosted, open source alternative to the Tailscale control server. Headscale's goal is | ||
| to provide self-hosters and hobbyists with an open-source server they can use for their projects and labs. This page | ||
| provides on overview of headscale's feature and compatibility with the Tailscale control server: | ||
|
|
||
| - [x] Full "base" support of Tailscale's features | ||
| - [x] Node registration | ||
| - [x] Interactive | ||
| - [x] Pre authenticated key | ||
| - [x] [DNS](https://tailscale.com/kb/1054/dns) | ||
| - [x] [MagicDNS](https://tailscale.com/kb/1081/magicdns) | ||
| - [x] [Global and restricted nameservers (split DNS)](https://tailscale.com/kb/1054/dns#nameservers) | ||
| - [x] [search domains](https://tailscale.com/kb/1054/dns#search-domains) | ||
| - [x] [Extra DNS records (headscale only)](../ref/dns.md#setting-custom-dns-records) | ||
| - [x] [Taildrop (File Sharing)](https://tailscale.com/kb/1106/taildrop) | ||
| - [x] Routing advertising (including exit nodes) | ||
| - [x] Dual stack (IPv4 and IPv6) | ||
| - [x] Ephemeral nodes | ||
| - [x] Embedded [DERP server](https://tailscale.com/kb/1232/derp-servers) | ||
| - [x] Access control lists ([GitHub label "policy"](https://github.com/juanfont/headscale/labels/policy%20%F0%9F%93%9D)) | ||
| - [x] ACL management via API | ||
| - [x] `autogroup:internet` | ||
| - [ ] `autogroup:self` | ||
| - [ ] `autogroup:member` | ||
| * [ ] Node registration using Single-Sign-On (OpenID Connect) ([GitHub label "OIDC"](https://github.com/juanfont/headscale/labels/OIDC)) | ||
| - [x] Basic registration | ||
| - [ ] Dynamic ACL support | ||
| - [ ] OIDC groups cannot be used in ACLs | ||
| - [ ] [Funnel](https://tailscale.com/kb/1223/funnel) ([#1040](https://github.com/juanfont/headscale/issues/1040)) | ||
| - [ ] [Serve](https://tailscale.com/kb/1312/serve) ([#1234](https://github.com/juanfont/headscale/issues/1921)) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| # Getting help | ||
|
|
||
| Join our Discord server for announcements and community support: | ||
|
|
||
| - [announcements](https://discord.com/channels/896711691637780480/896711692120129538) | ||
| - [general](https://discord.com/channels/896711691637780480/896711692120129540) | ||
| - [docker-issues](https://discord.com/channels/896711691637780480/1070619770942148618) | ||
| - [reverse-proxy-issues](https://discord.com/channels/896711691637780480/1070619818346164324) | ||
| - [web-interfaces](https://discord.com/channels/896711691637780480/1105842846386356294) | ||
|
|
||
| Please report bugs via [GitHub issues](https://github.com/juanfont/headscale/issues) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| # Releases | ||
|
|
||
| All headscale releases are available on the [GitHub release page](https://github.com/juanfont/headscale/releases). Those | ||
| releases are available as binaries for various platforms and architectures, packages for Debian based systems and source | ||
| code archives. Container images are available on [Docker Hub](https://hub.docker.com/r/headscale/headscale). | ||
|
|
||
| An Atom/RSS feed of headscale releases is available [here](https://github.com/juanfont/headscale/releases.atom). | ||
|
|
||
| Join the ["announcements" channel on Discord](https://discord.com/channels/896711691637780480/896711692120129538) for | ||
| news about headscale. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| # Sponsor | ||
|
|
||
| If you like to support the development of headscale, please consider a donation via | ||
| [ko-fi.com/headscale](https://ko-fi.com/headscale). Thank you! |
This file was deleted.
Oops, something went wrong.
Binary file not shown.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| # Configuration | ||
|
|
||
| - Headscale loads its configuration from a YAML file | ||
| - It searches for `config.yaml` in the following paths: | ||
| - `/etc/headscale` | ||
| - `$HOME/.headscale` | ||
| - the current working directory | ||
| - Use the command line flag `-c`, `--config` to load the configuration from a different path | ||
| - Validate the configuration file with: `headscale configtest` | ||
|
|
||
| !!! example "Get the [example configuration from the GitHub repository](https://github.com/juanfont/headscale/blob/main/config-example.yaml)" | ||
|
|
||
| Always select the [same GitHub tag](https://github.com/juanfont/headscale/tags) as the released version you use to | ||
| ensure you have the correct example configuration. The `main` branch might contain unreleased changes. | ||
|
|
||
| === "View on GitHub" | ||
|
|
||
| * Development version: <https://github.com/juanfont/headscale/blob/main/config-example.yaml> | ||
| * Version {{ headscale.version }}: <https://github.com/juanfont/headscale/blob/v{{ headscale.version }}/config-example.yaml> | ||
|
|
||
| === "Download with `wget`" | ||
|
|
||
| ```shell | ||
| # Development version | ||
| wget -O config.yaml https://raw.githubusercontent.com/juanfont/headscale/main/config-example.yaml | ||
|
|
||
| # Version {{ headscale.version }} | ||
| wget -O config.yaml https://raw.githubusercontent.com/juanfont/headscale/v{{ headscale.version }}/config-example.yaml | ||
| ``` | ||
|
|
||
| === "Download with `curl`" | ||
|
|
||
| ```shell | ||
| # Development version | ||
| curl -o config.yaml https://raw.githubusercontent.com/juanfont/headscale/main/config-example.yaml | ||
|
|
||
| # Version {{ headscale.version }} | ||
| curl -o config.yaml https://raw.githubusercontent.com/juanfont/headscale/v{{ headscale.version }}/config-example.yaml | ||
| ``` |
Oops, something went wrong.