Skip to content
Full-featured BitTorrent-client package and utilities
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Remove gomobile from CI Mar 22, 2019
bencode
cmd Adds more flags to torrent-create Mar 1, 2019
fs Switch to goimports import sorting Nov 2, 2018
internal/testutil Switch to goimports import sorting Nov 2, 2018
iplist Switch to goimports import sorting Nov 2, 2018
logonce
metainfo metainfo: Fix test Nov 27, 2018
mmap_span mmap_span: Synchronize access to memory maps to avoid race when unmap… Jan 6, 2018
mse
peer_protocol bencode: Fix marshalling of []byte(nil) Nov 26, 2018
storage
testdata
tracker
util/dirwatch
LICENSE Update LICENSE Jan 27, 2018
Peer.go
Peers.go Switch to goimports import sorting Nov 2, 2018
README.md
TODO Update TODO file Apr 14, 2018
bad_storage.go Some test tidying and improvements Jan 29, 2018
bep40.go Move IpPort to missinggo Nov 15, 2018
bep40_test.go Remove unnecessary blank line Jan 30, 2019
client.go
client_test.go
closewrapper.go
config.go Bump protocol strings Nov 21, 2018
conn_stats.go
connection.go
connection_test.go
doc.go List implemented BEPs Jul 11, 2016
example_test.go Add File.NewReader Jan 6, 2018
file.go
file_test.go
global.go
go.mod
go.sum vgo get -u Mar 19, 2019
handshake.go sortimports Jul 7, 2018
handshake_test.go
issue211_test.go Switch to goimports import sorting Nov 2, 2018
issue97_test.go
listen.go Remove unused code Nov 27, 2018
main_test.go
misc.go Move IpPort to missinggo Nov 15, 2018
misc_test.go Remove excess newline from log call Jun 13, 2018
multiless.go
network_test.go Use the new firewall callback support in go-libutp Jul 25, 2018
networks.go Improve network handling and only listen networks we will use Nov 27, 2018
peerid.go
peerid_test.go
piece.go Reduce allocations for Piece.hash Jan 30, 2019
piecestate.go
portfwd.go
prioritized_peers.go
prioritized_peers_test.go
protocol.go
ratelimitreader.go Fix download rate limiter and add test Jan 28, 2018
reader.go Fix double quoting in a log statement Mar 3, 2019
reader_test.go Switch to goimports import sorting Nov 2, 2018
rlreader_test.go
socket.go
spec.go
t.go
torrent.go Fix race condition in Torrent.SetDisplayName Mar 20, 2019
torrent_stats.go Merge a bunch of stuff into ConnStats and refactor connection.upload Feb 2, 2018
torrent_test.go
tracker_scraper.go Switch to goimports import sorting Nov 2, 2018
utp.go
utp_go.go Use the new firewall callback support in go-libutp Jul 25, 2018
utp_libutp.go Use the new firewall callback support in go-libutp Jul 25, 2018
utp_test.go
worst_conns.go Calculate peer priority lazily for worse conn comparison Jul 15, 2018

README.md

torrent

Join the chat at https://gitter.im/anacrolix/torrent GoDoc CircleCI

This repository implements BitTorrent-related packages and command-line utilities in Go. The emphasis is on use as a library from other projects. It's been used 24/7 in production by downstream services since late 2014. The implementation was specifically created to explore Go's concurrency capabilities, and to include the ability to stream data directly from the BitTorrent network. To this end it supports seeking, readaheads and other features exposing torrents and their files with the various Go idiomatic io package interfaces. This is also demonstrated through torrentfs.

There is support for protocol encryption, DHT, PEX, uTP, and various extensions. There are several data storage backends provided: blob, file, bolt, and mmap, to name a few. You can write your own to store data for example on S3, or in a database.

Some noteworthy package dependencies that can be used for other purposes include:

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 examples

There are some small examples in the package documentation.

Downstream projects

There are several web-frontends and Android clients among the known public projects:

Help

Communication about the project is primarily through Gitter and the issue tracker.

Command packages

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

Note that the godo command which is invoked in the following examples 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. This first example does not use godo.

$ go get github.com/anacrolix/torrent/cmd/torrent
# Now 'torrent' should be in $GOPATH/bin, which should be in $PATH.
$ torrent 'magnet:?xt=urn:btih:KRWPCX3SJUM4IMM4YF5RPHL6ANPYTQPU'
ubuntu-14.04.2-desktop-amd64.iso [===================================================================>]  99% downloading (1.0 GB/1.0 GB)
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 -metainfoDir. 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 -metainfoDir=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
You can’t perform that action at this time.