aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMarius Halden <marius.h@lden.org>2014-03-18 02:40:51 +0100
committerMarius Halden <marius.h@lden.org>2014-03-18 02:40:51 +0100
commitc5b4c8d01e5bea040de19f30c66c798ae746f315 (patch)
treebfbfcfd98782f3d65c6b523ed905e022f583ad54
parent6f09cd6cbbb411be4db49c6458babf7ace1521a1 (diff)
downloadDDNS.py-c5b4c8d01e5bea040de19f30c66c798ae746f315.tar.gz
DDNS.py-c5b4c8d01e5bea040de19f30c66c798ae746f315.tar.bz2
DDNS.py-c5b4c8d01e5bea040de19f30c66c798ae746f315.tar.xz
Added additional info about config to README.md
-rw-r--r--README.md17
1 files changed, 15 insertions, 2 deletions
diff --git a/README.md b/README.md
index 1ffc9f3..2230218 100644
--- a/README.md
+++ b/README.md
@@ -15,10 +15,23 @@ Dependencies (under Debian)
Configuration
-------------
-The configuration is done in the yaml format.
+The configuration is done in the yaml format, and has three main
+sections. These are users, dnskeys, and zones.
-example config:
+### users
+This section contains a list of usernames and their passwords. It's
+possible to store the passwords hashed, but not salted, by specifying
+the hashing method used.
+### dnskeys
+The dnskeys section kontain a list of TSIG keys, their names and which
+algorithm they use.
+
+### zones
+This section is where all domains are specified as subsections for the
+zone they belong too.
+
+### Example config
users:
- username: user1
password: pass1