Skip to content

Latest commit

 

History

History
249 lines (180 loc) · 8.88 KB

README.md

File metadata and controls

249 lines (180 loc) · 8.88 KB
Raw

zerotier-dns

A DNS server for ZeroTier virtual networks.

Github Actions

This is a fork of uxbh/ztdns.

Features

  • Address members of ZeroTier networks by name
  • IPv4 and IPv6 support (A and AAAA records)
  • Create round-robin DNS names
  • Tiny Docker image for easy setup

Usage

First, add a new API Access Token to your ZeroTier account.

To start the server using the Docker image:

docker run --rm \
  -p 53:53/udp \
  --volume $(pwd)/zerotier-dns.yml:/app/zerotier-dns.yml \
  mjenz/zerotier-dns server --api-key API_KEY --network NETWORK_ID

where API_KEY is a ZeroTier API token and NETWORK_ID is a ZeroTier network ID. If your ZeroTier network interface is not called zt0, then you should add --interface=<your ZeroTier interface> (or --interface= to listen on all interfaces). It is recommended to use a configuration file instead of these command-line arguments (see "Configuration" section below). On a machine with systemd-resolved, you may need to use --network=host instead of -p 53:53 to prevent the Docker daemon from fighting over port 53.

Once the server is running you will be able to resolve ZeroTier member names by querying it directly:

dig @<server address> <member name>.<domain>

;; QUESTION SECTION:
;matthews-mbp.zt.   IN  A

;; ANSWER SECTION:
matthews-mbp.zt.  3600  IN  A 192.168.192.120

Note that the DNS name is based on the ZeroTier member name (as shown in ZeroTier Central), not the hostname of the member.

In order to resolve names normally, you need to get the server into the DNS lookup chain on all of your machines. As of ZeroTier 1.6, you can configure the ZeroTier controller to push a split DNS configuration to clients when they connect. In the "DNS" box in the "Advanced" section in ZeroTier Central, enter the IP address of the server and the domain you have configured. ZeroTier Central will not accept top-level domains: "yourdomain.com" is valid but "zt" is not. Clients must have the "Allow DNS" box checked in "Network Details". Note that on macOS, some command-line troubleshooting tools like dig and nslookup use their own DNS resolution logic which won't use the split DNS configuration (see this Stack Exchange answer).

To get the server into the DNS lookup chain for older clients, you can either configure the system resolver on each machine to use your zerotier-dns instance for your chosen domain (see instructions for Linux or macOS), or configure the DNS server each machine uses to delegate to your zerotier-dns instance for your chosen domain (see instructions for dnsmasq or bind).

Building from source

To build from source:

go get -u github.com/mje-nz/zerotier-dns/
# or
git clone https://github.com/mje-nz/zerotier-dns.git
cd zerotier-dns
go install
# then
zerotier-dns server --api-key API_KEY --network NETWORK_ID

If you are running on Linux, run sudo setcap cap_net_bind_service=+ep /go/bin/zerotier-dns to enable non-root users to bind privileged ports. On other operating systems, zerotier-dns may need to be run as an administrator. This does not apply to the Docker image.

Installation as a service

For both of these methods it is assumed your configuration is stored in a configuration file, although this is not compulsory.

Docker

To install the server as a service using the Docker image:

docker run --detach \
  -p 53:53/udp \
  --volume $(pwd)/zerotier-dns.yml:/app/zerotier-dns.yml \
  --restart=unless-stopped \
  --name=zerotier-dns mjenz/zerotier-dns

Systemd

To install the server as a systemd service, create a file /etc/systemd/system/zerotier-dns.service containing:

[Unit]
Description=ZeroTier DNS Server
After=network-online.target
Wants=network-online.target

[Service]
WorkingDirectory=<path containing config file>
ExecStart=zerotier-dns server
Restart=on-failure
RestartSec=5

[Install]
WantedBy=multi-user.target

Make sure you set WorkingDirectory to the directory containing your configuration file.

Then, to install the service:

# Reload service files
sudo systemctl daemon-reload
# Set zerotier-dns service to start on boot
sudo systemctl enable zerotier-dns.service
# Also start zerotier-dns service right now
sudo systemctl start zerotier-dns.service

To uninstall the service:

# Stop zerotier-dns service
sudo systemctl stop zerotier-dns.service
# Stop zerotier-dns service from starting on boot
sudo systemctl disable zerotier-dns.service

Configuration

Command-line options:

$ zerotier-dns server --help
Start the zerotier-dns DNS server.

Usage:
  zerotier-dns server [flags]

Flags:
      --api-key string     ZeroTier API key
      --api-url string     ZeroTier API URL (default "https://my.zerotier.com/api")
      --domain string      domain to serve names under (default "zt")
  -h, --help               help for server
      --include-offline    include offline members (default true)
      --interface string   network interface to bind to (default "zt0")
      --network string     ZeroTier Network ID
      --port int           port to listen on (default 53)
      --refresh int        how often to poll the ZeroTier controller in minutes (default 30)

Global Flags:
      --config string   config file (default is zerotier-dns.yml)
      --debug           enable debug messages

Config file

zerotier-dns looks for zerotier-dns.yml in the current working directory or $HOME. There is a zerotier-dns.example.yml example config file with all supported options and their default values:

# Network interface to bind to (or "" to bind to all interfaces).  By default, only
# respond on the ZeroTier interface.  On macOS, there are two ZeroTier interfaces
# whose names start with "feth" and you should specify the one with the lower number
# (see https://www.zerotier.com/2019/08/21/how-zerotier-eliminated-kernel-extensions-on-macos/ ).
interface: "zt0"

# Port to listen on.
port: 53

# Base domain.  Could be a top-level domain for internal use only (e.g., zt) or
# a domain name with one or more subdomains (e.g., internal.yourdomain.com).
# By default, map members to "<member name>.zt".
domain: "zt"

# How often to poll the ZeroTier controller in minutes.
refresh: 30

# Include members that are currently offline.
include-offline: true

# Enable debug messages.
debug: false

# An API key for your ZeroTier account (required).
api-key: ""

# The base API URL for the ZeroTier controller.
api-url: "https://my.zerotier.com/api"

# ID of the ZeroTier network.  Only one of "network" and "networks" can be
# specified.  E.g., if domain="zt" and there is a network with ID "123abc" then
# this would map its members to "<member name>.zt":
#   network: "123abc"
network:

# Mappings between subdomains and ZeroTier network IDs.  Only one of "network"
# and "networks" can be specified.
networks:
  # E.g., if domain="zt" and there is a network with ID "123abc" then this would
  # map its members to "<member name>.home.zt":
  #   home: "123abc"

# Mappings between round-robin names and regexps to match members.  Names are
# matched within each network (i.e., if there are members matching a mapping in
# multiple networks then the name will be defined separately in each).
round-robin:
  # E.g., if the "home" network defined above had members "k8s-node-23refw" and
  # "k8s-node-09sf8g" this would create a name "k8s-nodes.home.zt" returning one
  # of them at random:
  #   k8s-nodes: "k8s-node-\w"

Configuration options can be overridden using environment variables, where the variable name is "ZTDNS_" followed by the option's name in upper-case with hyphens changed to underscores (e.g., the api-url option is overridden by the ZTDNS_API_URL environment variable). Command-line options override both.

Contributing

Thanks for considering contributing to the project. We welcome contributions, issues or requests from anyone, and are grateful for any help. Problems or questions? Feel free to open an issue on GitHub.

Please make sure your contributions adhere to the following guidelines: