extensions/net.sf.basedb.torrent/trunk/README

Code
Comments
Other
Rev Date Author Line
1245 21 Oct 10 nicklas 1 == Requirements ==
1245 21 Oct 10 nicklas 2
1636 03 May 12 nicklas 3  1. BASE 3.1.0 or later.
1245 21 Oct 10 nicklas 4  
1245 21 Oct 10 nicklas 5 == Introduction ==
1245 21 Oct 10 nicklas 6
1245 21 Oct 10 nicklas 7 This package is an extension package to BASE that installs a bittorrent
1245 21 Oct 10 nicklas 8 download service as part of the web server. It builds on the HTBTC library
1245 21 Oct 10 nicklas 9 for handling of the bittorrent protocol.
1245 21 Oct 10 nicklas 10
1245 21 Oct 10 nicklas 11  * The homepage for this extension: 
1245 21 Oct 10 nicklas 12    http://baseplugins.thep.lu.se/wiki/net.sf.basedb.torrent
1245 21 Oct 10 nicklas 13  * The HPBTC site: 
1245 21 Oct 10 nicklas 14    http://sourceforge.net/projects/hpbtc/
1245 21 Oct 10 nicklas 15
1245 21 Oct 10 nicklas 16 == Installation ==
1245 21 Oct 10 nicklas 17
1245 21 Oct 10 nicklas 18  1. Download the `base-torrent-*.tar.gz` file.
1245 21 Oct 10 nicklas 19  2. Unpack the downloaded file to a directory of your choice.
1245 21 Oct 10 nicklas 20  3. Copy the `torrent.properties` file to `WEB-INF/classes` directory.
1636 03 May 12 nicklas 21  4. Copy the `base-torrent.jar` file  to your BASE plug-ins directory.
1636 03 May 12 nicklas 22     Eg. the directory specified by the `plugins.dir` setting in `base.config`.
1636 03 May 12 nicklas 23  5. Log in to BASE as a user with Administrator priviliges. 
1636 03 May 12 nicklas 24  6. Go to 'Administrate->Plug-ins & Extensions->Overview' page.
1636 03 May 12 nicklas 25     Run the installation wizard and select to install/update `base-torrent.jar`.
1636 03 May 12 nicklas 26  7. Done.
1245 21 Oct 10 nicklas 27
1245 21 Oct 10 nicklas 28 == Known issues ==
1245 21 Oct 10 nicklas 29
1245 21 Oct 10 nicklas 30 This software is still in prototype status. Do not install in a production environment.
1245 21 Oct 10 nicklas 31  
1245 21 Oct 10 nicklas 32 == Compiling ==
1245 21 Oct 10 nicklas 33
1245 21 Oct 10 nicklas 34 To compile this package you also need:
1245 21 Oct 10 nicklas 35  
1245 21 Oct 10 nicklas 36  1. Ant 1.6
1245 21 Oct 10 nicklas 37  2. Java 1.6
1245 21 Oct 10 nicklas 38
1245 21 Oct 10 nicklas 39 Follow these instructions:
1245 21 Oct 10 nicklas 40
1245 21 Oct 10 nicklas 41  1. Download the source code from the subversion repository. See
1245 21 Oct 10 nicklas 42     http://baseplugins.thep.lu.se/wiki/net.sf.basedb.torrent for instructions.
1245 21 Oct 10 nicklas 43  
1245 21 Oct 10 nicklas 44  2. Type `ant download-lib` to automatically download the BASE core JAR file that
1245 21 Oct 10 nicklas 45     are neeed for compilation. You can also do this manually by copying the 
1636 03 May 12 nicklas 46     base-core-*.jar and base-webclient-*.jar from the BASE installation directory 
1245 21 Oct 10 nicklas 47     (`<basedir>/www/WEB-INF/lib/`) to the `./lib/compile` directory.
1245 21 Oct 10 nicklas 48
1245 21 Oct 10 nicklas 49  3. Type `ant` to compile the code and generate the `base-torrent.jar` file
1245 21 Oct 10 nicklas 50     in the project directory.
1245 21 Oct 10 nicklas 51
1245 21 Oct 10 nicklas 52  4. Use `ant package` to create a downloadable tar.gz package.
1245 21 Oct 10 nicklas 53  
1245 21 Oct 10 nicklas 54 Tip: If you need different values for any of the properties defined in
1245 21 Oct 10 nicklas 55 the 'build.xml' file, create a file named 'build.properties' and set
1245 21 Oct 10 nicklas 56 the values there.

Generated on Tue Nov 21 03:37:57 2023 (UTC) by svndigest 0.11.2pre (dev build 1672)