diff --git a/README.md b/README.md new file mode 100644 index 0000000..59d088b --- /dev/null +++ b/README.md @@ -0,0 +1,10 @@ +# DNS Masq Netbox updater + +NetBox updater service is designed to function +as a simple webserver waiting for WebHook calls +from a NetBox instance. After receiving `GET /update-dnsmasq` +API query it calls NetBox, lists all defined IP addresses +with DNS names and creates a new `/etc/dnsmasq.d/netbox.conf` +file. The file defines all retrieved hosts as `A` records. +Then the **dnsmasq.service** is restarted. +