Annotation of foxtorrent/www/installation.html, revision 1.10

1.2       dlhx65f0    1: <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
                      2: <html><head><!-- MAIN CONTENT --></head>
                      3: <body>
1.4       dlhx65f0    4: <h4><a id="content" name="content"></a></h4><br>
                      5: <h5 class="page-header"><a id="content" name="content">Installation and Usage<br>
                      6: </a></h5>
1.1       petejc      7: 
1.2       dlhx65f0    8: 
1.7       dlhx65f0    9: <p><a href="http://downloads.mozdev.org/foxtorrent/foxtorrent-01.1.xpi">FoxTorrent</a></p><span style="font-weight: bold; text-decoration: underline;">Build guide</span>:&nbsp;&nbsp;
1.4       dlhx65f0   10: (If you don&#8217;t know the difference between build and install, skip this
                     11: section and go to Installation/Setup guide.&nbsp; Even if you do know
                     12: the difference, you would almost certainly want to skip this section.)<br>
                     13: <br>
                     14: 1. The extension is implemented entirely in XUL/Javascript, so there is no need to build any C++ components.<br>
                     15: <br>
                     16: 2. The source code is provided in CVS inside the src/ directory, in
                     17: standard extension development format.&nbsp; Therefore, you may use any
                     18: standard method of packaging extensions you would like - for example,
                     19: the "Extension builder" feature of the Extension Developer extension
                     20: (http://ted.mielczarek.org/code/mozilla/extensiondev/).&nbsp; A
                     21: config_build.sh script is also provided, for use with the first bash
                     22: build script on this page:<br>
                     23: (http://kb.mozillazine.org/Bash_build_script).<br>
                     24: <br>
                     25: <span style="font-weight: bold; text-decoration: underline;">Installation/Setup guide:</span><br>
                     26: <br>
                     27: 1.&nbsp;&nbsp;&nbsp; Make sure you&#8217;re running Firefox.&nbsp; Ensure you
                     28: have Azureus running with the XML over HTTP plugin.&nbsp; As
                     29: installation varies from platform to platform, how to do this is beyond
                     30: the scope of this guide.&nbsp; See the Azureus homepage
                     31: (http://azureus.sourceforge.net/) for help on this subject.<br>
                     32: <br>
                     33: 2.&nbsp;&nbsp;&nbsp; Install the Azureus XML over HTTP plugin.&nbsp; <br>
1.9       dlhx65f0   34: &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; In Windows or Macintosh:<br>
1.4       dlhx65f0   35: &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; While in
1.10    ! dlhx65f0   36: Azureus, go Plugins, Installation Wizard and follow the prompts.&nbsp;
        !            37: (If this doesn't work for you in Macintosh, download the xml over http
        !            38: plugin zip file, make a folder called xml_http_if in
        !            39: Library/application support/Azureus/plugins and unzip the two files
        !            40: there.)<br>
1.4       dlhx65f0   41: &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; In Linux:<br>
1.8       dlhx65f0   42: &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; Download the zip from
1.4       dlhx65f0   43: (http://azureus.sourceforge.net/plugin_details.php?plugin=xml_http_if).<br>
                     44: &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; Locate the
                     45: azureus plugins directory on your system.&nbsp; The plugin directory
                     46: varies depending on the operating system - Linux places it under
                     47: "~/.azureus/plugins".&nbsp; Inside the plugins directory, make a
                     48: directory called "xml_http_if".&nbsp; Extract the contents of the zip
                     49: into this directory you just created, so you get a structure like
                     50: (continuing the Linux example):<br>
                     51: &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; ~/.azureus/plugins/xml_http_if/plugin.properties<br>
                     52: &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; ~/.azureus/plugins/xml_http_if/azureus.sig.<br>
                     53: <br>
                     54: 3. &nbsp;&nbsp;&nbsp; In the XML over HTTP plugin settings, make sure
                     55: you are using HTTP and not HTTPS.&nbsp; Also make sure that the list of
                     56: allowed hosts is changed from localhost if you are not communicating
                     57: with Azureus on the same machine.&nbsp; You may use a username/password
                     58: to authenticate if you would like; the extension supports this.<br>
                     59: <br>
                     60: 4. &nbsp;&nbsp;&nbsp; Click on the FoxTorrent link to install the XPI
                     61: and restart Firefox.&nbsp; The extension defaults to connecting to
                     62: localhost with the default port, so on the first run, if these are not
                     63: the correct settings for your Azureus instance, you may get a message
                     64: like "unable to connect, check your settings".&nbsp; You may ignore
                     65: this.<br>
                     66: <br>
                     67: 5. &nbsp;&nbsp;&nbsp; Go to the options page for the extension, and set
                     68: your host/port to the running instance of Azureus.&nbsp; If you require
                     69: authentication, check the "Authenticate" checkbox.&nbsp; The
                     70: application will prompt you for the username and password to use.&nbsp;
                     71: Note: the extension does not store the username and password for
                     72: security reasons; it will prompt you upon startup every time you run
                     73: Firefox.<br>
                     74: <br>
                     75: 6. &nbsp;&nbsp;&nbsp; If you open up the FoxTorrent sidebar using the
                     76: View-&gt;Sidebar menu, or by pressing Shift-Control-B, after a short
                     77: loading time (the application updates the list of torrents every 10
                     78: seconds), you should see the running torrents in your Azureus instance.<br>
                     79: <br>
                     80: <span style="font-weight: bold; text-decoration: underline;">Usage guide:</span><br>
                     81: <br>
                     82: 1.&nbsp;&nbsp;&nbsp; When you have your extension set up correctly, it
                     83: should display the list of running torrents in the FoxTorrent sidebar
                     84: in two separate list boxes; one for currently downloading torrents, and
                     85: one for seeding/completed torrents.&nbsp; Note: as the extension has to
                     86: parse an XML list of torrents, the more torrents you have, the more
                     87: FoxTorrent (and subsequently, Firefox) will bog down.&nbsp; This starts
                     88: becoming noticeable with Azureus instances running over roughly 100
                     89: torrents, but may also depend on the speed of your computer.<br>
                     90: <br>
                     91: 2.&nbsp;&nbsp;&nbsp; Mousing over any torrent should display a tooltip with more detailed info about the running torrent.<br>
                     92: <br>
                     93: 3. &nbsp;&nbsp;&nbsp; Right-clicking a torrent will provide a few
                     94: torrent management options - starting/stopping, move up and move down,
                     95: and remove.&nbsp; Note:&nbsp; due to the asynchronous update nature of
                     96: the extension, changes you make to the torrent list will not reflect
                     97: until the next update cycle or so.&nbsp; So you don't have to "remove"
                     98: a torrent 6 times, thinking it's not going away.&nbsp; Just do it once
                     99: and wait for the changes to reflect.&nbsp; The slow response will be
                    100: dealt with in a future version.<br>
                    101: <br>
                    102: 4. &nbsp;&nbsp;&nbsp; There are two ways to add a torrent: through the
                    103: "Add Torrent" button at the top of the FoxTorrent sidebar, or by the
                    104: right-click context menu.<br>
                    105: <br>
                    106: 5. &nbsp;&nbsp;&nbsp; The "Add Torrent" button pops up a dialog box,
                    107: allowing you to add either a local torrent or a torrent URL.&nbsp; Be
                    108: aware that many torrent links you will find on the web are scripted
                    109: links, and not direct links to torrent files. When submitting a torrent
                    110: URL, the extension checks to make sure the link ends in *.torrent -
                    111: this is a safety check; sometimes Azureus can break if you send it
                    112: links that are not torrents. Note: adding a torrent local to your
                    113: computer is not implemented yet.<br>
                    114: <br>
                    115: 6. &nbsp;&nbsp;&nbsp; Right-clicking on a link on a web page will
                    116: display an "Add to FoxTorrent" option in the context menu, right below
                    117: "Save link as...".&nbsp; If your connection is correctly set up, you
                    118: may send torrents to Azureus without ever opening the FoxTorrent
                    119: sidebar or "Add Torrent" dialog.&nbsp; Note: the "Add to FoxTorrent"
                    120: context item also checks to make sure the link ends with *.torrent, for
                    121: safety reasons.<br>
                    122: <br>
1.7       dlhx65f0  123: <p></p></body></html>

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