aboutsummaryrefslogtreecommitdiff
path: root/usr/share/updatezone/docs
diff options
context:
space:
mode:
Diffstat (limited to 'usr/share/updatezone/docs')
-rw-r--r--usr/share/updatezone/docs/README.txt28
1 files changed, 27 insertions, 1 deletions
diff --git a/usr/share/updatezone/docs/README.txt b/usr/share/updatezone/docs/README.txt
index 0e9ac28..76bb4b4 100644
--- a/usr/share/updatezone/docs/README.txt
+++ b/usr/share/updatezone/docs/README.txt
@@ -10,11 +10,37 @@ Improve:
Document: Below this line
### WELCOME
+Updatezone provides an easy way to update dns zone files. Intended primarily for bind9 zone files, experimentation is encouraged.
+Instead of running the series of commands manually: rndc freeze, vi zonefile, rndc thaw and so on, use updatezone.
+
+### CONFIGURATION
+The conf files belong in /etc/updatezone/. See example in /usr/share/updatezone/examples/.
+
+### USING THIS TOOL
+
+$ updatezone ipa.smith122.com
+Where this file exists: /etc/updatezone/ipa.smith122.com.conf
+
+ UZ_ZONE_NAME=ipa.smith122.com
+ UZ_FORWARD_ZONE=ipa.smith122.com
+ UZ_FORWARD_FILE=/var/named/data/db.ipa.smith122.com
+ UZ_REVERSE_ZONE=1.168.192.in-addr.arpa
+ UZ_REVERSE_FILE=/var/named/data/db.192.168.1
+ UZ_SLAVE_COUNT=1
+ UZ_SLAVE_1=dns2
+
+The updatezone tool searches for the value of UZ_ZONE_NAME to declare a match and use that configuration file.
+The zone definitions are used in the freeze/thaw/retransfer commands.
+
+This tool will only request updates for zones that are updated. Also, you do not need to adjust the serial number at all. The script will detect changes and then increment the serial number for you.
+
+You can also specify multiple zones on the command line.
+$ updatezone ipa.smith122.com ad.smith122.com
### NOTES
### REFERENCE
### CHANGELOG
-2017-05-26 B Stack <bgstack15@gmail.com> 0.0-1
+2017-05-27 B Stack <bgstack15@gmail.com> 0.0-1
- Initial package construction
bgstack15