Mirrors/headscale
1
0
Fork 0
mirror of https://github.com/juanfont/headscale.git synced 2026-07-17 16:36:02 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Slightly restructure the example config comments

Browse source
This commit is contained in:
Florian Preinstorfer 2026-06-21 06:34:08 +02:00 • committed by nblock
parent 5aeeff98d0
commit fe536dd799
1 changed files with 9 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

18
config-example.yaml
View file

@ -230,12 +230,12 @@ database:
# ssl: false # ssl: false
### TLS configuration ### TLS configuration
# # See: https://headscale.net/stable/ref/tls/
## Let's encrypt / ACME
# ## Let's Encrypt / ACME
# headscale supports automatically requesting and setting up # Headscale supports automatically requesting and setting up
# TLS for a domain with Let's Encrypt. # TLS for a domain with Let's Encrypt.
#
# URL to ACME directory # URL to ACME directory
acme_url: https://acme-v02.api.letsencrypt.org/directory acme_url: https://acme-v02.api.letsencrypt.org/directory
@ -245,15 +245,13 @@ acme_email: ""
# Domain name to request a TLS certificate for: # Domain name to request a TLS certificate for:
tls_letsencrypt_hostname: "" tls_letsencrypt_hostname: ""
# Path to store certificates and metadata needed by # Path to store certificates and metadata needed by letsencrypt
# letsencrypt
# For production:
tls_letsencrypt_cache_dir: /var/lib/headscale/cache 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: 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:
# :http = port 80 # :http = port 80
@ -279,6 +277,7 @@ policy:
# The mode can be "file" or "database" that defines # The mode can be "file" or "database" that defines
# where the policies are stored and read from. # where the policies are stored and read from.
mode: file mode: file
# If the mode is set to "file", the path to a HuJSON file containing policies. # If the mode is set to "file", the path to a HuJSON file containing policies.
path: "" path: ""
@ -460,6 +459,7 @@ taildrop:
# choice. # choice.
auto_update: auto_update:
enabled: false enabled: false
# Advanced performance tuning parameters. # Advanced performance tuning parameters.
# The defaults are carefully chosen and should rarely need adjustment. # The defaults are carefully chosen and should rarely need adjustment.
# Only modify these if you have identified a specific performance issue. # Only modify these if you have identified a specific performance issue.