bbb8d0e263b0c3cad5a1c462a264e9cc1ef0fb0f
[zonemaker.git] / README.md
1 # zonemaker: Python DNS zone files
2
3 ## Introduction
4
5 This is [zonemaker](https://www.ralfj.de/projects/zonemaker), a tool
6 to generate DNS zone files from Python.
7
8 The plain zone file format is pretty limited. There are not even
9 variables, so in many cases IP addresses and other data has to be
10 repeated several times.  zonemaker is an attempt to provide more
11 flexibility, by allowing you to write your zones in Python. Hence all
12 the usuel fatures, like variables, macros (also known as functions)
13 and loops, are available to generate DNS zone data. At the same time,
14 zonemaker is reasonably simple and close to the actual structure of a
15 DNS zonefile, so it is suited for small setups. The output of
16 zonemaker is a standard zonefile, it can be used with any DNS server
17 supporting those.
18
19 ## Usage
20
21 Simply call `zonemaker` with the zone python file as argument. The
22 result will be printed to stdout. See `db.example.com.py` for a sample
23 file demonstrating the use of the interface. `Makefile.sample` shows
24 how a makefile which first updates the zone(s), and then tells BIND to
25 reload, could look like.
26
27 ## Source, License
28
29 You can find the sources in the
30 [git repository](https://git.ralfj.de/zonemaker.git) (also
31 available [on GitHub](https://github.com/RalfJung/zonemaker)).  They
32 are provided under a
33 [2-clause BSD license](http://opensource.org/licenses/bsd-license.php). See
34 the file `LICENSE-BSD` for more details.
35
36 ## Contact
37
38 If you found a bug, or want to leave a comment, please
39 [send me a mail](mailto:post-AT-ralfj-DOT-de).