This is README for EarthLink SIPshare, a SIP-based p2p file transfer
application.

SIPshare is a Java application.  We recommend Java 2 Standard Edition
version 1.4.2 or later to run it (and compile it, if you so later choose).

SIPshare has been invoked from the Unix command line through the "fp"
wrapper shell script since its inception.  But a DOS batch file is
also provided, fp.bat, for DOS/Windows users.  However, if you have the
Cygwin (http://www.cygwin.com/) utilities (read Korn Shell) installed
on your Windows machine, you can consider yourself for SIPshare purposes
to be running in a Unix environment, and therefore adhere to the Unix
instructions below.

"Unix" as used below means an xterm or equivalent under Linux or Solaris,
and a Terminal window under Mac OS X.  Again, if you're using a Korn Shell
or equivalent for a command interpreter in a Windows environment, you
can use the Unix instructions below, and ignore the associated DOS steps.

To install and run:

1.  download latest distribution here

    http://www.research.earthlink.net/p2p/p2p.zip

2.  extract to some runtime directory

    unzip p2p.tgz

3.  

    Unix:  make a copy of the sample properties file by copying the
    sample to the filename of the form below

       cp ./lib/PROPERTIES.SAMPLE ./properties.`hostname`

       If your hostname is 'bart', the properties file should be named
       'properties.bart'.

       The startup script "./fp" in Step #7 below depends on this naming.

    DOS/Windows:  make a copy of the sample properties file by copying
    the sample to the filename form below

       copy  .\lib\PROPERTIES.SAMPLE .\properties.txt

    Both Unix and DOS:  the fp script or batch file is just a wrapper
    around the java runtime.  The name of the properties file matters
    if you use the version of fp or fb.bat as distributed.  Feel free to
    change either if you don't like the properties file naming convention.
    Just make sure the filename exists and has the contents as described
    below, and that the filename gets passed as the first argument to
    the main class FPeer.

4.  edit properties.{hostname} (Unix) or properties.txt (DOS/Windows)
    to configure the SIPshare client for your machine

    Mandatory entries:

    # stack address
    javax.sip.IP_ADDRESS=209.179.2.62
   
    # give the stack a convenient, but arbitrary, name
    javax.sip.STACK_NAME=fpeer.flux    

    # name of your peers file (see #5 below)
    net.earthlink.research.p2p.peersFile=peers.flux   

    # location of your shared files
    net.earthlink.research.p2p.sharedDir=./share/flux/

5.  edit peers file, whose location was specified in Step #4 as

    net.earthlink.research.p2p.peersFile=peers.flux,

    to include one line per each peer known prior to runtime.  Use IP
    addresses for peers, NOT HOSTNAMES.  For example,

    $ cat peers.flux
    209.179.2.59
    209.179.2.61
    209.179.2.56

    Ideally, there would be one or two hosts running SIPshare
    continuously, and those permanent hosts would have entries in your
    peers file.  However, in a prototyping environment such as ours,
    you must ensure the peers file contains hosts that will at some time
    during its runtime lifetime be available to your runtime instance
    of SIPshare.

6.  Unix:  The startup script "./fp" in Step #7 needs to find a Java VM.

    The startup script fp is a convenient wrapper around 

       $ java <client main class>

    If the environment variable

    JAVA_HOME 

    is set, fp uses the JVM along that path.  If JAVA_HOME is not found
    in your Unix environment, the JVM "java" must be on your PATH.

    For example

    JAVA_HOME=/usr/java/j2sdk1.4.2_04/

    will result in JVM /usr/java/j2sdk1.4.2_04/bin/java being used.

    DOS:  No processing of JAVA_HOME is performed.  "java.exe" must be
    on your PATH when fp.bat runs.

7.  Unix:  run the SIPshare client by invoking its startup script 'fp'

    $ sh fp

    DOS:  run the SIPshare client by invoking the batch file

    > fp.bat


SIPshare will print informational messages to the console.