rsp2k/headscale
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Update config-example links

Browse Source
This commit is contained in:
Florian Preinstorfer 2026-05-16 10:55:01 +02:00 committed by nblock
parent f3f84a5a63
commit 355733342f
1 changed files with 7 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
config-example.yaml
View File

@ -87,8 +87,7 @@ prefixes:
# connection cannot be established. # connection cannot be established.
# https://tailscale.com/blog/how-tailscale-works/#encrypted-tcp-relays-derp # https://tailscale.com/blog/how-tailscale-works/#encrypted-tcp-relays-derp
# #
# headscale needs a list of DERP servers that can be presented # Headscale needs a list of DERP servers that can be presented to the clients.
# to the clients.
derp: derp:
server: server:
# If enabled, runs the embedded DERP server and merges it into the rest of the DERP config # If enabled, runs the embedded DERP server and merges it into the rest of the DERP config
@ -133,9 +132,9 @@ derp:
# Locally available DERP map files encoded in YAML # Locally available DERP map files encoded in YAML
# #
# This option is mostly interesting for people hosting # This option is mostly interesting for people hosting their own DERP servers:
# their own DERP servers:
# https://tailscale.com/docs/reference/derp-servers/custom-derp-servers # https://tailscale.com/docs/reference/derp-servers/custom-derp-servers
# https://headscale.net/stable/ref/derp/
# #
# paths: # paths:
# - /etc/headscale/derp-example.yaml # - /etc/headscale/derp-example.yaml
@ -269,7 +268,7 @@ tls_letsencrypt_cache_dir: /var/lib/headscale/cache
# Type of ACME challenge to use, currently supported types: # Type of ACME challenge to use, currently supported types:
# HTTP-01 or TLS-ALPN-01 # HTTP-01 or TLS-ALPN-01
# See: docs/ref/tls.md for more information # See: https://headscale.net/stable/ref/tls/
tls_letsencrypt_challenge_type: HTTP-01 tls_letsencrypt_challenge_type: HTTP-01
# When HTTP-01 challenge is chosen, letsencrypt must set up a # When HTTP-01 challenge is chosen, letsencrypt must set up a
# verification endpoint, and it will be listening on: # verification endpoint, and it will be listening on:
@ -304,7 +303,6 @@ policy:
# headscale supports Tailscale's DNS configuration and MagicDNS. # headscale supports Tailscale's DNS configuration and MagicDNS.
# Please have a look to their docs to better understand the concepts: # Please have a look to their docs to better understand the concepts:
# #
# - https://tailscale.com/docs/features/access-control/acls
# - https://tailscale.com/docs/features/magicdns # - https://tailscale.com/docs/features/magicdns
# - https://tailscale.com/blog/2021-09-private-dns-with-magicdns # - https://tailscale.com/blog/2021-09-private-dns-with-magicdns
# #
@ -321,7 +319,7 @@ policy:
# If you want stop Headscale from managing the DNS configuration # If you want stop Headscale from managing the DNS configuration
# all the fields under `dns` should be set to empty values. # all the fields under `dns` should be set to empty values.
dns: dns:
# Whether to use [MagicDNS](https://tailscale.com/docs/features/magicdns). # Whether to use MagicDNS
magic_dns: true magic_dns: true
# Defines the base domain to create the hostnames for MagicDNS. # Defines the base domain to create the hostnames for MagicDNS.
@ -362,7 +360,7 @@ dns:
# Extra DNS records # Extra DNS records
# so far only A and AAAA records are supported (on the tailscale side) # so far only A and AAAA records are supported (on the tailscale side)
# See: docs/ref/dns.md # See: https://headscale.net/stable/ref/dns/
extra_records: [] extra_records: []
# - name: "grafana.myvpn.example.com" # - name: "grafana.myvpn.example.com"
# type: "A" # type: "A"
@ -381,6 +379,7 @@ unix_socket: /var/run/headscale/headscale.sock
unix_socket_permission: "0770" unix_socket_permission: "0770"
# OpenID Connect # OpenID Connect
# https://headscale.net/stable/ref/oidc/
# oidc: # oidc:
# # Block startup until the identity provider is available and healthy. # # Block startup until the identity provider is available and healthy.
# only_start_if_oidc_is_available: true # only_start_if_oidc_is_available: true