comparison contrib/peer2anonet/README.html @ 884:cd9d07046b1c draft

peer2anonet: fix potential for unexecutable rc.local bug, added visual support to README for guys with small terminals.
author d3v11 <d3v11@d3v11.ano>
date Sun, 15 Jan 2012 22:40:56 +0000
parents 1fecd121452d
children c678f1f6a7e3
comparison
equal deleted inserted replaced
883:f4f941654717 884:cd9d07046b1c
1 <html><body bgcolor="#000000"><font color="white"> 1 <html><body bgcolor="#000000"><font color="white">
2 <pre> 2 <pre>
3 <b>DESCRIPTION:</b> 3 <b>DESCRIPTION:</b>
4 4
5 peer2anonet is an autoconfiguration utility for setting 5 peer2anonet is an autoconfiguration utility for
6 up core services on AnoNet2. Enjoy :-). 6 setting up core services on AnoNet2. Enjoy :-).
7 7
8 <b>DEPENDS ON:</b> 8 <b>DEPENDS ON:</b>
9 9
10 quicktun, bird, bash for now. it also installs some cool shit 10 quicktun, bird, bash for now. it also installs
11 that you'll use later. 11 some cool shit that you'll use later.
12 12
13 <b>AUTHOR:</b> 13 <b>AUTHOR:</b>
14 14
15 d3v11 from <a href="http://www.d3v11.ano/">www.d3v11.ano</a>, somtimes, maybe, dunno. 15 d3v11 from <a href="http://www.d3v11.ano/">www.d3v11.ano</a>, somtimes, maybe, dunno.
16 16
17 <b>REPORT BULLSHIT TO:</b> 17 <b>REPORT BULLSHIT TO:</b>
18
19 /relayhell/d3v11
18 20
19 <b>IRC:</b> 21 d3v11@d3v11.ano
20
21 /relayhell/d3v11
22
23 <b>EMAIL:</b>
24
25 d3v11@d3v11.ano
26 22
27 <b>USAGE:</b> 23 <b>USAGE:</b>
28 24
29 <b>From $RESDB_ROOT do:</b> 25 ./contrib/peer2anonet/peer2anonet --help
26 ./contrib/peer2anonet/peer2anonet --rtfm
30 27
31 ./contrib/peer2anonet/peer2anonet --configure generate a new local configuration and exit 28 <b>TORIFY:</b>
32 29
33 ./contrib/peer2anonet/peer2anonet --update regenerate peer configurations 30 --install-* flags should be compatible with Tor:
34 31
35 ./contrib/peer2anonet/peer2anonet --configure-peer generate a new peer configuration and update 32 export http_proxy='http://127.0.0.1:8118/'
33 ./contrib/peer2anonet/peer2anonet --install-*
36 34
37 ./contrib/peer2anonet/peer2anonet --rm-peer remove a peer configuration and update 35 torify ./contrib/peer2anonet/peer2anonet --install-*
38 36
39 ./contrib/peer2anonet/peer2anonet --install-daemontools installs daemontools 37 usewithtor ./contrib/peer2anonet/peer2anonet --install-*
40 38
41 ./contrib/peer2anonet/peer2anonet --install-ucspi-tcp installs ucspi-tcp 39 <b>CONFIGURE:</b>
42 40
43 ./contrib/peer2anonet/peer2anonet --install-djbdns installs djbdns 41 I highly recommend that before you use peer2anonet
42 you ./configure resdb with tinydns support.
44 43
45 ./contrib/peer2anonet/peer2anonet --install-nacl installs nacl 44 ./contrib/peer2anonet/peer2anonet --configure
46 45
47 ./contrib/peer2anonet/peer2anonet --configure-dns configures dnscache and tinydns zones 46 <b>EXAMPLES:</b>
48 47
49 ./contrib/peer2anonet/peer2anonet --update-dns updates tinydns-ano zone 48 Enter your AnoNet subnet: 1.1.5.0
49 Enter your AnoNet router: 1.1.5.1
50 Enter your peering ip: 1.1.5.2
51 Enter your AnoNet asn: 1150
50 52
51 <b>RTFM:</b> 53 <b>CONFIGURE PEER:</b>
52 54
53 <b>TORIFY:</b> 55 ./contrib/peer2anonet/peer2anonet --configure-peer
54 56
55 --install-* flags should be compatible with Tor: 57 <b>KEY PAIRS:</b>
56 58
57 export http_proxy='http://127.0.0.1:8118/' 59 before running peer2anonet to configure peers
58 ./contrib/peer2anonet/peer2anonet --install-* 60 you can use quicktun to generate keypairs:
59 61
60 torify ./contrib/peer2anonet/peer2anonet --install-* 62 quicktun.keypair < /dev/random
61 63
62 usewithtor ./contrib/peer2anonet/peer2anonet --install-* 64 <b>EXAMPLES:</b>
63 65
64 <b>CONFIGURE:</b> 66 Enter your peer's name: d3v11
67 Enter your peer's remote ip: 11.11.55.1
68 Enter your peer's peering ip: 1.1.5.2
69 Enter your peer's remote port: 21150
70 Enter your local port: 61150
71 Enter your peer's asn: 1150
72 Enter your peer's public key: * see KEY PAIRS above *
73 Enter your private key: * see KEY PAIRS above *
65 74
66 I highly recommend that before you use peer2anonet 75 <b>/SERVICE/$PEER/RUN CHANGES:</b>
67 you ./configure resdb with tinydns support.
68 76
69 ./contrib/peer2anonet/peer2anonet --configure 77 peer2anonet exports the /service/$PEER/run file to
78 /etc/peer2anonet/peers/$PEER/run. If you need to
79 create customizations for peerings then make
80 adjustments to that file.
70 81
71 <b>EXAMPLES:</b> 82 <b>CONFIGURATION FILES:</b>
72 83
73 Enter your AnoNet subnet: 1.1.5.0 84 If /etc/peer2anonet/bird.conf exists, then
74 Enter your AnoNet router: 1.1.5.1 85 peer2anonet will not create a new bird. Instead
75 Enter your peering ip: 1.1.5.2 86 it will use this bird.conf and append new protocols
76 Enter your AnoNet asn: 1150 87 to it.
77 88
78 <b>CONFIGURE PEER:</b> 89 /etc/peer2anonet/peers/$PEER/* contains:
90
91 asn local_port peering_ip pubkey
92 remote_ip remote_port run seckey
79 93
80 ./contrib/peer2anonet/peer2anonet --configure-peer 94 In the event you want to reconfigure a peer's tunnel
95 you can alter the run file and do `--update', rm run
96 and modify the above files then use `--update', or
97 reconfigure the peering tunnel altogether with
98 --configure-peer and choose that peer's name. If you
99 think this is absurd then you're probably right! I
100 plan on doing something with these files later.
81 101
82 <b>KEY PAIRS:</b> 102 <b>CONFIGURE DNS:</b>
83 103
84 before running peer2anonet to configure peers you can use 104 If you did not ./configure resdb with tinydns support
85 quicktun to generate keypairs: 105 then you need to do that before using this function.
86 106
87 quicktun.keypair < /dev/random 107 also before using you will need to have installed
108 daemontools, djbdns, and ucspi-tcp. peer2anonet
109 can do this for you with --install-* options.
88 110
89 <b>EXAMPLES:</b> 111 ./contrib/peer2anonet/peer2anonet --configure-dns
90 112
91 Enter your peer's name: d3v11 113 <b>UPDATE DNS:</b>
92 Enter your peer's remote ip: 11.11.55.1
93 Enter your peer's peering ip: 1.1.5.2
94 Enter your peer's remote port: 21150
95 Enter your local port: 61150
96 Enter your peer's asn: 1150
97 Enter your peer's public key: * see KEY PAIRS above *
98 Enter your private key: * see KEY PAIRS above *
99 114
100 <b>RUN CHANGES:</b> 115 After a successful `--configure-dns', you can now
116 enjoy to use `--update-dns' to bring your AnoNet
117 domains up to speed.
101 118
102 peer2anonet exports the /service/$PEER/run file to 119 <b>COMPLAIN:</b>
103 /etc/peer2anonet/peers/$PEER/run. If you need to
104 create customizations for peerings then make adjustments
105 to that file.
106 120
107 <b>CONFIGURATION FILES:</b> 121 If this README doesn't tell you what you need to know
122 you can head over to www.d3v11.ano/peering. If that
123 doesn't get you what you want then either complain to
124 me or shoot both of us in the face.
108 125
109 If /etc/peer2anonet/bird.conf exists, then peer2anonet
110 will not create a new bird. Instead it will use this
111 bird.conf and append new protocols to it.
112
113 /etc/peer2anonet/peers/$PEER/* contains:
114
115 asn local_port peering_ip pubkey remote_ip remote_port run seckey
116
117 In the event you want to reconfigure a peer's tunnel you can alter the run
118 file and do `--update', rm run and modify the above files then use `--update',
119 or reconfigure the peering tunnel altogether with --configure-peer and choose
120 that peer's name. If you think this is absurd then you're probably right! I
121 plan on doing something with these files later.
122
123 <b>CONFIGURE DNS:</b>
124
125 If you did not ./configure resdb with tinydns support
126 then you need to do that before using this function.
127
128 also before using you will need to have installed
129 daemontools, djbdns, and ucspi-tcp. peer2anonet
130 can do this for you with --install-* options.
131
132 ./contrib/peer2anonet/peer2anonet --configure-dns
133
134 <b>UPDATE DNS:</b>
135
136 After a successful `--configure-dns', you can now
137 enjoy to use `--update-dns' to bring your AnoNet
138 domains up to speed.
139
140 <b>COMPLAIN:</b>
141
142 If this README doesn't tell you what you need to know
143 you can head over to www.d3v11.ano/peering. If that
144 doesn't get you what you want then either complain to
145 me or shoot both of us in the face.
146
147
148
149 </pre></font></body></html> 126 </pre></font></body></html>