annotate contrib/peer2anonet/README.html @ 804:0ab988a1cec7 draft

updates for peer2anonet, ./contrib/peer2anonet/peer2anonet --update-dns can now bring tinydns-ano up to date.
author d3v11 <d3v11@d3v11.ano>
date Tue, 29 Nov 2011 09:23:30 +0000
parents
children 994843bd423f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
804
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
1 <html><body bgcolor="#000000"><font color="white">
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
2 <pre>
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
3 <b>DESCRIPTION:</b>
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
4
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
5 peer2anonet is an autoconfiguration utility for setting
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
6 up core services on AnoNet2. Enjoy :-).
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
7
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
8 <b>DEPENDS ON:</b>
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
9
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
10 quicktun, bird, bash for now. it also installs some cool shit
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
11 that you'll use later.
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
12
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
13 <b>AUTHOR:</b>
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
14
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
15 d3v11 from <a href="http://www.d3v11.ano/">www.d3v11.ano</a>, somtimes, maybe, dunno.
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
16
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
17 <b>REPORT BULLSHIT TO:</b>
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
18
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
19 <b>IRC:</b>
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
20
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
21 /relayhell/d3v11
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
22
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
23 <b>EMAIL:</b>
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
24
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
25 d3v11@d3v11.ano
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
26
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
27 <b>USAGE:</b>
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
28
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
29 ./contrib/peer2anonet/peer2anonet --configure generate a new local configuration and exit
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
30
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
31 ./contrib/peer2anonet/peer2anonet --update regenerate peer configurations
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
32
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
33 ./contrib/peer2anonet/peer2anonet --configure-peer generate a new peer configuration and update
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
34
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
35 ./contrib/peer2anonet/peer2anonet --rm-peer remove a peer configuration and update
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
36
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
37 ./contrib/peer2anonet/peer2anonet --install-daemontools installs daemontools
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
38
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
39 ./contrib/peer2anonet/peer2anonet --install-ucspi-tcp installs ucspi-tcp
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
40
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
41 ./contrib/peer2anonet/peer2anonet --install-djbdns installs djbdns
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
42
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
43 ./contrib/peer2anonet/peer2anonet --configure-dns configures dnscache and tinydns zones
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
44
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
45 ./contrib/peer2anonet/peer2anonet --update-dns updates tinydns-ano zone
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
46
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
47 <b>RTFM:</b>
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
48
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
49 <b>CONFIGURE:</b>
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
50
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
51 I highly recommend that before you use peer2anonet
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
52 you ./configure resdb with tinydns support.
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
53
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
54 ./contrib/peer2anonet/peer2anonet --configure
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
55
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
56 <b>EXAMPLES:</b>
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
57
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
58 Enter your AnoNet subnet: 1.2.3.0
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
59 Enter your AnoNet router: 1.2.3.1
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
60 Enter your peering ip: 1.2.3.4
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
61 Enter your AnoNet asn: 1234
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
62
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
63 <b>CONFIGURE PEER:</b>
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
64
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
65 ./contrib/peer2anonet/peer2anonet --configure-peer
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
66
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
67 <b>KEY PAIRS:</b>
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
68
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
69 before running peer2anonet to configure peers you can use
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
70 quicktun to generate keypairs:
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
71
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
72 quicktun.keypair < /dev/random
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
73
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
74 <b>EXAMPLES:</b>
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
75
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
76 Enter your peer's name: d3v11
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
77 Enter your peer's remote ip: 11.11.55.1
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
78 Enter your peer's peering ip: 1.1.5.2
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
79 Enter your peer's remote port: 21150
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
80 Enter your local port: 61150
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
81 Enter your peer's asn: 1150
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
82 Enter your peer's public key: * see KEY PAIRS above *
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
83 Enter your private key: * see KEY PAIRS above *
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
84
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
85 <b>RUN CHANGES:</b>
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
86
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
87 peer2anonet exports the /service/$PEER/run file to
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
88 /etc/peer2anonet/peers/$PEER/run. If you need to
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
89 create customizations for peerings then make adjustments
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
90 to that file.
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
91
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
92 <b>CONFIGURATION FILES:</b>
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
93
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
94 /etc/peer2anonet/peers/$PEER/* contains:
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
95
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
96 asn local_port peering_ip pubkey remote_ip remote_port run seckey
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
97
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
98 In the event you want to reconfigure a peer's tunnel you can alter the run
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
99 file and do `--update', rm run and modify the above files then use `--update',
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
100 or reconfigure the peering tunnel altogether with --configure-peer and choose
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
101 that peer's name. If you think this is absurd then you're probably right! I
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
102 plan on doing something with these files later.
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
103
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
104 <b>CONFIGURE DNS:</b>
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
105
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
106 If you did not ./configure resdb with tinydns support
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
107 then you need to do that before using this function.
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
108
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
109 also before using you will need to have installed
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
110 daemontools, djbdns, and ucspi-tcp. peer2anonet
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
111 can do this for you with --install-* options.
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
112
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
113 ./contrib/peer2anonet/peer2anonet --configure-dns
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
114
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
115 <b>UPDATE DNS:</b>
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
116
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
117 After a successful `--configure-dns', you can now
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
118 enjoy to use `--update-dns' to bring your AnoNet
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
119 domains up to speed.
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
120
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
121 <b>COMPLAIN:</b>
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
122
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
123 If this README doesn't tell you what you need to know
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
124 you can head over to www.d3v11.ano/peering. If that
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
125 doesn't get you what you want then either complain to
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
126 me or shoot both of us in the face.
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
127
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
128
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
129
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
130 </pre></font></body></html>