]> git.openstreetmap.org Git - dns.git/commitdiff
Update README.md
authorGrant <git@firefishy.com>
Wed, 8 Dec 2021 14:12:31 +0000 (14:12 +0000)
committerTom Hughes <tom@compton.nu>
Thu, 16 Dec 2021 20:40:47 +0000 (20:40 +0000)
Correct / improve the descriptions of the steps used.

README.md

index 0eec140522e82d7b26b24323998c04ad2cda8993..95cbcb836a87f00cecbeb5939e87c6e42832f663 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,14 +1,14 @@
 OpenStreetMap DNS
 ======================================
 
-This repository contains the DNS zone file templates and related code for managing OpenStreetMap.org and other domain names DNS. The full list of domains are in the [dnsconfig.js](dnsconfig.js) file.
+This repository contains the DNS zone templates and related code for managing OpenStreetMap.org and other domain names. The full list of domains managed by this repo are in the [dnsconfig.js](dnsconfig.js) file.
 
 ## Standard DNS Zone Files
 
-We use [dnscontrol](https://stackexchange.github.io/dnscontrol/) to manage the DNS zones. We have a few wrapper scripts which are called from the [Makefile](Makefile)
+We use [dnscontrol](https://stackexchange.github.io/dnscontrol/) to manage OpenStreetMap DNS. A set of wrapper scripts are used, which are called from the [Makefile](Makefile)
 
-On a repo commit, a git [post-receive](https://github.com/openstreetmap/chef/blob/master/cookbooks/dns/files/default/post-receive) runs `make update` via a [script](https://github.com/openstreetmap/chef/blob/master/cookbooks/dns/templates/default/dns-update.erb) which then pushes the updates the DNS zones on the authoritative DNS nameservers.
+Merges to the master branch trigger a git [post-receive](https://github.com/openstreetmap/chef/blob/master/cookbooks/dns/files/default/post-receive) which runs `make update` via a [script](https://github.com/openstreetmap/chef/blob/master/cookbooks/dns/templates/default/dns-update.erb), the DNS is then updated by dnscontrol.
 
 ## GeoDNS Zones
 
-For GeoDNS zones we use [gdnsd](https://gdnsd.org/).
\ No newline at end of file
+For GeoDNS zones we use [gdnsd](https://gdnsd.org/) with gdnsd config files generated by scripts called from the [Makefile](Makefile) file.