From 8307feb012e94c2a4b43b9a5b42dacedab2725ca Mon Sep 17 00:00:00 2001
From: d3v11 <d3v11@d3v11.ano>
Date: Sat, 26 Nov 2011 05:16:10 +0000
Subject: massive update to peer2anonet, here's hoping i didn't fuck something
 up ;-)

---
 contrib/peer2anonet/README | 107 +++++++++++++++++++++++++++++++--------------
 1 file changed, 74 insertions(+), 33 deletions(-)

(limited to 'contrib/peer2anonet/README')

diff --git a/contrib/peer2anonet/README b/contrib/peer2anonet/README
index 8b8eacf..1b300b4 100644
--- a/contrib/peer2anonet/README
+++ b/contrib/peer2anonet/README
@@ -1,64 +1,105 @@
 DESCRIPTION:
-     peer2anonet is an autoconfiguration utility to easily establish a
-     peering session with BGP on AnoNet2.
+
+    peer2anonet is an autoconfiguration utility for setting
+    up core services on AnoNet2. Enjoy :-).
 
 DEPENDS ON:
-      quicktun, bird, daemontools(non-deb), bash
 
-USAGE:
+    quicktun, bird, daemontools(non-deb), bash
+
+AUTHOR:
+
+    d3v11 from www.d3v11.ano somtimes, maybe, dunno.
+
+    REPORT BULLSHIT TO:
 
-    --configure             generate a new local configuration and exit
+        IRC:
+        
+            /relayhell/d3v11
 
-    --update                regenerate peer configurations
+        EMAIL:
+        
+            d3v11@d3v11.ano
 
-    --configure-peer        generate a new peer configuration and update
+USAGE:
+
+    ./contrib/peer2anonet/peer2anonet --configure             generate a new local configuration and exit
 
-    --rm-peer               remove a peer configuration and update
+    ./contrib/peer2anonet/peer2anonet --update                regenerate peer configurations
 
-    --install-daemontools   installs daemontools
+    ./contrib/peer2anonet/peer2anonet --configure-peer        generate a new peer configuration and update
 
-    --install-ucspi-tcp     installs ucspi-tcp
+    ./contrib/peer2anonet/peer2anonet --rm-peer               remove a peer configuration and update
 
-    --install-djbdns        installs djbdns
+    ./contrib/peer2anonet/peer2anonet --install-daemontools   installs daemontools
 
-NOTES:
+    ./contrib/peer2anonet/peer2anonet --install-ucspi-tcp     installs ucspi-tcp
 
-    KEY PAIRS:
+    ./contrib/peer2anonet/peer2anonet --install-djbdns        installs djbdns
 
-        before running peer2anonet to configure peers you can use
-        quicktun to generate keypairs:
+    ./contrib/peer2anonet/peer2anonet --configure-dns         configures dnscache and tinydns zones
 
-            quicktun.keypair</dev/random
+RTFM:
 
-    RUN CHANGES:
+    CONFIGURE:
 
-        peer2anonet exports the /service/$PEER/run file to
-        /etc/peer2anonet/peers/$PEER/run. If you need to
-        create customizations for peerings then make adjustments
-        to that file.
+        I highly recommend that before you use peer2anonet
+        you ./configure resdb with tinydns support.
 
-    EXAMPLES:
+        ./contrib/peer2anonet/peer2anonet --configure
 
-        ./peer2anonet --configure
+        EXAMPLES:
 
             Enter your AnoNet subnet: 1.2.3.0
             Enter your AnoNet router: 1.2.3.1
             Enter your peering ip: 1.2.3.4
             Enter your AnoNet asn: 1234
 
+    CONFIGURE PEER:
+
+        ./contrib/peer2anonet/peer2anonet --configure-peer
+
+            KEY PAIRS:
+
+                before running peer2anonet to configure peers you can use
+                quicktun to generate keypairs:
+
+                    quicktun.keypair</dev/random
+
+            CLIENT PORT:
+
+                peer2anonet uses '20' plus the first four digits of your peer's asn
+                as the `clientport'.
+
+                LOCAL_PORT=20${PEERASN:0:4}
+
+            EXAMPLES:
+
+                Enter your peer's name: d3v11
+                Enter your peer's remote ip: 11.11.55.1
+                Enter your peer's peering ip: 1.1.5.2
+                Enter your peer's remote port: 201150
+                Enter your peer's asn: 1150
+                Enter your peer's public key: * see KEY PAIRS above *
+                Enter your private key: * see KEY PAIRS above *
+
+            RUN CHANGES:
+
+                peer2anonet exports the /service/$PEER/run file to
+                /etc/peer2anonet/peers/$PEER/run. If you need to
+                create customizations for peerings then make adjustments
+                to that file.
+
+    CONFIGURE DNS:
 
-        ./peer2anonet --configure-peer
+        If you did not ./configure resdb with tinydns support
+        then you need to do that before using this function.
 
-            Enter your peer's name: d3v11
-            Enter your peer's remote ip: 11.11.55.1
-            Enter your peer's peering ip: 1.1.5.2
-            Enter your peer's remote port: 201150
-            Enter your peer's asn: 1150
-            Enter your peer's public key: * see keypairs above *
-            Enter your private key: * see keypairs above *
+        also before using you will need to have installed
+        daemontools, djbdns, and ucspi-tcp. peer2anonet
+        can do this for you with --install-* options.
 
-            # peer2anonet uses the following for port configurations:
-            LOCAL_PORT=20${PEERASN:0:4}
+        ./contrib/peer2anonet/peer2anonet --configure-dns
 
 
 
-- 
cgit v1.2.3