source: trunk/i2p/Garlicat-HOWTO @ 537

Revision 537, 4.2 KB checked in by eagle, 8 months ago (diff)

GarliCat howto updated

RevLine 
[530]1GarliCat HOWTO
2
3This is a quick introduction into setting up I2P for GarliCat. It is assumed
4that you already have installed I2P. This HOWTO is based on I2P version
50.7.7-0.
6
7
81 DOWNLOAD
9First get the GarliCat branch of OnionCat 0.2.0, revision 529 or higher. It
10is found here: http://www.cypherpunk.at/ocat/download/Source/0.2.0/unofficial
11
12
132 COMPILE AND INSTALL
14Unpack it, change into the directory and run './configure', 'make' and 'make
15install'. If something goes wrong, read the error messages and try to fix the
16problem.
17
18
193 CONFIGURE I2P
[537]20GarliCat is able to connect to other GarliCats and lets others to connect to
21you, hence, the GarliCat software contains a server and a client part. Thus you
22must configure a server and a client tunnel on your I2P router. The server is
23the "incoming" part. I2P will assign an ID (a key) to it which is unique for
24your server tunnel and your GarliCat, respectively. This ID is directly
25translated into an IPv6 address, hence, also this IPv6 address is unique to
26your GarliCat.
[530]27
28
293.1 CONFIGURE SERVER TUNNEL
[537]30Open the I2P router console in your browser (http://127.0.0.1:7657/) and go to
31"LOCAL DESTINATIONS" which is found at the bottom of the menu bar on the left
32side. The "I2P Tunnel Page" (http://127.0.0.1:7657/i2ptunnel/) will open. In
33the bottom right corner of the "I2P SERVER TUNNELS" box select "Standard"
[530]34(which should be selected by default) and click "Create". A new page opens. On
[537]35top enter a name, e.g. "GarliCat Incoming". Select the "Autostart" checkbox.
[530]36In the text field "Port" which is marked as required enter the port number
378061. Scroll to the bottom and press "Save".
38
39
403.2 CONFIGURE CLIENT TUNNEL
41In the bottom right corner of the "I2P CLIENT TUNNELS" box select "SOCKS
424/4a/5" and press "Create". A new page opens. On top enter a name, e.g.
[537]43"GarliCat Outgoing". In the "Port" field which is marked as required enter the
44port number 9051. Check the "Autostart" checkbox. Scroll down and press
[530]45"Save".
46
47
483.3 FIGURE OUT _YOUR_ GARLICAT I2P-ID
49On the "i2ptunnel page" (http://127.0.0.1:7657/i2ptunnel/) -- you should
50already be on this page after the last step of 3.2 -- you should see your
51"GarliCat Inbound" tunnel in the "I2P SERVER TUNNELS" box. It lists a string
[537]52called "Base32 Address". Copy this string to a file. Truncate it to 16
[530]53characters and append the domain ".oc.b32.i2p". The result is your GarliCat
54I2P-ID.
55Example:
[537]56Base32 Address: ktmhezukbp6jyuldedcjmso6p4e6aegeikqli2mne67hnttgmvfa.b32.i2p
[530]57GarliCat I2P-ID: ktmhezukbp6jyuld.oc.b32.i2p
58
59Your I2P router is now ready.
60
61
624 RUN GARLICAT
63Your Garlicat I2P-ID is directly convertable into an IPv6 address and vice
64versa by Garlicat. You can test if you figured out your GC I2P-ID correct by
65running `gcat -i <your_gc_i2p_id>`. It should output an (your) IPv6 address.
66Now start Garlicat as root and give your I2P-ID as a single parameter:
67`gcat <your_gc_i2p_id>`
68(Note: GarliCat will immediately drop root privileges after initialization).
69You may have a look at the log files. By default, GarliCat logs to syslog with
70facility "daemon".
71If everything works you should now have a tunnel device (`ifconfig`) having
72your IPv6 address configure. You should be able to ping to your own address
73by running `ping6 <your_gc_ipv6_address>`.
74
75
765 TELL I2P FROM OTHER GARLICATS
77Basically everything is ready now but you need to enter the I2P-IDs and keys
78from others that you want to connect to to your I2P address book. The best way
79to do this is using SusiDNS.
80If you want to connect to someone else's GarliCat you first need to receive his
81GarliCat IPv6 address, his I2P-ID, and his key. Then go to your Susi-DNS page
82(click on "Addressbook" on your I2P Router console) and add a new entry being
[537]83the I2P-ID the name. Test if it works. Simply try to ping to the IPv6 address.
[530]84(NOTE: THERE MAY BE BETTER OPTIONS BUT THIS SECTION WAS WRITTEN BY SOMEONE
85WHO DOES NOT NO TOO MUCH DETAILS ABOUT SUSIDNS, YET. SORRY.)
86
87
88A APPENDIX
89What is the difference between OnionCat and GarliCat?
90OC and GC is basically the same. They completely share the code base. The
91difference just lies in port numbers and the domain extensions which are
92specific for Tor (.onion) and I2P (.oc.b32.i2p), respectively.
93OC and GC can run in parallel on a host.
94
95
96B AUTHOR
97This HOWTO was written by Bernhard R. Fischer, 15th of November 2009.
98
Note: See TracBrowser for help on using the repository browser.