Annotation of foxtorrent/www/ReadMe.txt, revision 1.1

1.1     ! dlhx65f0    1: Build guide:   (If you don't know the difference between build and install, skip this section and go
        !             2: to Installation/Setup guide.  Even if you do know the difference, you would almost certainly want
        !             3: to skip this section.)
        !             4: 
        !             5: 1. The extension is implemented entirely in XUL/Javascript, so there is no need to build any C++
        !             6: components.
        !             7: 
        !             8: 2. The source code is provided in CVS inside the src/ directory, in standard extension
        !             9: development format.  Therefore, you may use any standard method of packaging extensions you
        !            10: would like - for example, the "Extension builder" feature of the Extension Developer extension
        !            11: (http://ted.mielczarek.org/code/mozilla/extensiondev/).  A config_build.sh script is also
        !            12: provided, for use with the first bash build script on this page:
        !            13: (http://kb.mozillazine.org/Bash_build_script).
        !            14: 
        !            15: Installation/Setup guide:
        !            16: 
        !            17: 1.   Make sure you're running Firefox.  Ensure you have Azureus running with the XML over
        !            18:      HTTP plugin.  As installation varies from platform to platform, how to do this is beyond
        !            19:      the scope of this guide.  See the Azureus homepage (http://azureus.sourceforge.net/) for
        !            20:      help on this subject.
        !            21: 
        !            22: 2.   Install the Azureus XML over HTTP plugin.  
        !            23:           In Windows:
        !            24:                While in Azureus, go Plugins, Installation Wizard and follow the prompts.
        !            25:           In Linux:
        !            26:                Install the XML over HTTP plugin, download the zip from
        !            27:           (http://azureus.sourceforge.net/plugin_details.php?plugin=xml_http_if).
        !            28:                Locate the azureus plugins directory on your system.  The plugin directory
        !            29:                varies depending on the operating system - Linux places it under
        !            30:                "~/.azureus/plugins".  Inside the plugins directory, make a directory called
        !            31:                "xml_http_if".  Extract the contents of the zip into this directory you just
        !            32:                created, so you get a structure like (continuing the Linux example):
        !            33:                     ~/.azureus/plugins/xml_http_if/plugin.properties
        !            34:                     ~/.azureus/plugins/xml_http_if/azureus.sig.
        !            35: 
        !            36: 3.   In the XML over HTTP plugin settings, make sure you are using HTTP and not HTTPS. 
        !            37:      Also make sure that the list of allowed hosts is changed from localhost if you are not
        !            38:      communicating with Azureus on the same machine.  You may use a username/password
        !            39:      to authenticate if you would like; the extension supports this.
        !            40: 
        !            41: 4.   Click on the FoxTorrent link to install the XPI and restart Firefox.  The extension defaults
        !            42:      to connecting to localhost with the default port, so on the first run, if these are not the
        !            43:      correct settings for your Azureus instance, you may get a message like "unable to connect,
        !            44:      check your settings".  You may ignore this.
        !            45: 
        !            46: 5.   Go to the options page for the extension, and set your host/port to the running instance of
        !            47:      Azureus.  If you require authentication, check the "Authenticate" checkbox.  The
        !            48:      application will prompt you for the username and password to use.  Note: the extension
        !            49:      does not store the username and password for security reasons; it will prompt you upon
        !            50:      startup every time you run Firefox.
        !            51: 
        !            52: 6.   If you open up the FoxTorrent sidebar using the View->Sidebar menu, or by pressing
        !            53:      Shift-Control-B, after a short loading time (the application updates the list of torrents
        !            54:      every 10 seconds), you should see the running torrents in your Azureus instance.
        !            55: 
        !            56: Usage guide:
        !            57: 
        !            58: 1.   When you have your extension set up correctly, it should display the list of running
        !            59:      torrents in the FoxTorrent sidebar in two separate list boxes; one for currently
        !            60:      downloading torrents, and one for seeding/completed torrents.  Note: as the extension has
        !            61:      to parse an XML list of torrents, the more torrents you have, the more FoxTorrent (and
        !            62:      subsequently, Firefox) will bog down.  This starts becoming noticeable with Azureus
        !            63:      instances running over roughly 100 torrents, but may also depend on the speed of your
        !            64:      computer.
        !            65: 
        !            66: 2.   Mousing over any torrent should display a tooltip with more detailed info about the
        !            67:      running torrent.
        !            68: 
        !            69: 3.   Right-clicking a torrent will provide a few torrent management options -
        !            70:      starting/stopping, move up and move down, and remove.  Note:  due to the asynchronous
        !            71:      update nature of the extension, changes you make to the torrent list will not reflect until
        !            72:      the next update cycle or so.  So you don't have to "remove" a torrent 6 times, thinking it's
        !            73:      not going away.  Just do it once and wait for the changes to reflect.  The slow response
        !            74:      will be dealt with in a future version.
        !            75: 
        !            76: 4.   There are two ways to add a torrent: through the "Add Torrent" button at the top of the
        !            77:      FoxTorrent sidebar, or by the right-click context menu.
        !            78: 
        !            79: 5.   The "Add Torrent" button pops up a dialog box, allowing you to add either a local torrent
        !            80:      or a torrent URL.  Be aware that many torrent links you will find on the web are scripted
        !            81:      links, and not direct links to torrent files. When submitting a torrent URL, the extension
        !            82:      checks to make sure the link ends in *.torrent - this is a safety check; sometimes Azureus
        !            83:      can break if you send it links that are not torrents. Note: adding a torrent local to your
        !            84:      computer is not implemented yet.
        !            85: 
        !            86: 6.   Right-clicking on a link on a web page will display an "Add to FoxTorrent" option in the
        !            87:      context menu, right below "Save link as...".  If your connection is correctly set up, you
        !            88:      may send torrents to Azureus without ever opening the FoxTorrent sidebar or "Add
        !            89:      Torrent" dialog.  Note: the "Add to FoxTorrent" context item also checks to make sure
        !            90:      the link ends with *.torrent, for safety reasons.
        !            91: 
        !            92: Thanks
        !            93: 
        !            94: To all the countless unknown sentient beings prior to this point in time who, with the thought of
        !            95: posterity, have performed beneficial actions without which this extension would not have been
        !            96: possible.
        !            97: 
        !            98: To Thomas Edison and others important in the harnessing of electricity.
        !            99: 
        !           100: To Alan M. Turing, inventor of the Turing machine.
        !           101: 
        !           102: To Iain Strawp and his Azureus PHP control layer at (http://www.strawp.net/azureus_php/) for
        !           103: showing us how to use the xml over http interface correctly.
        !           104: 
        !           105: To the helpful folks at the various channels at irc.mozilla.org.
        !           106: 
        !           107: To our parents.
        !           108: 
        !           109: Unfortunately, we cannot thank ourselves.
        !           110: 
        !           111: Chris Han, Chief Programmer
        !           112: Emre Durmus, Programmer
        !           113: Georges Akpoly, Programmer
        !           114: Tharpa Roberts, Junior Programmer.

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>