diff contrib/peer2anonet/README @ 771:d76deb2af72f draft

updated peer2anonet
author d3v11 <d3v11@d3v11.ano>
date Thu, 24 Nov 2011 21:38:40 +0000
parents d76cc244e016
children 1ba55b415d50
line wrap: on
line diff
--- a/contrib/peer2anonet/README	Mon Nov 21 19:50:39 2011 +0000
+++ b/contrib/peer2anonet/README	Thu Nov 24 21:38:40 2011 +0000
@@ -1,82 +1,21 @@
-SYNOPSIS:
-     # Generate Keys:
-     quicktun.keypair</dev/random
-
-     # Interactive prompt:
-     peer2anonet
-
-     # Accept pipe from file:
-     peer2anonet < autoconfig.txt 
-
-     # Accept netcat pipe:
-     nc -l 1337 | peer2anonet 
-
-     # Send a netcat pipe:
-     nc 1337 192.168.1.0 < autoconfig.txt 
-
 DESCRIPTION:
      peer2anonet is an autoconfiguration utility to easily establish a
-     peering session with BGP on anonet2.
-
-LICENSE:
-     This program is free software: you can redistribute it and/or modify
-     it under the terms of the GNU General Public License as published by
-     the Free Software Foundation, either version 3 of the License, or
-     (at your option) any later version.
-
-     This program is distributed in the hope that it will be useful,
-     but WITHOUT ANY WARRANTY; without even the implied warranty of
-     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-     GNU General Public License for more details.
-
-     You should have received a copy of the GNU General Public License
-     along with this program.  If not, see <http://www.gnu.org/licenses/>.
+     peering session with BGP on AnoNet2.
 
 DEPENDS ON:
       quicktun, bird, daemontools(non-deb), bash
 
-INSTALL AND UNINSTALL:
-    ******************************************************************
-    * PEER2ANONET CAN AND WILL OVERWRITE /service AND /services, TO  *
-    * INCLUDE FILES WITHIN THOSE DIRECTORIES. PLEASE CREATE BACKUPS  *
-    * BEFORE INSTALLING AND USING PEER2ANONET AT ANY TIME!           *
-    ******************************************************************
-
-      To install, `cd' to the extracted peer2anonet folder.
-      Issue the following commands as root:
+USAGE:
 
-      make install
-
-      To uninstall peer2anonet, as root do:
+    --configure         generate a new local configuration and exit
 
-      make uninstall
-
-      To compile/install a .deb package, as root do:
-
-      make install-deb
+    --update            regenerate peer configurations
 
-USAGE:
-      You may execute peer2anonet and answer configuration questions
-      via interface or pipe a file containing the new peering
-      session's specifications to the executable. peer2anonet has
-      some security checks but it is highly recommended you check
-      a autoconfig file manually before using to prevent malicious
-      attacks. An autoconfig file should be in the following format:
-      Plain text file, one block of data per line, no spaces, and
-      without including the following '<-- comments'.
+    --configure-peer    generate a new peer configuration and update
 
-================== Not Actual Line on File ============================
-anon          <--your peer's alias
-11.22.33.44   <--your peer's remote ip
-1.2.3.4       <--your peer's anonet ip
-4321          <--your peer's client port
-1234          <--your peer's asn
-3c6e0b8a9c15224a8228b9a98ca1531d <--your peer's public key
-================== Not Actual Line on File ============================
+    --rm-peer           remove a peer configuration and update
 
-     At your discretion, you may exclude the public key from the
-     bottom of an autoconfig file and post installation of your new
-     peer service, peer2anonet will prompt foor it.
+