Permalink
Find file
Fetching contributors…
Cannot retrieve contributors at this time
57 lines (39 sloc) 1.92 KB
-- ETORRENT --
ETORRENT is a bittorrent client written in Erlang. The focus is on
robustness and scalability in number of torrents rather than in pure
speed. ETORRENT is mostly meant for unattended operation, where one
just specifies what files to download and gets a notification when
they are.
ETORRENT was mostly conceived as an experiment in how easy it would be
to write a bittorrent client in Erlang. The hypothesis is that the
code will be cleaner and smaller than comparative bittorrent clients.
Note that the code is not yet battle scarred. It has not stood up to the
testing of time and as such, it will fail - sometimes in nasty ways and
maybe as a bad p2p citizen. Hence, you should put restraint in using it
unless you are able to fix eventual problems. If you've noticed any bad
behavior it is definitely a bug and should be reported as soon as possible
so we can get it away.
Currently supported BEPs:
BEP 03 - The BitTorrent Protocol Specification.
BEP 04 - Known Number Allocations.
BEP 23 - Tracker Returns Compact Peer Lists.
-- GETTING STARTED WITHOUT INSTALLING --
1. Check Makefile.config for the right configuration options
2. run 'make'
3. create 'lib/etorrent-1.0/priv/etorrent.config' there is an example
file in the same dir.
4. run 'make run' which will spawn etorrent in a running
configuration.
5. drop a .torrent file in the watched dir and see what happens.
6. call etorrent:help(). from the Erlang CLI to get a list of available
commands.
-- GETTING STARTED WITH INSTALLING --
1. edit 'Makefile.config' to suit your liking.
2. run 'make'
3. run 'make install' (with proper privileges)
4. There is an etorrentctl shell script dropped in $PREFIX/bin that can
be used for manipulating the running etorrent instance.
-- REPORTING BUGS --
Either mail them to jesper.louis.andersen@gmail.com (We are
currently lacking a mailing list) or use the issue tracker:
http://code.google.com/p/etorrent/issues/list