soult / nanotrack

== About ==
nanotrack is my small toy BitTorrent tracker. My goal was to create a fast
BitTorrent tracker with PHP and mySQL as backend. If you really want a
high-speed tracker and have more than just PHP webspace you should consider
using  opentracker[1].

== Install ==
* Edit config.inc.php
* Create the MySQL table (execute table.sql)
* Upload announce.php, config.inc.php and cron.php
* Create a cronjob that calls cron.php every now and then
+ Optional: Add a redirect from announce to announce.php

== Bugs ==
PHP has a bug that excludes data from $_GET if the value contains a nullbyte,
therefore info-hashes with nullbytes can't be tracked. I am thinking about
implementing a workaround.
You might also consider as a bug that nanotracker only "estimates" the ratio
of seeders to leechers based on the total number of peers.
The scrape protocol is not supported at the moment, I am not even sure if it's
worth adding it.
Last but not least, no IPv6 support. Would only bloat the code for a very
small group of very early adopters. Maybe when IPv6 has more users.

== bencode.php ==
This file is not needed for running the tracker. It includes two functions,
bencode() and bdecode(). Maybe they are helpful to someone.

-----
1: http://erdgeist.org/arts/software/opentracker/

vim:tw=78: