From e13f0458bb2f53360aa9d005cddf0c9848252df4 Mon Sep 17 00:00:00 2001 From: Florian Preinstorfer Date: Sun, 19 Apr 2026 13:59:14 +0200 Subject: [PATCH] Remove redundant prefix --- docs/index.md | 2 +- docs/ref/debug.md | 4 ++-- docs/ref/derp.md | 8 ++++---- docs/ref/dns.md | 10 +++++----- docs/ref/routes.md | 2 +- docs/setup/install/community.md | 2 +- docs/setup/install/main.md | 4 ++-- docs/setup/install/official.md | 2 +- 8 files changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/index.md b/docs/index.md index 890855b9..a1765271 100644 --- a/docs/index.md +++ b/docs/index.md @@ -8,7 +8,7 @@ hide: Headscale is an open source, self-hosted implementation of the Tailscale control server. -This page contains the documentation for the latest version of headscale. Please also check our [FAQ](./about/faq.md). +This page contains the documentation for the latest version of headscale. Please also check our [FAQ](about/faq.md). Join our [Discord server](https://discord.gg/c84AZQhmpx) for a chat and community support. diff --git a/docs/ref/debug.md b/docs/ref/debug.md index 77715e53..40639aad 100644 --- a/docs/ref/debug.md +++ b/docs/ref/debug.md @@ -60,12 +60,12 @@ Headscale provides a metrics and debug endpoint. It allows to introspect differe !!! warning "Keep the metrics and debug endpoint private" The listen address and port can be configured with the `metrics_listen_addr` variable in the [configuration - file](./configuration.md). By default it listens on localhost, port 9090. + file](configuration.md). By default it listens on localhost, port 9090. Keep the metrics and debug endpoint private to your internal network and don't expose it to the Internet. The metrics and debug interface can be disabled completely by setting `metrics_listen_addr: null` in the - [configuration file](./configuration.md). + [configuration file](configuration.md). Query metrics via and get an overview of available debug information via . Metrics may be queried from outside localhost but the debug interface is subject to diff --git a/docs/ref/derp.md b/docs/ref/derp.md index cccdeb9a..d615f095 100644 --- a/docs/ref/derp.md +++ b/docs/ref/derp.md @@ -6,8 +6,8 @@ DERP server to ensure seamless connectivity between nodes. ## Configuration -DERP related settings are configured within the `derp` section of the [configuration file](./configuration.md). The -following sections only use a few of the available settings, check the [example configuration](./configuration.md) for +DERP related settings are configured within the `derp` section of the [configuration file](configuration.md). The +following sections only use a few of the available settings, check the [example configuration](configuration.md) for all available configuration options. ### Enable embedded DERP @@ -163,7 +163,7 @@ Any Tailscale client may be used to introspect the DERP map and to check for con - Check connectivity with the embedded DERP[^1]:`tailscale debug derp headscale` Additional DERP related metrics and information is available via the [metrics and debug -endpoint](./debug.md#metrics-and-debug-endpoint). +endpoint](debug.md#metrics-and-debug-endpoint). ## Limitations @@ -171,4 +171,4 @@ endpoint](./debug.md#metrics-and-debug-endpoint). endpoint via HTTP on port tcp/80. - There are no speed or throughput optimisations, the main purpose is to assist in node connectivity. -[^1]: This assumes that the default region code of the [configuration file](./configuration.md) is used. +[^1]: This assumes that the default region code of the [configuration file](configuration.md) is used. diff --git a/docs/ref/dns.md b/docs/ref/dns.md index 015853be..fe1862ef 100644 --- a/docs/ref/dns.md +++ b/docs/ref/dns.md @@ -1,19 +1,19 @@ # DNS Headscale supports [most DNS features](../about/features.md) from Tailscale. DNS related settings can be configured -within the `dns` section of the [configuration file](./configuration.md). +within the `dns` section of the [configuration file](configuration.md). ## Setting extra DNS records Headscale allows to set extra DNS records which are made available via [MagicDNS](https://tailscale.com/docs/features/magicdns). Extra DNS records can be configured either via static entries -in the [configuration file](./configuration.md) or from a JSON file that Headscale continuously watches for changes: +in the [configuration file](configuration.md) or from a JSON file that Headscale continuously watches for changes: -- Use the `dns.extra_records` option in the [configuration file](./configuration.md) for entries that are static and +- Use the `dns.extra_records` option in the [configuration file](configuration.md) for entries that are static and don't change while Headscale is running. Those entries are processed when Headscale is starting up and changes to the configuration require a restart of Headscale. - For dynamic DNS records that may be added, updated or removed while Headscale is running or DNS records that are - generated by scripts the option `dns.extra_records_path` in the [configuration file](./configuration.md) is useful. + generated by scripts the option `dns.extra_records_path` in the [configuration file](configuration.md) is useful. Set it to the absolute path of the JSON file containing DNS records and Headscale processes this file as it detects changes. @@ -66,7 +66,7 @@ hostname and port combination "http://hostname-in-magic-dns.myvpn.example.com:30 !!! tip "Good to know" - - The `dns.extra_records_path` option in the [configuration file](./configuration.md) needs to reference the + - The `dns.extra_records_path` option in the [configuration file](configuration.md) needs to reference the JSON file containing extra DNS records. - Be sure to "sort keys" and produce a stable output in case you generate the JSON file with a script. Headscale uses a checksum to detect changes to the file and a stable output avoids unnecessary processing. diff --git a/docs/ref/routes.md b/docs/ref/routes.md index d625b6d2..ba2a0cad 100644 --- a/docs/ref/routes.md +++ b/docs/ref/routes.md @@ -295,7 +295,7 @@ to clients. Please see the official [Tailscale documentation on high availability](https://tailscale.com/docs/how-to/set-up-high-availability#subnet-router-high-availability) for details. This feature is enabled by default when at least two nodes advertise the same prefix. See the configuration options -`node.routes.ha` in the [configuration file](./configuration.md) for details. +`node.routes.ha` in the [configuration file](configuration.md) for details. ## Troubleshooting diff --git a/docs/setup/install/community.md b/docs/setup/install/community.md index 05956bd6..7f0c8610 100644 --- a/docs/setup/install/community.md +++ b/docs/setup/install/community.md @@ -1,7 +1,7 @@ # Community packages Several Linux distributions and community members provide packages for headscale. Those packages may be used instead of -the [official releases](./official.md) provided by the headscale maintainers. Such packages offer improved integration +the [official releases](official.md) provided by the headscale maintainers. Such packages offer improved integration for their targeted operating system and usually: - setup a dedicated local user account to run headscale diff --git a/docs/setup/install/main.md b/docs/setup/install/main.md index 581edafe..80be51b8 100644 --- a/docs/setup/install/main.md +++ b/docs/setup/install/main.md @@ -39,7 +39,7 @@ docker run \ serve ``` -See [Running headscale in a container](./container.md) for full container setup instructions. +See [Running headscale in a container](container.md) for full container setup instructions. ## Binaries @@ -54,5 +54,5 @@ via [nightly.link](https://nightly.link/juanfont/headscale/workflows/container-m | macOS | arm64 | [headscale-darwin-arm64](https://nightly.link/juanfont/headscale/workflows/container-main/main/headscale-darwin-arm64.zip) | After downloading and extracting the archive, make the binary executable and follow the -[standalone binary installation](./official.md#using-standalone-binaries-advanced) +[standalone binary installation](official.md#using-standalone-binaries-advanced) instructions for setting up the service. diff --git a/docs/setup/install/official.md b/docs/setup/install/official.md index b2b89ca0..a70422f8 100644 --- a/docs/setup/install/official.md +++ b/docs/setup/install/official.md @@ -51,7 +51,7 @@ Continue on the [getting started page](../../usage/getting-started.md) to regist This installation method is considered advanced as one needs to take care of the local user and the systemd service themselves. If possible, use the [DEB packages](#using-packages-for-debianubuntu-recommended) or a - [community package](./community.md) instead. + [community package](community.md) instead. This section describes the installation of headscale according to the [Requirements and assumptions](../requirements.md#assumptions). Headscale is run by a dedicated local user and the service itself is