annotate README @ 0:d39e1d0d75b6

initial add
author paulo@hit-nxdomain.opendns.com
date Sat, 20 Feb 2010 21:18:28 -0800
parents
children
rev   line source
paulo@0 1 $Id: README,v 1.13 2004/02/06 02:49:09 hipnod Exp $
paulo@0 2
paulo@0 3 Compilation & Installation
paulo@0 4 --------------------------
paulo@0 5
paulo@0 6 You must install giFT before installing this plugin.
paulo@0 7
paulo@0 8 The configure script uses pkg-config to search for giFT. If you have
paulo@0 9 installed giFT somewhere besides the default pkg-config lookup path, you
paulo@0 10 need to change the PKG_CONFIG_PATH environment variable so configure can
paulo@0 11 find libgift.pc.
paulo@0 12
paulo@0 13 After installing, you should run the gift-setup script. If you want, you can
paulo@0 14 setup the plugin manually by adding "Gnutella" to the /main/plugins line in
paulo@0 15 ~/.giFT/giftd.conf, like so:
paulo@0 16
paulo@0 17 [main]
paulo@0 18 plugins = OpenFT:Gnutella
paulo@0 19
paulo@0 20 You may also use a fully qualified path to the plugin filename:
paulo@0 21
paulo@0 22 [main]
paulo@0 23 plugins = OpenFT:/usr/local/lib/giFT/libGnutella.la
paulo@0 24
paulo@0 25 You can also specify the plugin on the command line:
paulo@0 26
paulo@0 27 $ giftd -d -p Gnutella -p OpenFT
paulo@0 28
paulo@0 29
paulo@0 30 Bootstrapping
paulo@0 31 -------------
paulo@0 32
paulo@0 33 On initial startup, the plugin has to find some Gnutella nodes to connect to.
paulo@0 34 No default nodes are hardcoded. Instead, there is a list of websites called
paulo@0 35 "GWebCaches", and a GWebCache is randomly selected and contacted to retrieve a
paulo@0 36 list of currently active nodes. If these nodes are busy, they can still
paulo@0 37 bootstrap the plugin by informing it of more nodes to connect to, so this
paulo@0 38 process continues until the plugin finds some available nodes.
paulo@0 39
paulo@0 40 This process tends to be somewhat fragile, because a GWebCache is usually only
paulo@0 41 contacted once for this purpose, so the GWebCache handling code in the plugin
paulo@0 42 runs infrequently and tends to have bugs. If you experience problems
paulo@0 43 connecting, it would help to view the log file when reporting problems.
paulo@0 44
paulo@0 45 If you're interested in running a GWebCache, see "More GWebCache Info" below
paulo@0 46 for more information.
paulo@0 47
paulo@0 48
paulo@0 49 Configuration
paulo@0 50 -------------
paulo@0 51
paulo@0 52 The configuration file is in $HOME/.giFT/Gnutella/Gnutella.conf, and is created
paulo@0 53 if it doesn't exist. The syntax of the config file is the same as other giFT
paulo@0 54 files.
paulo@0 55
paulo@0 56 gift-setup will set the default port to something random. You can change it by
paulo@0 57 editing the plugin's config file. If this port isn't reachable, you will
paulo@0 58 receive less search results because you cannot download from firewalled users.
paulo@0 59 You may have to do some other configuration (forward the port on your firewall,
paulo@0 60 etc) to make the port reachable.
paulo@0 61
paulo@0 62
paulo@0 63
paulo@0 64 More GWebCache info
paulo@0 65 -------------------
paulo@0 66
paulo@0 67 If you're interested in running a GWebCache, more information can be found at
paulo@0 68 http://www.gnucleus.com/gwebcache/. Note that while running one doesn't
paulo@0 69 require a lot of bandwidth for each request, there are quite a lot of nodes
paulo@0 70 making many requests to a dwindling number of GWebCaches (there used to be
paulo@0 71 200+, not there are only about 60 left due to abusive nodes hammering them).
paulo@0 72
paulo@0 73 It helps to put the cache on a separate domain (for example, gwc.foo.com) so
paulo@0 74 that the name can be removed from the DNS if the load on it becomes too high.
paulo@0 75 Note that this name probably shouldn't contain the word "cache" in it, because
paulo@0 76 that may be treated specially by HTTP proxies.
paulo@0 77
paulo@0 78
paulo@0 79 Contact
paulo@0 80 -------
paulo@0 81
paulo@0 82 Email: hipnod@bellsouth.net [Original author]
paulo@0 83
paulo@0 84 IRC: #giFT-gnutella on irc.freenode.net
paulo@0 85