1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/README	Sat Feb 20 21:18:28 2010 -0800
     1.3 @@ -0,0 +1,85 @@
     1.4 +$Id: README,v 1.13 2004/02/06 02:49:09 hipnod Exp $
     1.5 +
     1.6 +Compilation & Installation
     1.7 +--------------------------
     1.8 +
     1.9 +You must install giFT before installing this plugin.
    1.10 +
    1.11 +The configure script uses pkg-config to search for giFT. If you have
    1.12 +installed giFT somewhere besides the default pkg-config lookup path, you
    1.13 +need to change the PKG_CONFIG_PATH environment variable so configure can
    1.14 +find libgift.pc.
    1.15 +
    1.16 +After installing, you should run the gift-setup script. If you want, you can
    1.17 +setup the plugin manually by adding "Gnutella" to the /main/plugins line in
    1.18 +~/.giFT/giftd.conf, like so:
    1.19 +
    1.20 +	[main]
    1.21 +	plugins = OpenFT:Gnutella
    1.22 +
    1.23 +You may also use a fully qualified path to the plugin filename:
    1.24 +
    1.25 +	[main]
    1.26 +	plugins = OpenFT:/usr/local/lib/giFT/libGnutella.la
    1.27 +
    1.28 +You can also specify the plugin on the command line:
    1.29 +
    1.30 +	$ giftd -d -p Gnutella -p OpenFT
    1.31 +
    1.32 +
    1.33 +Bootstrapping
    1.34 +-------------
    1.35 +
    1.36 +On initial startup, the plugin has to find some Gnutella nodes to connect to.
    1.37 +No default nodes are hardcoded.  Instead, there is a list of websites called
    1.38 +"GWebCaches", and a GWebCache is randomly selected and contacted to retrieve a
    1.39 +list of currently active nodes.  If these nodes are busy, they can still
    1.40 +bootstrap the plugin by informing it of more nodes to connect to, so this
    1.41 +process continues until the plugin finds some available nodes.
    1.42 +
    1.43 +This process tends to be somewhat fragile, because a GWebCache is usually only
    1.44 +contacted once for this purpose, so the GWebCache handling code in the plugin
    1.45 +runs infrequently and tends to have bugs.  If you experience problems
    1.46 +connecting, it would help to view the log file when reporting problems.
    1.47 +
    1.48 +If you're interested in running a GWebCache, see "More GWebCache Info" below
    1.49 +for more information.
    1.50 +
    1.51 +
    1.52 +Configuration
    1.53 +-------------
    1.54 +
    1.55 +The configuration file is in $HOME/.giFT/Gnutella/Gnutella.conf, and is created
    1.56 +if it doesn't exist.  The syntax of the config file is the same as other giFT
    1.57 +files.
    1.58 +
    1.59 +gift-setup will set the default port to something random. You can change it by
    1.60 +editing the plugin's config file.  If this port isn't reachable, you will
    1.61 +receive less search results because you cannot download from firewalled users.
    1.62 +You may have to do some other configuration (forward the port on your firewall,
    1.63 +etc) to make the port reachable.
    1.64 +
    1.65 +
    1.66 +
    1.67 +More GWebCache info
    1.68 +-------------------
    1.69 +
    1.70 +If you're interested in running a GWebCache, more information can be found at
    1.71 +http://www.gnucleus.com/gwebcache/.  Note that while running one doesn't
    1.72 +require a lot of bandwidth for each request, there are quite a lot of nodes
    1.73 +making many requests to a dwindling number of GWebCaches (there used to be
    1.74 +200+, not there are only about 60 left due to abusive nodes hammering them).
    1.75 +
    1.76 +It helps to put the cache on a separate domain (for example, gwc.foo.com) so
    1.77 +that the name can be removed from the DNS if the load on it becomes too high.
    1.78 +Note that this name probably shouldn't contain the word "cache" in it, because
    1.79 +that may be treated specially by HTTP proxies.
    1.80 +
    1.81 +
    1.82 +Contact
    1.83 +-------
    1.84 +
    1.85 +Email:  hipnod@bellsouth.net  [Original author]
    1.86 +
    1.87 +IRC:    #giFT-gnutella on irc.freenode.net
    1.88 +