annotate contrib/peer2anonet/README.html @ 829:3750fcc21c33 draft

updates to peer2anonet, added "static bird"
author d3v11 <d3v11@d3v11.ano>
date Wed, 21 Dec 2011 00:10:44 +0000
parents 452623af8bf0
children 682ccfe2ab61
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
805
994843bd423f updated readme for peer2anonet
d3v11 <d3v11@d3v11.ano>
parents: 804
diff changeset
29 <b>From $RESDB_ROOT do:</b>
804
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
30
805
994843bd423f updated readme for peer2anonet
d3v11 <d3v11@d3v11.ano>
parents: 804
diff changeset
31 ./contrib/peer2anonet/peer2anonet --configure generate a new local configuration and exit
804
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
32
805
994843bd423f updated readme for peer2anonet
d3v11 <d3v11@d3v11.ano>
parents: 804
diff changeset
33 ./contrib/peer2anonet/peer2anonet --update regenerate peer configurations
804
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
34
805
994843bd423f updated readme for peer2anonet
d3v11 <d3v11@d3v11.ano>
parents: 804
diff changeset
35 ./contrib/peer2anonet/peer2anonet --configure-peer generate a new peer configuration and update
994843bd423f updated readme for peer2anonet
d3v11 <d3v11@d3v11.ano>
parents: 804
diff changeset
36
994843bd423f updated readme for peer2anonet
d3v11 <d3v11@d3v11.ano>
parents: 804
diff changeset
37 ./contrib/peer2anonet/peer2anonet --rm-peer remove a peer configuration and update
804
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
38
805
994843bd423f updated readme for peer2anonet
d3v11 <d3v11@d3v11.ano>
parents: 804
diff changeset
39 ./contrib/peer2anonet/peer2anonet --install-daemontools installs daemontools
804
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
40
805
994843bd423f updated readme for peer2anonet
d3v11 <d3v11@d3v11.ano>
parents: 804
diff changeset
41 ./contrib/peer2anonet/peer2anonet --install-ucspi-tcp installs ucspi-tcp
804
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
42
805
994843bd423f updated readme for peer2anonet
d3v11 <d3v11@d3v11.ano>
parents: 804
diff changeset
43 ./contrib/peer2anonet/peer2anonet --install-djbdns installs djbdns
804
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
44
805
994843bd423f updated readme for peer2anonet
d3v11 <d3v11@d3v11.ano>
parents: 804
diff changeset
45 ./contrib/peer2anonet/peer2anonet --configure-dns configures dnscache and tinydns zones
804
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
46
805
994843bd423f updated readme for peer2anonet
d3v11 <d3v11@d3v11.ano>
parents: 804
diff changeset
47 ./contrib/peer2anonet/peer2anonet --update-dns updates tinydns-ano zone
804
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>RTFM:</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 <b>CONFIGURE:</b>
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
52
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
53 I highly recommend that before you use peer2anonet
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
54 you ./configure resdb with tinydns support.
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
55
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
56 ./contrib/peer2anonet/peer2anonet --configure
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
57
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
58 <b>EXAMPLES:</b>
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
59
807
452623af8bf0 updated peer2anonet readme
d3v11 <d3v11@d3v11.ano>
parents: 805
diff changeset
60 Enter your AnoNet subnet: 1.1.5.0
452623af8bf0 updated peer2anonet readme
d3v11 <d3v11@d3v11.ano>
parents: 805
diff changeset
61 Enter your AnoNet router: 1.1.5.1
452623af8bf0 updated peer2anonet readme
d3v11 <d3v11@d3v11.ano>
parents: 805
diff changeset
62 Enter your peering ip: 1.1.5.2
452623af8bf0 updated peer2anonet readme
d3v11 <d3v11@d3v11.ano>
parents: 805
diff changeset
63 Enter your AnoNet asn: 1150
804
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
64
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
65 <b>CONFIGURE PEER:</b>
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
66
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
67 ./contrib/peer2anonet/peer2anonet --configure-peer
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
68
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
69 <b>KEY PAIRS:</b>
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
70
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
71 before running peer2anonet to configure peers you can use
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
72 quicktun to generate keypairs:
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
73
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
74 quicktun.keypair < /dev/random
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
75
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
76 <b>EXAMPLES:</b>
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
77
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
78 Enter your peer's name: d3v11
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
79 Enter your peer's remote ip: 11.11.55.1
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
80 Enter your peer's peering ip: 1.1.5.2
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
81 Enter your peer's remote port: 21150
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
82 Enter your local port: 61150
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
83 Enter your peer's asn: 1150
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
84 Enter your peer's public key: * see KEY PAIRS above *
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
85 Enter your private key: * see KEY PAIRS above *
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
86
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
87 <b>RUN CHANGES:</b>
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
88
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
89 peer2anonet exports the /service/$PEER/run file to
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
90 /etc/peer2anonet/peers/$PEER/run. If you need to
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
91 create customizations for peerings then make adjustments
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
92 to that file.
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
93
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
94 <b>CONFIGURATION FILES:</b>
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
95
829
3750fcc21c33 updates to peer2anonet, added "static bird"
d3v11 <d3v11@d3v11.ano>
parents: 807
diff changeset
96 If /etc/peer2anonet/bird.conf exists, then peer2anonet
3750fcc21c33 updates to peer2anonet, added "static bird"
d3v11 <d3v11@d3v11.ano>
parents: 807
diff changeset
97 will not create a new bird. Instead it will use this
3750fcc21c33 updates to peer2anonet, added "static bird"
d3v11 <d3v11@d3v11.ano>
parents: 807
diff changeset
98 bird.conf and append new protocols to it.
3750fcc21c33 updates to peer2anonet, added "static bird"
d3v11 <d3v11@d3v11.ano>
parents: 807
diff changeset
99
804
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
100 /etc/peer2anonet/peers/$PEER/* contains:
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
101
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
102 asn local_port peering_ip pubkey remote_ip remote_port run seckey
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
103
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
104 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
105 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
106 or reconfigure the peering tunnel altogether with --configure-peer and choose
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
107 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
108 plan on doing something with these files later.
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
109
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
110 <b>CONFIGURE DNS:</b>
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
111
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
112 If you did not ./configure resdb with tinydns support
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
113 then you need to do that before using this function.
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
114
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
115 also before using you will need to have installed
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
116 daemontools, djbdns, and ucspi-tcp. peer2anonet
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
117 can do this for you with --install-* options.
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
118
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
119 ./contrib/peer2anonet/peer2anonet --configure-dns
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>UPDATE DNS:</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 After a successful `--configure-dns', you can now
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
124 enjoy to use `--update-dns' to bring your AnoNet
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
125 domains up to speed.
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
126
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
127 <b>COMPLAIN:</b>
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
128
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
129 If this README doesn't tell you what you need to know
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
130 you can head over to www.d3v11.ano/peering. If that
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
131 doesn't get you what you want then either complain to
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
132 me or shoot both of us in the face.
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
133
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
134
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
135
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
136 </pre></font></body></html>