From 12cc61913cab58125febd21337b879a92b7f61c9 Mon Sep 17 00:00:00 2001 From: d3v11 Date: Sun, 15 Jan 2012 22:40:56 +0000 Subject: peer2anonet: fix potential for unexecutable rc.local bug, added visual support to README for guys with small terminals. --- contrib/peer2anonet/README.html | 173 +++++++++++++++++----------------------- 1 file changed, 75 insertions(+), 98 deletions(-) (limited to 'contrib/peer2anonet/README.html') diff --git a/contrib/peer2anonet/README.html b/contrib/peer2anonet/README.html index 6afc4bd..4fb5721 100644 --- a/contrib/peer2anonet/README.html +++ b/contrib/peer2anonet/README.html @@ -2,148 +2,125 @@ 
 DESCRIPTION:
 
-    peer2anonet is an autoconfiguration utility for setting
-    up core services on AnoNet2. Enjoy :-).
+    peer2anonet is an autoconfiguration utility for
+    setting up core services on AnoNet2. Enjoy :-).
 
 DEPENDS ON:
 
-    quicktun, bird, bash for now. it also installs some cool shit
-    that you'll use later.
+    quicktun, bird, bash for now. it also installs
+    some cool shit that you'll use later.
 
 AUTHOR:
 
     d3v11 from www.d3v11.ano, somtimes, maybe, dunno.
 
-    REPORT BULLSHIT TO:
-
-        IRC:
+REPORT BULLSHIT TO:
         
-            /relayhell/d3v11
+    /relayhell/d3v11
 
-        EMAIL:
-        
-            d3v11@d3v11.ano
+    d3v11@d3v11.ano
 
 USAGE:
 
-    From $RESDB_ROOT do:
-
-        ./contrib/peer2anonet/peer2anonet --configure             generate a new local configuration and exit
-
-        ./contrib/peer2anonet/peer2anonet --update                regenerate peer configurations
-
-        ./contrib/peer2anonet/peer2anonet --configure-peer        generate a new peer configuration and update
-
-        ./contrib/peer2anonet/peer2anonet --rm-peer               remove a peer configuration and update
-
-        ./contrib/peer2anonet/peer2anonet --install-daemontools   installs daemontools
+    ./contrib/peer2anonet/peer2anonet --help
+    ./contrib/peer2anonet/peer2anonet --rtfm
 
-        ./contrib/peer2anonet/peer2anonet --install-ucspi-tcp     installs ucspi-tcp
+TORIFY:
 
-        ./contrib/peer2anonet/peer2anonet --install-djbdns        installs djbdns
+    --install-* flags should be compatible with Tor:
 
-        ./contrib/peer2anonet/peer2anonet --install-nacl          installs nacl
+    export http_proxy='http://127.0.0.1:8118/'
+    ./contrib/peer2anonet/peer2anonet --install-*
 
-        ./contrib/peer2anonet/peer2anonet --configure-dns         configures dnscache and tinydns zones
+    torify ./contrib/peer2anonet/peer2anonet --install-*
 
-        ./contrib/peer2anonet/peer2anonet --update-dns            updates tinydns-ano zone
+    usewithtor ./contrib/peer2anonet/peer2anonet --install-*
 
-RTFM:
+CONFIGURE:
 
-    TORIFY:
+    I highly recommend that before you use peer2anonet
+    you ./configure resdb with tinydns support.
 
-        --install-* flags should be compatible with Tor:
+    ./contrib/peer2anonet/peer2anonet --configure
 
-        export http_proxy='http://127.0.0.1:8118/'
-        ./contrib/peer2anonet/peer2anonet --install-*
+    EXAMPLES:
 
-        torify ./contrib/peer2anonet/peer2anonet --install-*
+        Enter your AnoNet subnet: 1.1.5.0
+        Enter your AnoNet router: 1.1.5.1
+        Enter your peering ip: 1.1.5.2
+        Enter your AnoNet asn: 1150
 
-        usewithtor ./contrib/peer2anonet/peer2anonet --install-*
+CONFIGURE PEER:
 
-    CONFIGURE:
+    ./contrib/peer2anonet/peer2anonet --configure-peer
 
