sources/torrentflux/README.Optware

   1 TorrentFlux for Optware README
   2 ----------------------------------------------------------------------
   3
   4 1. Introduction
   5 2. Differences from original TorrentFlux distribution
   6 3. Web server
   7 4. PHP settings
   8 5. Database creation
   9 6. Wiki page
  10
  11 ----------------------------------------------------------------------
  12 1. Introduction
  13
  14 This is a port of TorrentFlux (www.torrentflux.com) for the platforms
  15 support by Optware (www.nslu2-linux.org/wiki/Optware/HomePage).
  16
  17 ----------------------------------------------------------------------
  18 2. Differences from original Torrentflux distribution
  19
  20 Since Optware is aimed towards small machines with limited amounts of
  21 RAM, this port uses SQLite as a database engine instead of a MySQL
  22 database originally used by TorrentFlux. All functions that depend on
  23 the database, such as settings and event log, work flawlessly with
  24 SQLite, so the overall functionality remains the same.
  25
  26 In order to follow the standard guidelines for Optware packages and
  27 also to be compatible with some web server packages, the TorrentFlux
  28 web application is installed at /opt/share/www/torrentflux, while the
  29 database and the downloaded files are kept at /opt/var/torrentflux.
  30
  31 ----------------------------------------------------------------------
  32 3. Web server
  33
  34 TorrentFlux is a web application written in PHP, so you will need a
  35 web server that supports PHP installed in your machine. I have tested
  36 the program with lighttpd, a simple, fast web server well suited for
  37 small appliances like the NSLU2 and other Optware targets. If you have
  38 lighttpd installed, you can access TorrentFlux at
  39 http://nas_address:8083/torrentflux. Otherwise, you will need to
  40 configure your web server to serve pages from the directory at
  41 /opt/share/www/torrentflux.
  42
  43 ----------------------------------------------------------------------
  44 4. PHP settings
  45
  46 TorrentFlux may require some changes in PHP settings. Check your
  47 /opt/etc/php.ini file to make sure that these settings are in place:
  48
  49   safe_mode = Off
  50   allow_url_fopen = On
  51   cgi.fix_pathinfo = 1
  52
  53 After your make these changes, you should restart your web server.
  54
  55 ----------------------------------------------------------------------
  56 5. Manual database creation
  57
  58 When TorrentFlux is installed via ipkg it will automatically create a
  59 new database with its initial settings. If you try to upgrade or
  60 reinstall it, the database creation will be skipped and a warning
  61 message will be shown. If you are upgrading from the same base version
  62 (currently 2.4), the existing database should work and no further
  63 action is needed. If your previous installation was somehow damaged,
  64 or if you are in doubt, you can backup the existing database and
  65 create a new one with the following commands:
  66
  67   cd /opt/var/torrentflux/db
  68   cp torrentflux.db backup.db
  69   sqlite torrentflux.db < /opt/doc/torrentflux/sqlite_torrentflux.sql
  70
  71 ----------------------------------------------------------------------
  72 6. Wiki page
  73
  74 For more information, please see the wiki page for TorrentFlux under
  75 Optware at www.nslu2-linux.org/wiki/Optware/TorrentFlux.
  76
  77