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