README

   1 -- ETORRENT --
   2
   3 ETORRENT is a bittorrent client written in Erlang. The focus is on
   4 robustness and scalability in number of torrents rather than in pure
   5 speed. ETORRENT is mostly meant for unattended operation, where one
   6 just specifies what files to download and gets a notification when
   7 they are.
   8
   9 ETORRENT was mostly conceived as an experiment in how easy it would be
  10 to write a bittorrent client in Erlang. The hypothesis is that the
  11 code will be cleaner and smaller than comparative bittorrent clients.
  12
  13 Note that the code is not yet battle scarred. It has not stood up to the
  14 testing of time and as such, it will fail - sometimes in nasty ways and
  15 maybe as a bad p2p citizen. Hence, you should put restraint in using it
  16 unless you are able to fix eventual problems. If you've noticed any bad
  17 behavior it is definitely a bug and should be reported as soon as possible
  18 so we can get it away.
  19
  20 Currently supported BEPs:
  21
  22 BEP 03 - The BitTorrent Protocol Specification.
  23 BEP 04 - Known Number Allocations.
  24 BEP 23 - Tracker Returns Compact Peer Lists.
  25
  26 -- GETTING STARTED WITHOUT INSTALLING --
  27
  28 1. Check Makefile.config for the right configuration options
  29 2. run 'make'
  30 3. create 'lib/etorrent-1.0/priv/etorrent.config' there is an example
  31    file in the same dir.
  32 4. run 'make run' which will spawn etorrent in a running
  33    configuration.
  34
  35 5. drop a .torrent file in the watched dir and see what happens.
  36
  37 6. call etorrent:help(). from the Erlang CLI to get a list of available
  38    commands.
  39
  40 -- GETTING STARTED WITH INSTALLING --
  41
  42 1. edit 'Makefile.config' to suit your liking.
  43
  44 2. run 'make'
  45
  46 3. run 'make install' (with proper privileges)
  47
  48 4. There is an etorrentctl shell script dropped in $PREFIX/bin that can
  49    be used for manipulating the running etorrent instance.
  50
  51 -- REPORTING BUGS --
  52
  53 Either mail them to jesper.louis.andersen@gmail.com (We are
  54 currently lacking a mailing list) or use the issue tracker:
  55
  56   http://code.google.com/p/etorrent/issues/list