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