[{"_1":2,"_151":-5,"_152":-5},"loaderData",{"_3":4,"_13":14,"_20":21,"_130":131},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","routes/_layout.r.$namespace.$reponame",{"_22":23,"_24":-5,"_25":11,"_26":11,"_27":28,"_29":30,"_31":-5,"_32":11,"_33":34,"_83":-5,"_84":85,"_123":-5,"_124":11,"_125":17,"_126":11,"_127":-5,"_128":129},"canonicalUrl","https://hub.docker.com/r/flukschander/zerotier-dns/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","flukschander","reponame","zerotier-dns","cloudBuildSource","isAutobuildsAvailable","repo",{"_35":36,"_37":38,"_40":41,"_42":43,"_44":11,"_45":46,"_47":48,"_49":50,"_52":30,"_27":28,"_53":54,"_55":39,"_56":57,"_58":59,"_60":61,"_62":-5,"_63":57,"_64":65,"_66":11,"_67":28,"_68":69,"_74":11,"_75":76,"_80":28,"_81":82},"categories",[],"content_types",[39],"image","date_registered","2020-10-21T09:03:46.03443Z","description","","is_private","last_updated","2020-10-23T11:35:39.880997Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[51],"application/vnd.docker.container.image.v1+json","name","pull_count",203,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","

\n zerotier-dns\n

\n\n

\n A DNS server for ZeroTier virtual networks.\n

\n\nThis is a fork of [uxbh/ztdns](https://github.com/uxbh/ztdns) / [johannrichard/zerotier-dns](https://github.com/johannrichard/zerotier-dns)\n\n\n\n## Features\n\n* Address members of ZeroTier networks by name\n* IPv4 and IPv6 support (A and AAAA records)\n* Create round-robin DNS names\n* Tiny Docker image for easy setup\n\n\n\n## Usage\nFirst, add a new API Access Token to your [ZeroTier account](https://my.zerotier.com/).\n\nTo start the server using the Docker image:\n\n```bash\ndocker run --rm \\\n -p 53:53/udp \\\n --volume $(pwd)/zerotier-dns.yml:/app/zerotier-dns.yml \\\n flukschander/zerotier-dns server --api-key API_KEY --network NETWORK_ID\n```\n\nwhere `API_KEY` is a ZeroTier API token and `NETWORK_ID` is a ZeroTier network ID.\nIf your ZeroTier network interface is not called `zt0`, then you should add `--interface=` (or `--interface=` to listen on all interfaces).\nIt is recommended to use a configuration file instead of these command-line arguments (see [\"Configuration\"](#configuration) section below).\n\nOnce the server is running you will be able to resolve ZeroTier member names by querying it directly:\n\n```bash\ndig @ .\n\n;; QUESTION SECTION:\n;matthews-mbp.zt. IN A\n\n;; ANSWER SECTION:\nmatthews-mbp.zt. 3600 IN A 192.168.192.120\n```\n\nNote that the DNS name is based on the ZeroTier member name (as shown in [ZeroTier Central](https://my.zerotier.com/network)), not the hostname of the member.\n\nIn order to resolve names normally, you need to get the server into the DNS lookup chain on all of your machines.\nIn practise this means either configuring the system resolver on each machine to use your `zerotier-dns` instance for your chosen domain (see instructions for [Linux](https://learn.hashicorp.com/consul/security-networking/forwarding#systemd-resolved-setup) or [macOS](https://learn.hashicorp.com/consul/security-networking/forwarding#macos-setup)), or configuring the DNS server each machine uses to delegate to your `zerotier-dns` instance for your chosen domain (see instructions for [dnsmasq](https://learn.hashicorp.com/consul/security-networking/forwarding#dnsmasq-setup) or [bind](https://learn.hashicorp.com/consul/security-networking/forwarding#bind-setup)).\n\n\n\n## Building from source\nTo build from source:\n\n``` bash\ngo get -u github.com/flukschander/zerotier-dns/\n# or\ngit clone https://github.com/flukschander/zerotier-dns.git\ncd zerotier-dns\ngo install\n# then\nzerotier-dns server --api-key API_KEY --network NETWORK_ID\n```\n\nIf 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.\nOn other operating systems, `zerotier-dns` may need to be run as an administrator.\nThis does not apply to the Docker image.\n\n\n\n## Installation as a service\nFor both of these methods it is assumed your configuration is stored in a configuration file, although this is not compulsory.\n\n\n### Docker\nTo install the server as a service using the Docker image:\n\n```bash\ndocker run --detach \\\n -p 53:53/udp \\\n --volume $(pwd)/zerotier-dns.yml:/app/zerotier-dns.yml \\\n --restart=unless-stopped \\\n --name=zerotier-dns flukschander/zerotier-dns\n```\n\n\n### Systemd\nTo install the server as a `systemd` service, create a file `/etc/systemd/system/zerotier-dns.service` containing:\n\n```ini\n[Unit]\nDescription=ZeroTier DNS Server\nAfter=network-online.target\nWants=network-online.target\n\n[Service]\nWorkingDirectory=\nExecStart=zerotier-dns server\nRestart=on-failure\nRestartSec=5\n\n[Install]\nWantedBy=multi-user.target\n```\n\nMake sure you set `WorkingDirectory` to the directory containing your configuration file.\n\nThen, to install the service:\n\n```bash\n# Reload service files\nsudo systemctl daemon-reload\n# Set zerotier-dns service to start on boot\nsudo systemctl enable zerotier-dns.service\n# Also start zerotier-dns service right now\nsudo systemctl start zerotier-dns.service\n```\n\nTo uninstall the service:\n\n```bash\n# Stop zerotier-dns service\nsudo systemctl stop zerotier-dns.service\n# Stop zerotier-dns service from starting on boot\nsudo systemctl disable zerotier-dns.service\n```\n\n\n\n## Configuration\n\n\n### Command-line options:\n```bash\n$ zerotier-dns server --help\nStart the zerotier-dns DNS server.\n\nUsage:\n zerotier-dns server [flags]\n\nFlags:\n --api-key string ZeroTier API key\n --api-url string ZeroTier API URL (default \"https://my.zerotier.com/api\")\n --domain string domain to serve names under (default \"zt\")\n -h, --help help for server\n --include-offline include offline members (default true)\n --interface string network interface to bind to (default \"zt0\")\n --network string ZeroTier Network ID\n --port int port to listen on (default 53)\n --refresh int how often to poll the ZeroTier controller in minutes (default 30)\n\nGlobal Flags:\n --config string config file (default is zerotier-dns.yml)\n --debug enable debug messages\n```\n\n\n### Config file\n`zerotier-dns` looks for `zerotier-dns.yml` in the current working directory or `$HOME`.\nThere is a `zerotier-dns.example.yml` example config file with all supported options and their default values:\n\n```yaml\n# Network interface to bind to (or \"\" to bind to all interfaces). By default, only\n# respond on the ZeroTier interface.\ninterface: \"zt0\"\n\n# Port to listen on.\nport: 53\n\n# Base domain. Could be a top-level domain for internal use only (e.g., zt) or\n# a domain name with one or more subdomains (e.g., internal.yourdomain.com).\n# By default, map members to \".zt\".\ndomain: \"zt\"\n\n# How often to poll the ZeroTier controller in minutes.\nrefresh: 30\n\n# Include members that are currently offline.\ninclude-offline: true\n\n# Enable debug messages.\ndebug: false\n\n# An API key for your ZeroTier account (required).\napi-key: \"\"\n\n# The base API URL for the ZeroTier controller.\napi-url: \"https://my.zerotier.com/api\"\n\n# ID of the ZeroTier network. Only one of \"network\" and \"networks\" can be\n# specified. E.g., if there is a network with ID \"123abc\" then this would map\n# its members to \".zt\":\n# network: \"123abc\"\nnetwork:\n\n# Mappings between subdomains and ZeroTier network IDs. Only one of \"network\"\n# and \"networks\" can be specified.\nnetworks:\n # E.g., if origin=\"zt\" and there is a network with ID \"123abc\" then this would\n # map its members to \".home.zt\":\n # home: \"123abc\"\n\n# Mappings between round-robin names and regexps to match members. Names are\n# matched within each network (i.e., if there are members matching a mapping in\n# multiple networks then the name will be defined separately in each).\nround-robin:\n # E.g., if the \"home\" network defined above had members \"k8s-node-23refw\" and\n # \"k8s-node-09sf8g\" this would create a name \"k8s-nodes.home.zt\" returning one\n # of them at random:\n # k8s-nodes: \"k8s-node-\\w\"\n```\n\nConfiguration 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).\nCommand-line options override both.\n\n\n\n## Contributing\n\nThanks for considering contributing to the project.\nWe welcome contributions, issues or requests from anyone, and are grateful for any help.\nProblems or questions?\nFeel free to open an issue on GitHub.\n\nPlease make sure your contributions adhere to the following guidelines:\n\n* Code must adhere to the [official Go formatting guidelines](https://golang.org/doc/effective_go.html#formatting) (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)).\n* Pull requests need to be based on and opened against the `master` branch.\n","has_starred","hub_user","immutable_tags_settings",{"_70":11,"_71":72},"enabled","rules",[73],".*","is_automated","permissions",{"_77":17,"_78":11,"_79":11},"read","write","admin","user","storage_size",12730104,"orgData","recentTags",[86],{"_87":39,"_88":89,"_90":91,"_92":93,"_94":95,"_45":112,"_113":89,"_114":28,"_115":51,"_52":116,"_117":118,"_119":103,"_120":112,"_121":61,"_122":17},"content_type","creator",2596978,"full_size",4553242,"id",122485555,"images",[96],{"_97":98,"_99":100,"_101":43,"_102":103,"_104":105,"_106":107,"_108":43,"_109":-5,"_110":91,"_58":61,"_111":-5},"architecture","amd64","digest","sha256:fa25ed1690dd1d233a3fefd55d690e502f8720b071daf8061a22c2656fb56113","features","last_pulled","2026-09-15T08:20:01.323687532Z","last_pushed","2020-10-23T11:35:40Z","os","linux","os_features","os_version","size","variant","2020-10-23T11:35:39.553881Z","last_updater","last_updater_username","media_type","latest","repository",10069059,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_33":132,"_139":140,"_128":149,"_150":11},{"_35":133,"_37":134,"_40":41,"_42":43,"_44":11,"_45":46,"_47":48,"_49":135,"_52":30,"_27":28,"_53":54,"_55":39,"_56":57,"_58":59,"_60":61,"_62":-5,"_63":57,"_64":65,"_66":11,"_67":28,"_68":136,"_74":11,"_75":138,"_80":28,"_81":82},[],[39],[51],{"_70":11,"_71":137},[73],{"_77":17,"_78":11,"_79":11},"tags",{"_141":59,"_142":-5,"_143":-5,"_144":145},"count","next","previous","results",[146],{"_87":39,"_88":89,"_90":91,"_92":93,"_94":147,"_45":112,"_113":89,"_114":28,"_115":51,"_52":116,"_117":118,"_119":103,"_120":112,"_121":61,"_122":17},[148],{"_97":98,"_99":100,"_101":43,"_102":103,"_104":105,"_106":107,"_108":43,"_109":-5,"_110":91,"_58":61,"_111":-5},[],"canDeleteTags","actionData","errors"]

flukschander/zerotier-dns

Tags for flukschander/zerotier-dns