From 70610fc05434d331db7f885c9bc8f1df270a6bee Mon Sep 17 00:00:00 2001
From: Jeffrey Forman <jeff@jeffreyforman.net>
Date: Fri, 15 Apr 2011 19:17:35 -0400
Subject: [PATCH] Convert Readme into markdown document

---
 README          | 26 --------------------------
 README.markdown | 40 ++++++++++++++++++++++++++++++++++++++++
 2 files changed, 40 insertions(+), 26 deletions(-)
 delete mode 100644 README
 create mode 100644 README.markdown

diff --git a/README b/README
deleted file mode 100644
index dc159c0..0000000
--- a/README
+++ /dev/null
@@ -1,26 +0,0 @@
-Write a Django UI to manage BIND DNS Zones.
-
-Models:
-* tsig keys
-  * name
-  * key text
-  Methods:
-    * add key
-    * delete key
-* dns server
-  * alias
-  * hostname
-  Methods:
-    * list records
-    * delete record
-    * add record
-    * lookup record
-
-Forms:
-* print zone
-* edit zone
-  * do we just let user add/delete a record
-* perform lookup?
-
-Todo:
-* Be able to input tsig key into form and save in db. Then associate bind server with key. (Down to zone level?)
diff --git a/README.markdown b/README.markdown
new file mode 100644
index 0000000..2799658
--- /dev/null
+++ b/README.markdown
@@ -0,0 +1,40 @@
+# Binder #
+
+Home: 
+A Django web application for viewing and (hopefully some day) editing your BIND DNS Zones.
+
+## Requirements ##
+
+Packages:
+
+* [Django](http://www.djangoproject.com)
+* Python
+ * [Beautiful Soup](http://www.crummy.com/software/BeautifulSoup/)
+ * [dns python](http://www.dnspython.org/)
+* [Bind DNS Server](http://www.isc.org/software/bind). At least version 9.5.x, which is needed for gathering remote statistics.
+
+## Installation & Configuration ##
+
+### BIND Name Servers ###
+
+In each of the BIND servers you wish to be able to query, the following stanza will be needed in your named.conf:
+
+    statistics-channels {
+        inet * port 853 allow { localhost; 10.10.0.0/24; };
+    };
+
+This tells BIND to listen on all available interfaces on port 853. There is a simple ACL allowing localhost and the noted subnet, 10.10.0.0/24, to access statistics. This can be verified by querying your DNS server with your perferred web browser at [http://dnsserver:853](http://dnsserver:853/)
+
+### Django Application ###
+
+Deploy the Django application as you see fit, and create the database via `manage.py syncdb`.
+
+Using the Admin UI, add each DNS Server to the 'Bind Servers' model under the bcommon app.
+
+Once you have completed this, surf over to the URL where the binder Django app is installed and enjoy. 
+
+
+## Todo ##
+
+* Associate Keys with DNS Servers
+ * Should we auto-populate the DB with a DNS Server's zones upon add?