Full-featured BitTorrent client package and utilities
Go to file
Matt Joiner d48b755776 cmd/torrent-magnet: Error if arguments are given
Too easy to make this mistake, and then it hangs.
2015-04-08 02:15:25 +10:00
cmd cmd/torrent-magnet: Error if arguments are given 2015-04-08 02:15:25 +10:00
data Fix a few minor data races 2015-03-30 23:10:37 +11:00
dht Added BootstrapNodes to dht.ServerConfig 2015-04-02 23:35:30 +01:00
fs fs: Improve test logging 2015-04-08 01:43:50 +10:00
internal Add piece blob torrent.Data storage, and move testutil to internal/, add basic transfer test for Client and blob 2015-02-27 01:46:02 +11:00
iplist iplist: Fail invalid IPs, they were always passing 2015-03-28 02:54:17 +11:00
logonce logonce is a package that prints each distinct message only once 2014-11-16 13:04:44 -06:00
mmap_span mmap_span: Avoid allocating the span slice on every use 2014-12-05 00:54:55 -06:00
mse Use rogpeppe's sortimports to fix this goimports ordering madness 2015-03-26 17:18:08 +11:00
peer_protocol Add support for Fast Extension 2015-03-12 20:06:23 +11:00
tracker Fix peer parsing error introduced during tracker package merges 2015-03-30 23:05:39 +11:00
util Merge all the tracker packages, why would anyone want them separately? 2015-03-27 15:12:15 +11:00
LICENSE The license is MPL2.0 2015-03-25 17:35:33 +11:00
NOTES Add UTP support, disable TCP for now. DHT moves to another port 2014-11-16 13:29:31 -06:00
README.md dht: Clean-up interface, add loads of documentation 2015-04-01 17:29:55 +11:00
TODO TODO 2015-03-01 14:33:10 +11:00
client.go If IP blocklists are enabled, block anything that isn't IPv4 2015-04-01 17:36:51 +11:00
client_test.go AddTorrentSpec now merges in new information an existing torrent didn't have 2015-03-28 02:50:55 +11:00
config.go Add the ability to disable PEX 2015-03-25 15:42:14 +11:00
connection.go Prevent bad metadata_size in extended handshakes from stalling completion of metadata 2015-03-27 15:36:59 +11:00
connection_test.go Use rogpeppe's sortimports to fix this goimports ordering madness 2015-03-26 17:18:08 +11:00
magnet.go Make ParseMagnetURI easier to read 2015-03-22 13:50:16 -04:00
magnet_test.go Fix test error message 2015-03-22 13:57:57 -04:00
misc.go Move piece into its own file 2015-04-08 02:14:35 +10:00
ordered.go More cleaning of public interface 2015-03-08 17:28:14 +11:00
ordered_test.go More cleaning of public interface 2015-03-08 17:28:14 +11:00
piece.go Move piece into its own file 2015-04-08 02:14:35 +10:00
stateless.go Rewrite import paths for migration from Bitbucket 2015-03-20 16:37:44 +11:00
torrent.go Prevent bad metadata_size in extended handshakes from stalling completion of metadata 2015-03-27 15:36:59 +11:00
torrent_test.go Rewrite import paths for migration from Bitbucket 2015-03-20 16:37:44 +11:00
worst_conns.go Piece priorities, torrent read interface and many fixes 2014-12-03 01:07:50 -06:00

README.md

torrent

Codeship GoDoc

This repository implements BitTorrent-related packages and command-line utilities in Go.

There is support for protocol encryption, DHT, PEX, uTP, and various extensions. There are several storage backends provided, blob, file, mmap. You can use the provided binaries in ./cmd, or use torrent as a library for your own applications.

See also the mailing list, and the Gophers Slack channel.

Installation

Install the library package with go get github.com/anacrolix/torrent, or the provided cmds with go get github.com/anacrolix/torrent/cmd/....

Library example

There is a small example in the package documentation.

Commands

Here I'll describe what some of the provided commands in ./cmd do.

Note that godo that I invoke in the following examples is a command that builds and executes a Go import path, like go run. It's easier to use this convention than to spell out the install/invoke cycle for every single example.

torrent

Downloads torrents from the command-line.

$ go get github.com/anacrolix/torrent/cmd/torrent
$ torrent 'magnet:?xt=urn:btih:KRWPCX3SJUM4IMM4YF5RPHL6ANPYTQPU'
2015/04/01 02:08:20 main.go:137: downloaded ALL the torrents
$ md5sum ubuntu-14.04.2-desktop-amd64.iso
1b305d585b1918f297164add46784116  ubuntu-14.04.2-desktop-amd64.iso
$ echo such amaze
wow

torrentfs

torrentfs mounts a FUSE filesystem at -mountDir. The contents are the torrents described by the torrent files and magnet links at -torrentPath. Data for read requests is fetched only as required from the torrent network, and stored at -downloadDir.

$ mkdir mnt torrents
$ godo github.com/anacrolix/torrent/cmd/torrentfs -mountDir mnt -torrentPath torrents &
$ cd torrents
$ wget http://releases.ubuntu.com/14.04.2/ubuntu-14.04.2-desktop-amd64.iso.torrent
$ cd ..
$ ls mnt
ubuntu-14.04.2-desktop-amd64.iso
$ pv mnt/ubuntu-14.04.2-desktop-amd64.iso | md5sum
996MB 0:04:40 [3.55MB/s] [========================================>] 100%
1b305d585b1918f297164add46784116  -

torrent-magnet

Creates a magnet link from a torrent file. Note the extracted trackers, display name, and info hash.

$ godo github.com/anacrolix/torrent/cmd/torrent-magnet < ubuntu-14.04.2-desktop-amd64.iso.torrent
magnet:?xt=urn:btih:546cf15f724d19c4319cc17b179d7e035f89c1f4&dn=ubuntu-14.04.2-desktop-amd64.iso&tr=http%3A%2F%2Ftorrent.ubuntu.com%3A6969%2Fannounce&tr=http%3A%2F%2Fipv6.torrent.ubuntu.com%3A6969%2Fannounce

dht-ping

Pings DHT nodes with the given network addresses.

$ godo ./cmd/dht-ping router.bittorrent.com:6881 router.utorrent.com:6881
2015/04/01 17:21:23 main.go:33: dht server on [::]:60058
32f54e697351ff4aec29cdbaabf2fbe3467cc267 (router.bittorrent.com:6881): 648.218621ms
ebff36697351ff4aec29cdbaabf2fbe3467cc267 (router.utorrent.com:6881): 873.864706ms
2/2 responses (100.000000%)