From: Ralf Jung Date: Fri, 14 Nov 2014 14:42:56 +0000 (+0100) Subject: more README work X-Git-Url: https://git.ralfj.de/zonemaker.git/commitdiff_plain/7828648381f1cfde47e414dbcdc0872f871f11ef more README work --- diff --git a/Makefile.sample b/Makefile.sample new file mode 100644 index 0000000..074133d --- /dev/null +++ b/Makefile.sample @@ -0,0 +1,3 @@ +db.example.com: db.example.com.py + @sudo -u user ~user/zonemaker/zone-maker $< | tee $@ + @rndc reload example.com diff --git a/README.rst b/README.rst index 733f3ba..128bee6 100644 --- a/README.rst +++ b/README.rst @@ -6,18 +6,24 @@ Introduction This is zonemaker_, a tool to generate DNS zone files from Python. -The plain zone file format is pretty limited. There are not even variables, so in many cases IP addresses and other data has to be repeated several times. -zonemaker is an attempt to provide more flexibility, by allowing you to write your zones in Python. -Hence all the usuel fatures, like variables, macros (aka functions) and loops, are available to generate DNS zone data. -At the same time, zonemaker is reasonably simple and close to the actual structure of a DNS zonefile, so it is suited for small setups. -The output of zonemaker is a standard zonefile, so it can be used with any DNS server supporting those. +The plain zone file format is pretty limited. There are not even variables, so +in many cases IP addresses and other data has to be repeated several times. +zonemaker is an attempt to provide more flexibility, by allowing you to write +your zones in Python. Hence all the usuel fatures, like variables, macros (aka +functions) and loops, are available to generate DNS zone data. At the same time, +zonemaker is reasonably simple and close to the actual structure of a DNS +zonefile, so it is suited for small setups. The output of zonemaker is a +standard zonefile, so it can be used with any DNS server supporting those. .. _dyn-nsupdate: https://www.ralfj.de/projects/zonemaker Usage ----- -TODO +Simply call ``zonemaker`` with the zone python file as argument. The result will +be printed to stdout. See ``db.example.com.py`` for a sample file demonstrating +the use of the interface. ``Makefile.sample`` shows how a makefile which first +updates the zone, and then tells BIND to reload, could look like. Source, License ---------------