Synchronize your DNS to multiple providers from a simple DSL
Find a file
Patrick G fad98f73f4 Improve Route53 documentation (#221) (#234)
* Improve Route53 documentation

- Grammar fixes
- Formatting improvements
- Don't encourage using environment vars instead of the credentials file

* Add back sdk config link
2017-10-24 09:44:23 -04:00
build Namecheap take Provider (#202) 2017-10-03 11:53:56 -04:00
cmd/convertzone Add SPF flattening feature. (#126) 2017-09-29 15:30:36 -04:00
commands remove delay flag. providers should throttle themselves 2017-09-15 13:36:49 -04:00
docs Improve Route53 documentation (#221) (#234) 2017-10-24 09:44:23 -04:00
integrationTest DNSimple: handle pagination appropriately. (#242) 2017-10-18 13:53:44 -04:00
js/parse_tests Add SPF flattening feature. (#126) 2017-09-29 15:30:36 -04:00
models add initial URL support to namecheap provider (#237) 2017-10-23 12:54:31 -04:00
pkg add initial URL support to namecheap provider (#237) 2017-10-23 12:54:31 -04:00
providers Namecheap: switch throttling to only as needed. (#244) 2017-10-24 09:41:59 -04:00
vendor Added Vultr provider (#217) (#219) 2017-10-12 09:21:36 -04:00
.gitignore convert docker to alpine (#207) 2017-09-18 09:44:24 -04:00
.prettierrc Format helpers.js (#205) 2017-09-15 13:12:09 -04:00
.travis.yml yaml 2017-03-14 17:02:05 -07:00
build.ps1 Added build script for building packages on Windows 2016-11-16 09:22:45 -05:00
Dockerfile Add ca-certificates to Docker image (#211) 2017-09-26 12:02:01 -04:00
LICENSE migrate code for github 2016-08-22 18:31:50 -06:00
main.go bump version 2017-10-19 08:54:29 -04:00
README.md update README to include NS1 as a provider (#240) 2017-10-18 09:19:41 -04:00

DNSControl

Build Status Gitter chat Google Group chat

DNSControl is a system for maintaining DNS zones. It has two parts: a domain specific language (DSL) for describing DNS zones plus software that processes the DSL and pushes the resulting zones to DNS providers such as Route53, CloudFlare, and Gandi. It can talk to Microsoft ActiveDirectory and it generates the most beautiful BIND zone files ever. It runs anywhere Go runs (Linux, macOS, Windows). The provider model is extensible, so more providers can be added.

Currently supported DNS providers:

  • Active Directory
  • BIND
  • CloudFlare
  • Digitalocean
  • DNSimple
  • Gandi
  • Google
  • Namecheap
  • Name.com
  • NS1
  • Route 53
  • SoftLayer
  • Vultr

At Stack Overflow, we use this system to manage hundreds of domains and subdomains across multiple registrars and DNS providers.

You can think of it as a DNS compiler. The configuration files are written in a DSL that looks a lot like JavaScript. It is compiled to an intermediate representation (IR). Compiler back-ends use the IR to update your DNS zones on services such as Route53, CloudFlare, and Gandi, or systems such as BIND and ActiveDirectory.

An Example

dnsconfig.js:

// define our registrar and providers
var namecom = NewRegistrar("name.com", "NAMEDOTCOM");
var r53 = NewDnsProvider("r53", "ROUTE53")

D("example.com", namecom, DnsProvider(r53),
  A("@", "1.2.3.4"),
  CNAME("www","@"),
  MX("@",5,"mail.myserver.com."),
  A("test", "5.6.7.8")
)

Running dnscontrol preview will talk to the providers (here name.com as registrar and route 53 as the dns host), and determine what changes need to be made.

Running dnscontrol push will make those changes with the provider and my dns records will be correctly updated.

See Getting Started page on documentation site.

Benefits

  • Editing zone files is error-prone. Clicking buttons on a web page is irreproducible.
  • Switching DNS providers becomes a no-brainer. The DNSControl language is vendor-agnostic. If you use it to maintain your DNS zone records, you can switch between DNS providers easily. In fact, DNSControl will upload your DNS records to multiple providers, which means you can test one while switching to another. We've switched providers 3 times in three years and we've never lost a DNS record.
  • Adopt CI/CD principles to DNS! At StackOverflow we maintain our DNSControl configurations in Git and use our CI system to roll out changes. Keeping DNS information in a VCS means we have full history. Using CI enables us to include unit-tests and system-tests. Remember when you forgot to include a "." at the end of an MX record? We haven't had that problem since we included a test to make sure Tom doesn't make that mistake... again.
  • Variables save time! Assign an IP address to a constant and use the variable name throughout the file. Need to change the IP address globally? Just change the variable and "recompile."
  • Macros! Define your SPF records, MX records, or other repeated data once and re-use them for all domains.
  • Control CloudFlare from a single location. Enable/disable Cloudflare proxying (the "orange cloud" button) directly from your DNSControl files.
  • Keep similar domains in sync with transforms and other features. If one domain is supposed to be the same
  • It is extendable! All the DNS providers are written as plugins. Writing new plugins is very easy.

Installation

From source

DNSControl can be built with Go version 1.7 or higher. To install, simply run

go get github.com/StackExchange/dnscontrol

dnscontrol should be installed in $GOPATH/bin

Via packages

Get prebuilt binaries from github releases

Via docker

docker run --rm -it -v $(pwd)/dnsconfig.js:/dns/dnsconfig.js -v $(pwd)/creds.json:/dns/creds.json stackexchange/dnscontrol dnscontrol preview