aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.md38
1 files changed, 35 insertions, 3 deletions
diff --git a/README.md b/README.md
index d00ff1e..978403c 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,50 @@
DDNS.py
=======
-DDNS.py is a frontend for dynamic dns, with the goal of mirroring
+DDNS.py is a web frontend for dynamic dns, with the goal of mirroring
existing APIs so any dyndns client can be used. Currently it only has
-a very limited support of the dyn.com API.
+support for a very limited subset of the dyn.com API.
This is currently very experimental...
Dependencies (under Debian)
---------------------------
-* python-dns
+* python-dnspython
* python-flask
* python-yaml
* python-ipy
+Configuration
+-------------
+The configuration is done in the yaml format.
+
+example config:
+ users:
+ - username: user1
+ password: pass1
+ hash: None
+ - username: user2
+ password: pass2
+ hash: None
+
+ dnskeys:
+ - name: test-key
+ key: the_key_itself
+ algorithm: HMAC-MD5
+
+ zones:
+ - name: example.com.
+ ns: ns.example.com
+ key: test-key
+ domains:
+ - domain: test1 # test1.example.com
+ users:
+ - user1
+ - domain: test2 # test2.example.com
+ users:
+ - user1
+ - user2
+
+
<!--
vim: tw=70
-->