annotate contrib/peer2anonet/README.html @ 901:c678f1f6a7e3 draft

added documentation for --setup-qmail and fixed autoinstaller for tor users. please see TORIFY section of the README or view www.d3v11.ano/peer2anonet
author d3v11 <d3v11@d3v11.ano>
date Sun, 29 Jan 2012 01:09:53 +0000
parents cd9d07046b1c
children 8565acc59908
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
884
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
5 peer2anonet is an autoconfiguration utility for
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
6 setting up core services on AnoNet2. Enjoy :-).
804
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
884
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
10 quicktun, bird, bash for now. it also installs
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
11 some cool shit that you'll use later.
804
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
884
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
17 <b>REPORT BULLSHIT TO:</b>
804
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
18
884
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
19 /relayhell/d3v11
804
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
20
884
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
21 d3v11@d3v11.ano
804
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>USAGE:</b>
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
24
884
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
25 ./contrib/peer2anonet/peer2anonet --help
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
26 ./contrib/peer2anonet/peer2anonet --rtfm
804
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
27
884
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
28 <b>TORIFY:</b>
804
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
29
884
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
30 --install-* flags should be compatible with Tor:
804
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
31
884
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
32 export http_proxy='http://127.0.0.1:8118/'
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
33 ./contrib/peer2anonet/peer2anonet --install-*
804
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
34
901
c678f1f6a7e3 added documentation for --setup-qmail and fixed autoinstaller
d3v11 <d3v11@d3v11.ano>
parents: 884
diff changeset
35 You can use torify or usewithtor on most options
c678f1f6a7e3 added documentation for --setup-qmail and fixed autoinstaller
d3v11 <d3v11@d3v11.ano>
parents: 884
diff changeset
36 but setting http_proxy is more reliable.
c678f1f6a7e3 added documentation for --setup-qmail and fixed autoinstaller
d3v11 <d3v11@d3v11.ano>
parents: 884
diff changeset
37
884
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
38 torify ./contrib/peer2anonet/peer2anonet --install-*
804
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
39
884
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
40 usewithtor ./contrib/peer2anonet/peer2anonet --install-*
878
1fecd121452d added --install-nacl to readme
d3v11 <d3v11@d3v11.ano>
parents: 877
diff changeset
41
884
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
42 <b>CONFIGURE:</b>
804
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
43
884
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
44 I highly recommend that before you use peer2anonet
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
45 you ./configure resdb with tinydns support.
804
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
46
884
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
47 ./contrib/peer2anonet/peer2anonet --configure
877
682ccfe2ab61 added tor usage note
d3v11 <d3v11@d3v11.ano>
parents: 829
diff changeset
48
884
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
49 <b>EXAMPLES:</b>
877
682ccfe2ab61 added tor usage note
d3v11 <d3v11@d3v11.ano>
parents: 829
diff changeset
50
884
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
51 Enter your AnoNet subnet: 1.1.5.0
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
52 Enter your AnoNet router: 1.1.5.1
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
53 Enter your peering ip: 1.1.5.2
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
54 Enter your AnoNet asn: 1150
877
682ccfe2ab61 added tor usage note
d3v11 <d3v11@d3v11.ano>
parents: 829
diff changeset
55
884
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
56 <b>CONFIGURE PEER:</b>
804
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
57
884
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
58 ./contrib/peer2anonet/peer2anonet --configure-peer
804
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
59
884
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
60 <b>KEY PAIRS:</b>
804
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
61
884
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
62 before running peer2anonet to configure peers
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
63 you can use quicktun to generate keypairs:
804
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
64
884
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
65 quicktun.keypair < /dev/random
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
66
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
67 <b>EXAMPLES:</b>
804
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
68
884
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
69 Enter your peer's name: d3v11
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
70 Enter your peer's remote ip: 11.11.55.1
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
71 Enter your peer's peering ip: 1.1.5.2
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
72 Enter your peer's remote port: 21150
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
73 Enter your local port: 61150
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
74 Enter your peer's asn: 1150
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
75 Enter your peer's public key: * see KEY PAIRS above *
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
76 Enter your private key: * see KEY PAIRS above *
804
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
77
884
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
78 <b>/SERVICE/$PEER/RUN CHANGES:</b>
804
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
79
884
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
80 peer2anonet exports the /service/$PEER/run file to
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
81 /etc/peer2anonet/peers/$PEER/run. If you need to
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
82 create customizations for peerings then make
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
83 adjustments to that file.
804
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
84
884
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
85 <b>CONFIGURATION FILES:</b>
804
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
86
884
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
87 If /etc/peer2anonet/bird.conf exists, then
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
88 peer2anonet will not create a new bird. Instead
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
89 it will use this bird.conf and append new protocols
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
90 to it.
804
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
91
884
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
92 /etc/peer2anonet/peers/$PEER/* contains:
804
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
93
884
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
94 asn local_port peering_ip pubkey
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
95 remote_ip remote_port run seckey
804
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
96
884
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
97 In the event you want to reconfigure a peer's tunnel
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
98 you can alter the run file and do `--update', rm run
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
99 and modify the above files then use `--update', or
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
100 reconfigure the peering tunnel altogether with
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
101 --configure-peer and choose that peer's name. If you
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
102 think this is absurd then you're probably right! I
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
103 plan on doing something with these files later.
804
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
104
884
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
105 <b>CONFIGURE DNS:</b>
804
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
106
884
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
107 If you did not ./configure resdb with tinydns support
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
108 then you need to do that before using this function.
804
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
109
884
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
110 also before using you will need to have installed
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
111 daemontools, djbdns, and ucspi-tcp. peer2anonet
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
112 can do this for you with --install-* options.
804
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
113
884
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
114 ./contrib/peer2anonet/peer2anonet --configure-dns
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
115
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
116 <b>UPDATE DNS:</b>
804
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
117
884
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
118 After a successful `--configure-dns', you can now
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
119 enjoy to use `--update-dns' to bring your AnoNet
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
120 domains up to speed.
804
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
121
901
c678f1f6a7e3 added documentation for --setup-qmail and fixed autoinstaller
d3v11 <d3v11@d3v11.ano>
parents: 884
diff changeset
122 <b>SETUP QMAIL:</b>
c678f1f6a7e3 added documentation for --setup-qmail and fixed autoinstaller
d3v11 <d3v11@d3v11.ano>
parents: 884
diff changeset
123
c678f1f6a7e3 added documentation for --setup-qmail and fixed autoinstaller
d3v11 <d3v11@d3v11.ano>
parents: 884
diff changeset
124 If you did not ./configure resdb with tinydns support
c678f1f6a7e3 added documentation for --setup-qmail and fixed autoinstaller
d3v11 <d3v11@d3v11.ano>
parents: 884
diff changeset
125 then you need to do that before using this function.
c678f1f6a7e3 added documentation for --setup-qmail and fixed autoinstaller
d3v11 <d3v11@d3v11.ano>
parents: 884
diff changeset
126
c678f1f6a7e3 added documentation for --setup-qmail and fixed autoinstaller
d3v11 <d3v11@d3v11.ano>
parents: 884
diff changeset
127 also before using you will need to have installed
c678f1f6a7e3 added documentation for --setup-qmail and fixed autoinstaller
d3v11 <d3v11@d3v11.ano>
parents: 884
diff changeset
128 daemontools, djbdns, and ucspi-tcp. peer2anonet
c678f1f6a7e3 added documentation for --setup-qmail and fixed autoinstaller
d3v11 <d3v11@d3v11.ano>
parents: 884
diff changeset
129 can do this for you with --install-* options.
c678f1f6a7e3 added documentation for --setup-qmail and fixed autoinstaller
d3v11 <d3v11@d3v11.ano>
parents: 884
diff changeset
130
c678f1f6a7e3 added documentation for --setup-qmail and fixed autoinstaller
d3v11 <d3v11@d3v11.ano>
parents: 884
diff changeset
131 setup-qmail will download and install qmail if it
c678f1f6a7e3 added documentation for --setup-qmail and fixed autoinstaller
d3v11 <d3v11@d3v11.ano>
parents: 884
diff changeset
132 isn't already installed and configure your
c678f1f6a7e3 added documentation for --setup-qmail and fixed autoinstaller
d3v11 <d3v11@d3v11.ano>
parents: 884
diff changeset
133 mx domain as a.mx.$nick.ano with the ip of your
c678f1f6a7e3 added documentation for --setup-qmail and fixed autoinstaller
d3v11 <d3v11@d3v11.ano>
parents: 884
diff changeset
134 resdb git-daemon ip.
c678f1f6a7e3 added documentation for --setup-qmail and fixed autoinstaller
d3v11 <d3v11@d3v11.ano>
parents: 884
diff changeset
135
c678f1f6a7e3 added documentation for --setup-qmail and fixed autoinstaller
d3v11 <d3v11@d3v11.ano>
parents: 884
diff changeset
136 ./contrib/peer2anonet/peer2anonet --setup-qmail
c678f1f6a7e3 added documentation for --setup-qmail and fixed autoinstaller
d3v11 <d3v11@d3v11.ano>
parents: 884
diff changeset
137
884
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
138 <b>COMPLAIN:</b>
804
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
139
884
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
140 If this README doesn't tell you what you need to know
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
141 you can head over to www.d3v11.ano/peering. If that
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
142 doesn't get you what you want then either complain to
cd9d07046b1c peer2anonet:
d3v11 <d3v11@d3v11.ano>
parents: 878
diff changeset
143 me or shoot both of us in the face.
804
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
144
0ab988a1cec7 updates for peer2anonet,
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
145 </pre></font></body></html>