288 lines
10 KiB
Django/Jinja
288 lines
10 KiB
Django/Jinja
---
|
||
# headscale will look for a configuration file named `config.yaml` (or `config.json`) in the following order:
|
||
#
|
||
# - `/etc/headscale`
|
||
# - `~/.headscale`
|
||
# - current working directory
|
||
|
||
# The url clients will connect to.
|
||
# Typically this will be a domain like:
|
||
#
|
||
# https://myheadscale.example.com:443
|
||
#
|
||
server_url: https://headscale.simponic.xyz:443
|
||
|
||
# Address to listen to / bind to on the server
|
||
#
|
||
# For production:
|
||
# listen_addr: 0.0.0.0:8080
|
||
listen_addr: 0.0.0.0:8080
|
||
|
||
# Address to listen to /metrics, you may want
|
||
# to keep this endpoint private to your internal
|
||
# network
|
||
#
|
||
metrics_listen_addr: 127.0.0.1:9090
|
||
|
||
# Address to listen for gRPC.
|
||
# gRPC is used for controlling a headscale server
|
||
# remotely with the CLI
|
||
# Note: Remote access _only_ works if you have
|
||
# valid certificates.
|
||
#
|
||
# For production:
|
||
# grpc_listen_addr: 0.0.0.0:50443
|
||
grpc_listen_addr: 127.0.0.1:50443
|
||
|
||
# Allow the gRPC admin interface to run in INSECURE
|
||
# mode. This is not recommended as the traffic will
|
||
# be unencrypted. Only enable if you know what you
|
||
# are doing.
|
||
grpc_allow_insecure: false
|
||
|
||
# The Noise section includes specific configuration for the
|
||
# TS2021 Noise protocol
|
||
noise:
|
||
# The Noise private key is used to encrypt the
|
||
# traffic between headscale and Tailscale clients when
|
||
# using the new Noise-based protocol.
|
||
private_key_path: /var/lib/headscale/noise_private.key
|
||
|
||
private_key_path: /var/lib/headscale/private.key
|
||
|
||
# List of IP prefixes to allocate tailaddresses from.
|
||
# Each prefix consists of either an IPv4 or IPv6 address,
|
||
# and the associated prefix length, delimited by a slash.
|
||
# It must be within IP ranges supported by the Tailscale
|
||
# client - i.e., subnets of 100.64.0.0/10 and fd7a:115c:a1e0::/48.
|
||
# See below:
|
||
# IPv6: https://github.com/tailscale/tailscale/blob/22ebb25e833264f58d7c3f534a8b166894a89536/net/tsaddr/tsaddr.go#LL81C52-L81C71
|
||
# IPv4: https://github.com/tailscale/tailscale/blob/22ebb25e833264f58d7c3f534a8b166894a89536/net/tsaddr/tsaddr.go#L33
|
||
# Any other range is NOT supported, and it will cause unexpected issues.
|
||
ip_prefixes:
|
||
- fd7a:115c:a1e0::/48
|
||
- 100.64.0.0/10
|
||
|
||
# DERP is a relay system that Tailscale uses when a direct
|
||
# connection cannot be established.
|
||
# https://tailscale.com/blog/how-tailscale-works/#encrypted-tcp-relays-derp
|
||
#
|
||
# headscale needs a list of DERP servers that can be presented
|
||
# to the clients.
|
||
derp:
|
||
server:
|
||
# If enabled, runs the embedded DERP server and merges it into the rest of the DERP config
|
||
# The Headscale server_url defined above MUST be using https, DERP requires TLS to be in place
|
||
enabled: false
|
||
|
||
# Region ID to use for the embedded DERP server.
|
||
# The local DERP prevails if the region ID collides with other region ID coming from
|
||
# the regular DERP config.
|
||
region_id: 999
|
||
|
||
# Region code and name are displayed in the Tailscale UI to identify a DERP region
|
||
region_code: "headscale"
|
||
region_name: "Headscale Embedded DERP"
|
||
|
||
# Listens over UDP at the configured address for STUN connections - to help with NAT traversal.
|
||
# When the embedded DERP server is enabled stun_listen_addr MUST be defined.
|
||
#
|
||
# For more details on how this works, check this great article: https://tailscale.com/blog/how-tailscale-works/
|
||
stun_listen_addr: "0.0.0.0:3478"
|
||
|
||
# Private key used to encrypt the traffic between headscale DERP
|
||
# and Tailscale clients.
|
||
# The private key file will be autogenerated if it's missing.
|
||
#
|
||
private_key_path: /var/lib/headscale/derp_server_private.key
|
||
|
||
# List of externally available DERP maps encoded in JSON
|
||
urls:
|
||
- https://controlplane.tailscale.com/derpmap/default
|
||
|
||
# Locally available DERP map files encoded in YAML
|
||
#
|
||
# This option is mostly interesting for people hosting
|
||
# their own DERP servers:
|
||
# https://tailscale.com/kb/1118/custom-derp-servers/
|
||
#
|
||
# paths:
|
||
# - /etc/headscale/derp-example.yaml
|
||
paths: []
|
||
|
||
# If enabled, a worker will be set up to periodically
|
||
# refresh the given sources and update the derpmap
|
||
# will be set up.
|
||
auto_update_enabled: true
|
||
|
||
# How often should we check for DERP updates?
|
||
update_frequency: 24h
|
||
|
||
# Disables the automatic check for headscale updates on startup
|
||
disable_check_updates: false
|
||
|
||
# Time before an inactive ephemeral node is deleted?
|
||
ephemeral_node_inactivity_timeout: 30m
|
||
|
||
# Period to check for node updates within the tailnet. A value too low will severely affect
|
||
# CPU consumption of Headscale. A value too high (over 60s) will cause problems
|
||
# for the nodes, as they won't get updates or keep alive messages frequently enough.
|
||
# In case of doubts, do not touch the default 10s.
|
||
node_update_check_interval: 10s
|
||
|
||
# SQLite config
|
||
db_type: sqlite3
|
||
|
||
# For production:
|
||
db_path: /var/lib/headscale/db.sqlite
|
||
|
||
# # Postgres config
|
||
# If using a Unix socket to connect to Postgres, set the socket path in the 'host' field and leave 'port' blank.
|
||
# db_type: postgres
|
||
# db_host: localhost
|
||
# db_port: 5432
|
||
# db_name: headscale
|
||
# db_user: foo
|
||
# db_pass: bar
|
||
|
||
# If other 'sslmode' is required instead of 'require(true)' and 'disabled(false)', set the 'sslmode' you need
|
||
# in the 'db_ssl' field. Refers to https://www.postgresql.org/docs/current/libpq-ssl.html Table 34.1.
|
||
# db_ssl: false
|
||
|
||
tls_cert_path: ""
|
||
tls_key_path: ""
|
||
|
||
log:
|
||
# Output formatting for logs: text or json
|
||
format: text
|
||
level: info
|
||
|
||
# Path to a file containg ACL policies.
|
||
# ACLs can be defined as YAML or HUJSON.
|
||
# https://tailscale.com/kb/1018/acls/
|
||
acl_policy_path: "/etc/headscale/acl.json"
|
||
|
||
## DNS
|
||
#
|
||
# headscale supports Tailscale's DNS configuration and MagicDNS.
|
||
# Please have a look to their KB to better understand the concepts:
|
||
#
|
||
# - https://tailscale.com/kb/1054/dns/
|
||
# - https://tailscale.com/kb/1081/magicdns/
|
||
# - https://tailscale.com/blog/2021-09-private-dns-with-magicdns/
|
||
#
|
||
dns_config:
|
||
# Whether to prefer using Headscale provided DNS or use local.
|
||
override_local_dns: true
|
||
|
||
# List of DNS servers to expose to clients.
|
||
nameservers:
|
||
- {{ nameserver_ip }}
|
||
|
||
# NextDNS (see https://tailscale.com/kb/1218/nextdns/).
|
||
# "abc123" is example NextDNS ID, replace with yours.
|
||
#
|
||
# With metadata sharing:
|
||
# nameservers:
|
||
# - https://dns.nextdns.io/abc123
|
||
#
|
||
# Without metadata sharing:
|
||
# nameservers:
|
||
# - 2a07:a8c0::ab:c123
|
||
# - 2a07:a8c1::ab:c123
|
||
|
||
# Split DNS (see https://tailscale.com/kb/1054/dns/),
|
||
# list of search domains and the DNS to query for each one.
|
||
#
|
||
# restricted_nameservers:
|
||
# foo.bar.com:
|
||
# - 1.1.1.1
|
||
# darp.headscale.net:
|
||
# - 1.1.1.1
|
||
# - 8.8.8.8
|
||
|
||
# Search domains to inject.
|
||
domains: ['simponic.xyz', 'internal.simponic.xyz']
|
||
|
||
# Extra DNS records
|
||
# so far only A-records are supported (on the tailscale side)
|
||
# See https://github.com/juanfont/headscale/blob/main/docs/dns-records.md#Limitations
|
||
# extra_records:
|
||
# - name: "grafana.myvpn.example.com"
|
||
# type: "A"
|
||
# value: "100.64.0.3"
|
||
#
|
||
# # you can also put it in one line
|
||
# - { name: "prometheus.myvpn.example.com", type: "A", value: "100.64.0.3" }
|
||
|
||
# Whether to use [MagicDNS](https://tailscale.com/kb/1081/magicdns/).
|
||
# Only works if there is at least a nameserver defined.
|
||
magic_dns: true
|
||
|
||
# Defines the base domain to create the hostnames for MagicDNS.
|
||
# `base_domain` must be a FQDNs, without the trailing dot.
|
||
# The FQDN of the hosts will be
|
||
# `hostname.user.base_domain` (e.g., _myhost.myuser.example.com_).
|
||
base_domain: internal.simponic.xyz
|
||
|
||
# Unix socket used for the CLI to connect without authentication
|
||
# Note: for production you will want to set this to something like:
|
||
unix_socket: /var/run/headscale/headscale.sock
|
||
unix_socket_permission: "0770"
|
||
#
|
||
# headscale supports experimental OpenID connect support,
|
||
# it is still being tested and might have some bugs, please
|
||
# help us test it.
|
||
# OpenID Connect
|
||
oidc:
|
||
# Block further startup until the OIDC provider is healthy and available
|
||
only_start_if_oidc_is_available: false
|
||
# Specified by your OIDC provider
|
||
issuer: "https://authelia.simponic.xyz"
|
||
# Specified/generated by your OIDC provider
|
||
client_id: "simponicheadscale"
|
||
client_secret: "{{ headscale_oidc_secret }}"
|
||
# alternatively, set `client_secret_path` to read the secret from the file.
|
||
# It resolves environment variables, making integration to systemd's
|
||
# `LoadCredential` straightforward:
|
||
#client_secret_path: "${CREDENTIALS_DIRECTORY}/oidc_client_secret"
|
||
|
||
# Customize the scopes used in the OIDC flow, defaults to "openid", "profile" and "email" and add custom query
|
||
# parameters to the Authorize Endpoint request. Scopes default to "openid", "profile" and "email".
|
||
scope: ["openid", "profile", "email"]
|
||
# Optional: Passed on to the browser login request – used to tweak behaviour for the OIDC provider
|
||
extra_params:
|
||
domain_hint: simponic.xyz
|
||
|
||
# Optional: List allowed principal domains and/or users. If an authenticated user's domain is not in this list,
|
||
# the authentication request will be rejected.
|
||
allowed_domains:
|
||
- simponic.xyz
|
||
# Optional. Note that groups from Keycloak have a leading '/'.
|
||
# allowed_groups:
|
||
# - /admins
|
||
# - admins
|
||
# - people
|
||
# Optional.
|
||
allowed_users: {{ headscale_allowed_users }}
|
||
|
||
# If `strip_email_domain` is set to `true`, the domain part of the username email address will be removed.
|
||
# This will transform `first-name.last-name@example.com` to the user `first-name.last-name`
|
||
# If `strip_email_domain` is set to `false` the domain part will NOT be removed resulting to the following
|
||
# user: `first-name.last-name.example.com`
|
||
strip_email_domain: true
|
||
|
||
# Logtail configuration
|
||
# Logtail is Tailscales logging and auditing infrastructure, it allows the control panel
|
||
# to instruct tailscale nodes to log their activity to a remote server.
|
||
logtail:
|
||
# Enable logtail for this headscales clients.
|
||
# As there is currently no support for overriding the log server in headscale, this is
|
||
# disabled by default. Enabling this will make your clients send logs to Tailscale Inc.
|
||
enabled: false
|
||
|
||
# Enabling this option makes devices prefer a random port for WireGuard traffic over the
|
||
# default static port 41641. This option is intended as a workaround for some buggy
|
||
# firewall devices. See https://tailscale.com/kb/1181/firewalls/ for more information.
|
||
randomize_client_port: false
|