Mercurial > hg > anonet-resdb

comparison contrib/peer2anonet/README @ 771:d76deb2af72f draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
updated peer2anonet
author d3v11 <d3v11@d3v11.ano>
date Thu, 24 Nov 2011 21:38:40 +0000
parents d76cc244e016
children 1ba55b415d50
comparison
equal deleted inserted replaced
770:2587c6d6204a 771:d76deb2af72f
1 SYNOPSIS:
2 # Generate Keys:
3 quicktun.keypair</dev/random
4
5 # Interactive prompt:
6 peer2anonet
7
8 # Accept pipe from file:
9 peer2anonet < autoconfig.txt
10
11 # Accept netcat pipe:
12 nc -l 1337 | peer2anonet
13
14 # Send a netcat pipe:
15 nc 1337 192.168.1.0 < autoconfig.txt
16
17 DESCRIPTION: 1 DESCRIPTION:
18 peer2anonet is an autoconfiguration utility to easily establish a 2 peer2anonet is an autoconfiguration utility to easily establish a
19 peering session with BGP on anonet2. 3 peering session with BGP on AnoNet2.
20
21 LICENSE:
22 This program is free software: you can redistribute it and/or modify
23 it under the terms of the GNU General Public License as published by
24 the Free Software Foundation, either version 3 of the License, or
25 (at your option) any later version.
26
27 This program is distributed in the hope that it will be useful,
28 but WITHOUT ANY WARRANTY; without even the implied warranty of
29 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
30 GNU General Public License for more details.
31
32 You should have received a copy of the GNU General Public License
33 along with this program. If not, see <http://www.gnu.org/licenses/>.
34 4
35 DEPENDS ON: 5 DEPENDS ON:
36 quicktun, bird, daemontools(non-deb), bash 6 quicktun, bird, daemontools(non-deb), bash
37 7
38 INSTALL AND UNINSTALL: 8 USAGE:
39 ******************************************************************
40 * PEER2ANONET CAN AND WILL OVERWRITE /service AND /services, TO *
41 * INCLUDE FILES WITHIN THOSE DIRECTORIES. PLEASE CREATE BACKUPS *
42 * BEFORE INSTALLING AND USING PEER2ANONET AT ANY TIME! *
43 ******************************************************************
44 9
45 To install, `cd' to the extracted peer2anonet folder. 10 --configure generate a new local configuration and exit
46 Issue the following commands as root:
47 11
48 make install 12 --update regenerate peer configurations
49 13
50 To uninstall peer2anonet, as root do: 14 --configure-peer generate a new peer configuration and update
51 15
52 make uninstall 16 --rm-peer remove a peer configuration and update
53 17
54 To compile/install a .deb package, as root do:
55 18
56 make install-deb
57
58 USAGE:
59 You may execute peer2anonet and answer configuration questions
60 via interface or pipe a file containing the new peering
61 session's specifications to the executable. peer2anonet has
62 some security checks but it is highly recommended you check
63 a autoconfig file manually before using to prevent malicious
64 attacks. An autoconfig file should be in the following format:
65 Plain text file, one block of data per line, no spaces, and
66 without including the following '<-- comments'.
67
68 ================== Not Actual Line on File ============================
69 anon <--your peer's alias
70 11.22.33.44 <--your peer's remote ip
71 1.2.3.4 <--your peer's anonet ip
72 4321 <--your peer's client port
73 1234 <--your peer's asn
74 3c6e0b8a9c15224a8228b9a98ca1531d <--your peer's public key
75 ================== Not Actual Line on File ============================
76
77 At your discretion, you may exclude the public key from the
78 bottom of an autoconfig file and post installation of your new
79 peer service, peer2anonet will prompt foor it.
80 19
81 20
82 21