From: Eugene Crosser <crosser@average.org>
Date: Sat, 5 Apr 2014 12:40:00 +0000 (+0400)
Subject: Write some actual doc
X-Git-Tag: 0.9.0.0~95
X-Git-Url: http://average.org/gitweb/?a=commitdiff_plain;h=d77bb5ba5f562ca2d83110b9ca5e7ff7bead185a;p=pdns-pipe-nmc.git

Write some actual doc
---

diff --git a/README.md b/README.md
index e67a534..2cf634d 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,81 @@
-# Namecoin pipe backend for PowerDNS
+% Namecoin pipe backend for PowerDNS
 
-There exists a [project](https://github.com/namecoin/nmcontrol) to
-create an all-in-one tool that can, among other things, act as a DNS
-server for the `.bit` zone. There is also a
-[tool](https://github.com/namecoin/NamecoinToBind) for offline
-conversion of namecoin data into BIND zone file.
+There exists a project named
+[nmcontrol](https://github.com/namecoin/nmcontrol) to create an
+all-in-one tool that can, among other things, act as a DNS server
+for the `.bit` zone. There is also a tool,
+[NamecoinToBind](https://github.com/namecoin/NamecoinToBind),
+for offline conversion of namecoin data into BIND zone file.
 
-Unlike that, this project is a single-purpose tool acting as a (real
-time) bridge between [Namecoin](https://namecoin.org/) and DNS.
+Unlike those, this project is a single-purpose tool acting as a (real
+time) bridge between [Namecoin](http://namecoin.info/) and DNS.
 [PowerDNS](https://www.powerdns.com/) provides a stable DNS frontend,
-with an easy to implement backend interface, which is used in this
-project.
+with an easy to implement backend interface. The latter is used in
+this project.
+
+## Building
+
+The program is built as a single executable to be run by PowerDns's
+pipe backend. It is written in [Haskell](http://www.haskell.org/).
+There is no `cabal` configuration at the moment, so to build it,
+simply run
+
+```
+ghc --make pdns-pipe-nmc
+```
+
+and install any missing packages it complains about.
+
+## Installing
+
+In the powerdns configuration, you want to specify `master=yes`.
+Enable `pipe` backend by setting `launch=pipe`.
+Wherever your pdns package keeps the backend configurations, set
+this for the pipe backend:
+
+```
+pipe-command=/path/to/pdns-pipe-nmc
+pipe-timeout=10000
+pipe-regex=.bit;.*$
+pipebackend-abi-version=1 ## all versions supported, but extra data ignored
+```
+
+Copy `pdns-pipe-nmc` to the place that you've set up as `pipe-command`.
+Copy your namecoin cofig file to `/etc/namecoin.conf` and make sure it
+is readable by the userid specified in the powerdns config. Entries
+recognized in the `/etc/namecoin.conf` file (with default values) are:
+
+```
+rpcuser=
+rpcpassword=
+rpchost=localhost
+rpcport=8336
+```
+
+They are the parameters needed to contact the `namecoind` server over
+its JsonRPC interface. With default installation on `localhost`, you
+will only need to specify `password`.
+
+## Security Considerations
+
+Namecoin per se has excellent non-repudiation characteristics. But
+once you've converted the data into (non-DNSSEC-protected) DNS
+format, all bets are off. If you intend to query your powerdns
+instance over public Internet, remember that nothing prevents evil
+hackers or ruthless governments from tampering with your queries
+and powerdns responses. There are two possible approaches to
+mitigation of this problem:
+
+* Run `namecoind` and the bridge as close to the consumer as
+possible: on the same host, or at least on the same network, and
+keep it guarded.
+* I did not try it, but it should be possible to use PowerDNS
+[Front-signing](http://doc.powerdns.com/html/dnssec-modes.html#dnssec-frontserver),
+so the communication will happen over DNSSEC protocol without the
+need to keep the signatures in the zone data itself. You probably
+would need to create signing key for the PowerDNS instance, and add
+the corresponding public key as "trused" into the configuration of
+your resolvers.
 
 ## Status
 
@@ -23,7 +88,8 @@ Alpha. It does not handle `SRV` records at all, does not support
 Check the [project homepage](http://www.average.org/pdns-pipe-nmc/).
 
 Git [clone](git://git.average.org/git/pdns-pipe-nmc.git) or
-[browse](http://www.average.org/gitweb/?p=pdns-pipe-nmc.git;a=summary).
+[browse](http://www.average.org/gitweb/?p=pdns-pipe-nmc.git;a=summary),
+or use [github mirrir](https://github.com/crosser/pdns-pipe-nmc).
 
 ## Author