summaryrefslogtreecommitdiff
path: root/contrib/peer2anonet/README
diff options
context:
space:
mode:
Diffstat (limited to 'contrib/peer2anonet/README')
-rw-r--r--contrib/peer2anonet/README82
1 files changed, 0 insertions, 82 deletions
diff --git a/contrib/peer2anonet/README b/contrib/peer2anonet/README
deleted file mode 100644
index 04feabb..0000000
--- a/contrib/peer2anonet/README
+++ /dev/null
@@ -1,82 +0,0 @@
-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/>.
-
-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:
-
- make install
-
- To uninstall peer2anonet, as root do:
-
- make uninstall
-
- To compile/install a .deb package, as root do:
-
- make install-deb
-
-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'.
-
-================== 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 ============================
-
- 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.
-
-
-