summaryrefslogtreecommitdiff
path: root/contrib/peer2anonet/README
blob: 1693e7c8e7e4a2e9761d5dac5aff6c636959ae69 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
DESCRIPTION:

    peer2anonet is an autoconfiguration utility for setting
    up core services on AnoNet2. Enjoy :-).

DEPENDS ON:

    quicktun, bird, daemontools(non-deb), bash

AUTHOR:

    d3v11 from www.d3v11.ano somtimes, maybe, dunno.

    REPORT BULLSHIT TO:

        IRC:
        
            /relayhell/d3v11

        EMAIL:
        
            d3v11@d3v11.ano

USAGE:

    ./contrib/peer2anonet/peer2anonet --configure             generate a new local configuration and exit

    ./contrib/peer2anonet/peer2anonet --update                regenerate peer configurations

    ./contrib/peer2anonet/peer2anonet --configure-peer        generate a new peer configuration and update

    ./contrib/peer2anonet/peer2anonet --rm-peer               remove a peer configuration and update

    ./contrib/peer2anonet/peer2anonet --install-daemontools   installs daemontools

    ./contrib/peer2anonet/peer2anonet --install-ucspi-tcp     installs ucspi-tcp

    ./contrib/peer2anonet/peer2anonet --install-djbdns        installs djbdns

    ./contrib/peer2anonet/peer2anonet --configure-dns         configures dnscache and tinydns zones

RTFM:

    CONFIGURE:

        I highly recommend that before you use peer2anonet
        you ./configure resdb with tinydns support.

        ./contrib/peer2anonet/peer2anonet --configure

        EXAMPLES:

            Enter your AnoNet subnet: 1.2.3.0
            Enter your AnoNet router: 1.2.3.1
            Enter your peering ip: 1.2.3.4
            Enter your AnoNet asn: 1234

    CONFIGURE PEER:

        ./contrib/peer2anonet/peer2anonet --configure-peer

            KEY PAIRS:

                before running peer2anonet to configure peers you can use
                quicktun to generate keypairs:

                    quicktun.keypair</dev/random

            CLIENT PORT:

                peer2anonet uses '20' plus the first four digits of your peer's asn
                as the `clientport'.

                LOCAL_PORT=20${PEERASN:0:4}

            EXAMPLES:

                Enter your peer's name: d3v11
                Enter your peer's remote ip: 11.11.55.1
                Enter your peer's peering ip: 1.1.5.2
                Enter your peer's remote port: 201150
                Enter your peer's asn: 1150
                Enter your peer's public key: * see KEY PAIRS above *
                Enter your private key: * see KEY PAIRS above *

            RUN CHANGES:

                peer2anonet exports the /service/$PEER/run file to
                /etc/peer2anonet/peers/$PEER/run. If you need to
                create customizations for peerings then make adjustments
                to that file.

    CONFIGURE DNS:

        If you did not ./configure resdb with tinydns support
        then you need to do that before using this function.

        also before using you will need to have installed
        daemontools, djbdns, and ucspi-tcp. peer2anonet
        can do this for you with --install-* options.

        ./contrib/peer2anonet/peer2anonet --configure-dns

    COMPLAIN:

        If this README doesn't tell you what you need to know
        you can head over to www.d3v11.ano/peering. If that
        doesn't get you what you want then either complain to
        me or shoot both of us in the face.