paulo@0: $Id: README,v 1.13 2004/02/06 02:49:09 hipnod Exp $
paulo@0: 
paulo@0: Compilation & Installation
paulo@0: --------------------------
paulo@0: 
paulo@0: You must install giFT before installing this plugin.
paulo@0: 
paulo@0: The configure script uses pkg-config to search for giFT. If you have
paulo@0: installed giFT somewhere besides the default pkg-config lookup path, you
paulo@0: need to change the PKG_CONFIG_PATH environment variable so configure can
paulo@0: find libgift.pc.
paulo@0: 
paulo@0: After installing, you should run the gift-setup script. If you want, you can
paulo@0: setup the plugin manually by adding "Gnutella" to the /main/plugins line in
paulo@0: ~/.giFT/giftd.conf, like so:
paulo@0: 
paulo@0: 	[main]
paulo@0: 	plugins = OpenFT:Gnutella
paulo@0: 
paulo@0: You may also use a fully qualified path to the plugin filename:
paulo@0: 
paulo@0: 	[main]
paulo@0: 	plugins = OpenFT:/usr/local/lib/giFT/libGnutella.la
paulo@0: 
paulo@0: You can also specify the plugin on the command line:
paulo@0: 
paulo@0: 	$ giftd -d -p Gnutella -p OpenFT
paulo@0: 
paulo@0: 
paulo@0: Bootstrapping
paulo@0: -------------
paulo@0: 
paulo@0: On initial startup, the plugin has to find some Gnutella nodes to connect to.
paulo@0: No default nodes are hardcoded.  Instead, there is a list of websites called
paulo@0: "GWebCaches", and a GWebCache is randomly selected and contacted to retrieve a
paulo@0: list of currently active nodes.  If these nodes are busy, they can still
paulo@0: bootstrap the plugin by informing it of more nodes to connect to, so this
paulo@0: process continues until the plugin finds some available nodes.
paulo@0: 
paulo@0: This process tends to be somewhat fragile, because a GWebCache is usually only
paulo@0: contacted once for this purpose, so the GWebCache handling code in the plugin
paulo@0: runs infrequently and tends to have bugs.  If you experience problems
paulo@0: connecting, it would help to view the log file when reporting problems.
paulo@0: 
paulo@0: If you're interested in running a GWebCache, see "More GWebCache Info" below
paulo@0: for more information.
paulo@0: 
paulo@0: 
paulo@0: Configuration
paulo@0: -------------
paulo@0: 
paulo@0: The configuration file is in $HOME/.giFT/Gnutella/Gnutella.conf, and is created
paulo@0: if it doesn't exist.  The syntax of the config file is the same as other giFT
paulo@0: files.
paulo@0: 
paulo@0: gift-setup will set the default port to something random. You can change it by
paulo@0: editing the plugin's config file.  If this port isn't reachable, you will
paulo@0: receive less search results because you cannot download from firewalled users.
paulo@0: You may have to do some other configuration (forward the port on your firewall,
paulo@0: etc) to make the port reachable.
paulo@0: 
paulo@0: 
paulo@0: 
paulo@0: More GWebCache info
paulo@0: -------------------
paulo@0: 
paulo@0: If you're interested in running a GWebCache, more information can be found at
paulo@0: http://www.gnucleus.com/gwebcache/.  Note that while running one doesn't
paulo@0: require a lot of bandwidth for each request, there are quite a lot of nodes
paulo@0: making many requests to a dwindling number of GWebCaches (there used to be
paulo@0: 200+, not there are only about 60 left due to abusive nodes hammering them).
paulo@0: 
paulo@0: It helps to put the cache on a separate domain (for example, gwc.foo.com) so
paulo@0: that the name can be removed from the DNS if the load on it becomes too high.
paulo@0: Note that this name probably shouldn't contain the word "cache" in it, because
paulo@0: that may be treated specially by HTTP proxies.
paulo@0: 
paulo@0: 
paulo@0: Contact
paulo@0: -------
paulo@0: 
paulo@0: Email:  hipnod@bellsouth.net  [Original author]
paulo@0: 
paulo@0: IRC:    #giFT-gnutella on irc.freenode.net
paulo@0: