2025-02-03 00:52:49 +09:00
<!doctype html> < html lang = en class = no-js > < head > < meta charset = utf-8 > < meta name = viewport content = "width=device-width,initial-scale=1" > < meta name = description content = "An open source, self-hosted implementation of the Tailscale control server." > < meta name = author content = "Headscale authors" > < link href = https://juanfont.github.io/headscale/0.24.1/ref/dns/ rel = canonical > < link href = ../acls/ rel = prev > < link href = ../remote-cli/ rel = next > < link rel = icon href = ../../assets/favicon.png > < meta name = generator content = "mkdocs-1.6.1, mkdocs-material-9.6.1" > < title > DNS - Headscale< / title > < link rel = stylesheet href = ../../assets/stylesheets/main.a40c8224.min.css > < link rel = stylesheet href = ../../assets/stylesheets/palette.06af60db.min.css > < link rel = preconnect href = https://fonts.gstatic.com crossorigin > < link rel = stylesheet href = "https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback" > < style > : root { --md-text-font : "Roboto" ; --md-code-font : "Roboto Mono" } < / style > < script > _ _md _scope = new URL ( "../.." , location ) , _ _md _hash = e => [ ... e ] . reduce ( ( ( e , _ ) => ( e << 5 ) - e + _ . charCodeAt ( 0 ) ) , 0 ) , _ _md _get = ( e , _ = localStorage , t = _ _md _scope ) => JSON . parse ( _ . getItem ( t . pathname + "." + e ) ) , _ _md _set = ( e , _ , t = localStorage , a = _ _md _scope ) => { try { t . setItem ( a . pathname + "." + e , JSON . stringify ( _ ) ) } catch ( e ) { } } < / script > < meta property = og:type content = website > < meta property = og:title content = "DNS - Headscale" > < meta property = og:description content = "An open source, self-hosted implementation of the Tailscale control server." > < meta property = og:image content = https://juanfont.github.io/headscale/0.24.1/assets/images/social/ref/dns.png > < meta property = og:image:type content = image/png > < meta property = og:image:width content = 1200 > < meta property = og:image:height content = 630 > < meta content = https://juanfont.github.io/headscale/0.24.1/ref/dns/ property = og:url > < meta name = twitter:card content = summary_large_image > < meta name = twitter:title content = "DNS - Headscale" > < meta name = twitter:description content = "An open source, self-hosted implementation of the Tailscale control server." > < meta name = twitter:image content = https://juanfont.github.io/headscale/0.24.1/assets/images/social/ref/dns.png > < / head > < body dir = ltr data-md-color-scheme = default data-md-color-primary = white data-md-color-accent = indigo > < input class = md-toggle data-md-toggle = drawer type = checkbox id = __drawer autocomplete = off > < input class = md-toggle data-md-toggle = search type = checkbox id = __search autocomplete = off > < label class = md-overlay for = __drawer > < / label > < div data-md-component = skip > < a href = #dns class = md-skip > Skip to content < / a > < / div > < div data-md-component = announce > < / div > < div data-md-color-scheme = default data-md-component = outdated hidden > < / div > < header class = md-header data-md-component = header > < nav class = "md-header__inner md-grid" aria-label = Header > < a href = ../.. title = Headscale class = "md-header__button md-logo" aria-label = Headscale data-md-component = logo > < img src = ../../logo/headscale3-dots.svg alt = logo > < / a > < label class = "md-header__button md-icon" for = __drawer > < svg xmlns = http://www.w3.org/2000/svg viewbox = "0 0 24 24" > < path d = "M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z" / > < / svg > < / label > < div class = md-header__title data-md-component = header-title > < div class = md-header__ellipsis > < div class = md-header__topic > < span class = md-ellipsis > Headscale < / span > < / div > < div class = md-header__topic data-md-component = header-topic > < span class = md-ellipsis > DNS < / span > < / div > < / div > < / div > < form class = md-header__option data-md-component = palette > < input class = md-option data-md-color-media data-md-color-scheme = default data-md-color-primary = white data-md-color-accent = indigo aria-label = "Switch to dark mode" type = radio name = __palette id = __palette_0 > < label class = "md-header__button md-icon" title = "Switch to dark mode" for = __palette_1 hidden > < svg xmlns = http://www.w3.org/2000/svg viewbox = "0 0 24 24" > < path d = "M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z" / > < / svg > <
2025-01-24 00:47:27 +09:00
< / span > < span id = __span-0-2 > < a id = __codelineno-0-2 name = __codelineno-0-2 href = #__codelineno-0-2 > < / a > < span class = w > < / span > < span class = "l l-Scalar l-Scalar-Plain" > ...< / span >
< / span > < span id = __span-0-3 > < a id = __codelineno-0-3 name = __codelineno-0-3 href = #__codelineno-0-3 > < / a > < span class = w > < / span > < span class = "l l-Scalar l-Scalar-Plain" > extra_records< / span > < span class = "p p-Indicator" > :< / span >
< / span > < span id = __span-0-4 > < a id = __codelineno-0-4 name = __codelineno-0-4 href = #__codelineno-0-4 > < / a > < span class = w > < / span > < span class = "p p-Indicator" > -< / span > < span class = w > < / span > < span class = nt > name< / span > < span class = p > :< / span > < span class = w > < / span > < span class = s > " grafana.myvpn.example.com" < / span >
< / span > < span id = __span-0-5 > < a id = __codelineno-0-5 name = __codelineno-0-5 href = #__codelineno-0-5 > < / a > < span class = w > < / span > < span class = nt > type< / span > < span class = p > :< / span > < span class = w > < / span > < span class = s > " A" < / span >
< / span > < span id = __span-0-6 > < a id = __codelineno-0-6 name = __codelineno-0-6 href = #__codelineno-0-6 > < / a > < span class = w > < / span > < span class = nt > value< / span > < span class = p > :< / span > < span class = w > < / span > < span class = s > " 100.64.0.3" < / span >
< / span > < span id = __span-0-7 > < a id = __codelineno-0-7 name = __codelineno-0-7 href = #__codelineno-0-7 > < / a >
< / span > < span id = __span-0-8 > < a id = __codelineno-0-8 name = __codelineno-0-8 href = #__codelineno-0-8 > < / a > < span class = w > < / span > < span class = "p p-Indicator" > -< / span > < span class = w > < / span > < span class = nt > name< / span > < span class = p > :< / span > < span class = w > < / span > < span class = s > " prometheus.myvpn.example.com" < / span >
< / span > < span id = __span-0-9 > < a id = __codelineno-0-9 name = __codelineno-0-9 href = #__codelineno-0-9 > < / a > < span class = w > < / span > < span class = nt > type< / span > < span class = p > :< / span > < span class = w > < / span > < span class = s > " A" < / span >
< / span > < span id = __span-0-10 > < a id = __codelineno-0-10 name = __codelineno-0-10 href = #__codelineno-0-10 > < / a > < span class = w > < / span > < span class = nt > value< / span > < span class = p > :< / span > < span class = w > < / span > < span class = s > " 100.64.0.3" < / span >
< / span > < span id = __span-0-11 > < a id = __codelineno-0-11 name = __codelineno-0-11 href = #__codelineno-0-11 > < / a > < span class = w > < / span > < span class = "l l-Scalar l-Scalar-Plain" > ...< / span >
< / span > < / code > < / pre > < / div > < p > Restart your headscale instance.< / p > < / div > < div class = tabbed-block > < div class = "language-json highlight" > < span class = filename > extra-records.json< / span > < pre > < span > < / span > < code > < span id = __span-1-1 > < a id = __codelineno-1-1 name = __codelineno-1-1 href = #__codelineno-1-1 > < / a > < span class = p > [< / span >
< / span > < span id = __span-1-2 > < a id = __codelineno-1-2 name = __codelineno-1-2 href = #__codelineno-1-2 > < / a > < span class = w > < / span > < span class = p > {< / span >
< / span > < span id = __span-1-3 > < a id = __codelineno-1-3 name = __codelineno-1-3 href = #__codelineno-1-3 > < / a > < span class = w > < / span > < span class = nt > " name" < / span > < span class = p > :< / span > < span class = w > < / span > < span class = s2 > " grafana.myvpn.example.com" < / span > < span class = p > ,< / span >
< / span > < span id = __span-1-4 > < a id = __codelineno-1-4 name = __codelineno-1-4 href = #__codelineno-1-4 > < / a > < span class = w > < / span > < span class = nt > " type" < / span > < span class = p > :< / span > < span class = w > < / span > < span class = s2 > " A" < / span > < span class = p > ,< / span >
< / span > < span id = __span-1-5 > < a id = __codelineno-1-5 name = __codelineno-1-5 href = #__codelineno-1-5 > < / a > < span class = w > < / span > < span class = nt > " value" < / span > < span class = p > :< / span > < span class = w > < / span > < span class = s2 > " 100.64.0.3" < / span >
< / span > < span id = __span-1-6 > < a id = __codelineno-1-6 name = __codelineno-1-6 href = #__codelineno-1-6 > < / a > < span class = w > < / span > < span class = p > },< / span >
< / span > < span id = __span-1-7 > < a id = __codelineno-1-7 name = __codelineno-1-7 href = #__codelineno-1-7 > < / a > < span class = w > < / span > < span class = p > {< / span >
< / span > < span id = __span-1-8 > < a id = __codelineno-1-8 name = __codelineno-1-8 href = #__codelineno-1-8 > < / a > < span class = w > < / span > < span class = nt > " name" < / span > < span class = p > :< / span > < span class = w > < / span > < span class = s2 > " prometheus.myvpn.example.com" < / span > < span class = p > ,< / span >
< / span > < span id = __span-1-9 > < a id = __codelineno-1-9 name = __codelineno-1-9 href = #__codelineno-1-9 > < / a > < span class = w > < / span > < span class = nt > " type" < / span > < span class = p > :< / span > < span class = w > < / span > < span class = s2 > " A" < / span > < span class = p > ,< / span >
< / span > < span id = __span-1-10 > < a id = __codelineno-1-10 name = __codelineno-1-10 href = #__codelineno-1-10 > < / a > < span class = w > < / span > < span class = nt > " value" < / span > < span class = p > :< / span > < span class = w > < / span > < span class = s2 > " 100.64.0.3" < / span >
< / span > < span id = __span-1-11 > < a id = __codelineno-1-11 name = __codelineno-1-11 href = #__codelineno-1-11 > < / a > < span class = w > < / span > < span class = p > }< / span >
< / span > < span id = __span-1-12 > < a id = __codelineno-1-12 name = __codelineno-1-12 href = #__codelineno-1-12 > < / a > < span class = p > ]< / span >
< / span > < / code > < / pre > < / div > < p > Headscale picks up changes to the above JSON file automatically.< / p > < div class = "admonition tip" > < p class = admonition-title > Good to know< / p > < ul > < li > The < code > dns.extra_records_path< / code > option in the < a href = ../configuration/ > configuration file< / a > needs to reference the JSON file containing extra DNS records.< / li > < li > 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.< / li > < / ul > < / div > < / div > < / div > < / div > < / li > < li > < p > Verify that DNS records are properly set using the DNS querying tool of your choice:< / p > < div class = "tabbed-set tabbed-alternate" data-tabs = 2:2 > < input checked = checked id = __tabbed_2_1 name = __tabbed_2 type = radio > < input id = __tabbed_2_2 name = __tabbed_2 type = radio > < div class = tabbed-labels > < label for = __tabbed_2_1 > Query with dig< / label > < label for = __tabbed_2_2 > Query with drill< / label > < / div > < div class = tabbed-content > < div class = tabbed-block > < div class = "language-shell highlight" > < pre > < span > < / span > < code > < span id = __span-2-1 > < a id = __codelineno-2-1 name = __codelineno-2-1 href = #__codelineno-2-1 > < / a > dig< span class = w > < / span > +short< span class = w > < / span > grafana.myvpn.example.com
< / span > < span id = __span-2-2 > < a id = __codelineno-2-2 name = __codelineno-2-2 href = #__codelineno-2-2 > < / a > < span class = m > 100< / span > .64.0.3
< / span > < / code > < / pre > < / div > < / div > < div class = tabbed-block > < div class = "language-shell highlight" > < pre > < span > < / span > < code > < span id = __span-3-1 > < a id = __codelineno-3-1 name = __codelineno-3-1 href = #__codelineno-3-1 > < / a > drill< span class = w > < / span > -Q< span class = w > < / span > grafana.myvpn.example.com
< / span > < span id = __span-3-2 > < a id = __codelineno-3-2 name = __codelineno-3-2 href = #__codelineno-3-2 > < / a > < span class = m > 100< / span > .64.0.3
< / span > < / code > < / pre > < / div > < / div > < / div > < / div > < / li > < li > < p > Optional: Setup the reverse proxy< / p > < p > The motivating example here was to be able to access internal monitoring services on the same host without specifying a port, depicted as NGINX configuration snippet:< / p > < div class = "language-nginx highlight" > < span class = filename > nginx.conf< / span > < pre > < span > < / span > < code > < span id = __span-4-1 > < a id = __codelineno-4-1 name = __codelineno-4-1 href = #__codelineno-4-1 > < / a > < span class = k > server< / span > < span class = w > < / span > < span class = p > {< / span >
< / span > < span id = __span-4-2 > < a id = __codelineno-4-2 name = __codelineno-4-2 href = #__codelineno-4-2 > < / a > < span class = w > < / span > < span class = kn > listen< / span > < span class = w > < / span > < span class = mi > 80< / span > < span class = p > ;< / span >
< / span > < span id = __span-4-3 > < a id = __codelineno-4-3 name = __codelineno-4-3 href = #__codelineno-4-3 > < / a > < span class = w > < / span > < span class = kn > listen< / span > < span class = w > < / span > < span class = s > [::]:80< / span > < span class = p > ;< / span >
< / span > < span id = __span-4-4 > < a id = __codelineno-4-4 name = __codelineno-4-4 href = #__codelineno-4-4 > < / a >
< / span > < span id = __span-4-5 > < a id = __codelineno-4-5 name = __codelineno-4-5 href = #__codelineno-4-5 > < / a > < span class = w > < / span > < span class = kn > server_name< / span > < span class = w > < / span > < span class = s > grafana.myvpn.example.com< / span > < span class = p > ;< / span >
< / span > < span id = __span-4-6 > < a id = __codelineno-4-6 name = __codelineno-4-6 href = #__codelineno-4-6 > < / a >
< / span > < span id = __span-4-7 > < a id = __codelineno-4-7 name = __codelineno-4-7 href = #__codelineno-4-7 > < / a > < span class = w > < / span > < span class = kn > location< / span > < span class = w > < / span > < span class = s > /< / span > < span class = w > < / span > < span class = p > {< / span >
< / span > < span id = __span-4-8 > < a id = __codelineno-4-8 name = __codelineno-4-8 href = #__codelineno-4-8 > < / a > < span class = w > < / span > < span class = kn > proxy_pass< / span > < span class = w > < / span > < span class = s > http://localhost:3000< / span > < span class = p > ;< / span >
< / span > < span id = __span-4-9 > < a id = __codelineno-4-9 name = __codelineno-4-9 href = #__codelineno-4-9 > < / a > < span class = w > < / span > < span class = kn > proxy_set_header< / span > < span class = w > < / span > < span class = s > Host< / span > < span class = w > < / span > < span class = nv > $http_host< / span > < span class = p > ;< / span >
< / span > < span id = __span-4-10 > < a id = __codelineno-4-10 name = __codelineno-4-10 href = #__codelineno-4-10 > < / a > < span class = w > < / span > < span class = kn > proxy_set_header< / span > < span class = w > < / span > < span class = s > X-Real-IP< / span > < span class = w > < / span > < span class = nv > $remote_addr< / span > < span class = p > ;< / span >
< / span > < span id = __span-4-11 > < a id = __codelineno-4-11 name = __codelineno-4-11 href = #__codelineno-4-11 > < / a > < span class = w > < / span > < span class = kn > proxy_set_header< / span > < span class = w > < / span > < span class = s > X-Forwarded-For< / span > < span class = w > < / span > < span class = nv > $proxy_add_x_forwarded_for< / span > < span class = p > ;< / span >
< / span > < span id = __span-4-12 > < a id = __codelineno-4-12 name = __codelineno-4-12 href = #__codelineno-4-12 > < / a > < span class = w > < / span > < span class = kn > proxy_set_header< / span > < span class = w > < / span > < span class = s > X-Forwarded-Proto< / span > < span class = w > < / span > < span class = nv > $scheme< / span > < span class = p > ;< / span >
< / span > < span id = __span-4-13 > < a id = __codelineno-4-13 name = __codelineno-4-13 href = #__codelineno-4-13 > < / a > < span class = w > < / span > < span class = p > }< / span >
< / span > < span id = __span-4-14 > < a id = __codelineno-4-14 name = __codelineno-4-14 href = #__codelineno-4-14 > < / a >
< / span > < span id = __span-4-15 > < a id = __codelineno-4-15 name = __codelineno-4-15 href = #__codelineno-4-15 > < / a > < span class = p > }< / span >
2025-02-03 00:52:49 +09:00
< / span > < / code > < / pre > < / div > < / li > < / ol > < / article > < / div > < script > var target = document . getElementById ( location . hash . slice ( 1 ) ) ; target && target . name && ( target . checked = target . name . startsWith ( "__tabbed_" ) ) < / script > < / div > < button type = button class = "md-top md-icon" data-md-component = top hidden > < svg xmlns = http://www.w3.org/2000/svg viewbox = "0 0 24 24" > < path d = "M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z" / > < / svg > Back to top < / button > < / main > < footer class = md-footer > < nav class = "md-footer__inner md-grid" aria-label = Footer > < a href = ../acls/ class = "md-footer__link md-footer__link--prev" aria-label = "Previous: ACLs" > < div class = "md-footer__button md-icon" > < svg xmlns = http://www.w3.org/2000/svg viewbox = "0 0 24 24" > < path d = "M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z" / > < / svg > < / div > < div class = md-footer__title > < span class = md-footer__direction > Previous < / span > < div class = md-ellipsis > ACLs < / div > < / div > < / a > < a href = ../remote-cli/ class = "md-footer__link md-footer__link--next" aria-label = "Next: Remote CLI" > < div class = md-footer__title > < span class = md-footer__direction > Next < / span > < div class = md-ellipsis > Remote CLI < / div > < / div > < div class = "md-footer__button md-icon" > < svg xmlns = http://www.w3.org/2000/svg viewbox = "0 0 24 24" > < path d = "M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11z" / > < / svg > < / div > < / a > < / nav > < div class = "md-footer-meta md-typeset" > < div class = "md-footer-meta__inner md-grid" > < div class = md-copyright > < div class = md-copyright__highlight > Copyright © 2024 Headscale authors < / div > Made with < a href = https://squidfunk.github.io/mkdocs-material/ target = _blank rel = noopener > Material for MkDocs < / a > < / div > < div class = md-social > < a href = https://github.com/juanfont/headscale target = _blank rel = noopener title = github.com class = md-social__link > < svg xmlns = http://www.w3.org/2000/svg viewbox = "0 0 496 512" > <!-- Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc. --> < path d = "M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8M97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2" / > < / svg > < / a > < a href = https://ko-fi.com/headscale target = _blank rel = noopener title = ko-fi.com class = md-social__link > < svg xmlns = http://www.w3.org/2000/svg viewbox = "0 0 24 24" > < path d = "M2 21h18v-2H2M20 8h-2V5h2m0-2H4v10a4 4 0 0 0 4 4h6a4 4 0 0 0 4-4v-3h2a2 2 0 0 0 2-2V5a2 2 0 0 0-2-2" / > < / svg > < / a > < a href = https://github.com/juanfont/headscale/pkgs/container/headscale target = _blank rel = noopener title = github.com class = md-social__link > < svg xmlns = http://www.w3.org/2000/svg viewbox = "0 0 640 512" > <!-- Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc. --> < pa