-        I highly recommend that before you use peer2anonet
-        you ./configure resdb with tinydns support.
+    KEY PAIRS:
 
-        ./contrib/peer2anonet/peer2anonet --configure
+        before running peer2anonet to configure peers
+        you can use quicktun to generate keypairs:
 
-        EXAMPLES:
+        quicktun.keypair < /dev/random
 
-            Enter your AnoNet subnet: 1.1.5.0
-            Enter your AnoNet router: 1.1.5.1
-            Enter your peering ip: 1.1.5.2
-            Enter your AnoNet asn: 1150
+    EXAMPLES:
 
-    CONFIGURE PEER:
+        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: 21150
+        Enter your local port: 61150
+        Enter your peer's asn: 1150
+        Enter your peer's public key: * see KEY PAIRS above *
+        Enter your private key: * see KEY PAIRS above *
 
-        ./contrib/peer2anonet/peer2anonet --configure-peer
+    /SERVICE/$PEER/RUN CHANGES:
 
-            KEY PAIRS:
+        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.
 
-                before running peer2anonet to configure peers you can use
-                quicktun to generate keypairs:
+    CONFIGURATION FILES:
 
-                    quicktun.keypair < /dev/random
+        If /etc/peer2anonet/bird.conf exists, then
+        peer2anonet will not create a new bird. Instead
+        it will use this bird.conf and append new protocols
+        to it. 
 
-            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: 21150
-                Enter your local port: 61150
-                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.
-
-            CONFIGURATION FILES:
-
-                If /etc/peer2anonet/bird.conf exists, then peer2anonet
-                will not create a new bird. Instead it will use this
-                bird.conf and append new protocols to it. 
-
-                /etc/peer2anonet/peers/$PEER/* contains:
+        /etc/peer2anonet/peers/$PEER/* contains:
                 
-                    asn  local_port  peering_ip  pubkey  remote_ip  remote_port  run  seckey
-
-                In the event you want to reconfigure a peer's tunnel you can alter the run
-                file and do `--update', rm run and modify the above files then use `--update',
-                or reconfigure the peering tunnel altogether with --configure-peer and choose
-                that peer's name. If you think this is absurd then you're probably right! I 
-                plan on doing something with these files later.
+        asn  local_port  peering_ip  pubkey
+        remote_ip  remote_port  run  seckey
 
-    CONFIGURE DNS:
+        In the event you want to reconfigure a peer's tunnel
+        you can alter the run file and do `--update', rm run
+        and modify the above files then use `--update',  or
+        reconfigure the peering tunnel altogether with
+        --configure-peer and choose that peer's name. If you
+        think this is absurd then you're probably right! I 
+        plan on doing something with these files later.
 
-        If you did not ./configure resdb with tinydns support
-        then you need to do that before using this function.
+CONFIGURE DNS:
 
-        also before using you will need to have installed
-        daemontools, djbdns, and ucspi-tcp. peer2anonet
-        can do this for you with --install-* options.
+    If you did not ./configure resdb with tinydns support
+    then you need to do that before using this function.
 
-        ./contrib/peer2anonet/peer2anonet --configure-dns
+    also before using you will need to have installed
+    daemontools, djbdns, and ucspi-tcp. peer2anonet
+    can do this for you with --install-* options.
 
-        UPDATE DNS:
+    ./contrib/peer2anonet/peer2anonet --configure-dns
 
-            After a successful `--configure-dns', you can now
-            enjoy to use `--update-dns' to bring your AnoNet
-            domains up to speed.
+UPDATE DNS:
 
-    COMPLAIN:
+    After a successful `--configure-dns', you can now
+    enjoy to use `--update-dns' to bring your AnoNet
+    domains up to speed.
 
-        If this README doesn't tell you what you need to know
-        you can head over to www.d3v11.ano/peering. If that
-        doesn't get you what you want then either complain to
-        me or shoot both of us in the face.
+COMPLAIN:
 
+    If this README doesn't tell you what you need to know
+    you can head over to www.d3v11.ano/peering. If that
+    doesn't get you what you want then either complain to
+    me or shoot both of us in the face.
 
-
-- cgit v1.2.3