Go to file
Matt Joiner 5b0c46cd54 Fix false positive Goland code lint 2020-04-16 14:52:52 +10:00
.circleci Switch CI to go1.14 2020-03-29 11:38:25 +11:00
bencode Apply staticcheck 2020-02-20 11:09:57 +11:00
cmd cmd/torrent: Fix -{utp,tcp}Peers defaults 2020-04-16 10:26:37 +10:00
fs Apply staticcheck 2020-02-20 11:09:57 +11:00
internal Move envpprof imports around 2020-02-21 12:58:47 +11:00
iplist goimports -local 2019-08-21 20:58:40 +10:00
logonce Add a prefix to logonce logger output 2018-09-03 11:48:31 +10:00
metainfo Clone the AnnounceList out of Torrent.Metainfo 2020-04-15 17:26:02 +10:00
mmap_span mmap_span: Synchronize access to memory maps to avoid race when unmapping 2018-01-06 16:39:52 +11:00
mse mse: Fix race in BenchmarkStreamRC4 2019-10-01 18:11:44 +10:00
peer_protocol PEX: add periodic deltas 2020-04-15 17:24:44 +10:00
storage Use default bbolt package alias 2020-03-24 12:55:03 +11:00
test Fix small cache transfer tests 2020-04-16 14:12:17 +10:00
testdata Add the fs test torrent to the repo 2017-12-29 13:50:26 +11:00
tracker Apply staticcheck 2020-02-20 11:09:57 +11:00
util/dirwatch goimports -local 2019-08-21 20:58:40 +10:00
webtorrent More error handling and logging clean up 2020-04-14 10:47:26 +10:00
.gitignore Ignore ".torrent.bolt.db" which is generated by unit tests 2019-06-21 14:53:57 +10:00
LICENSE Update LICENSE 2018-01-27 11:21:33 +11:00
Peer.go Adjust recently added logging 2020-04-16 12:17:18 +10:00
Peers.go Rename connection->PeerConn and fix exports 2020-02-21 11:07:50 +11:00
README.md Readme: Add downstream project 2020-03-24 11:30:15 +10:00
TODO Update TODO file 2018-04-14 21:44:50 +10:00
bad_storage.go Some test tidying and improvements 2018-01-29 18:22:21 +11:00
bep40.go Move IpPort to missinggo 2018-11-16 10:35:30 +11:00
bep40_test.go fixes various vet errors 2020-01-14 09:09:09 +10:00
client.go Don't try to do conventional dials if we have no dialers 2020-04-16 12:00:49 +10:00
client_test.go Fix false positive Goland code lint 2020-04-16 14:52:52 +10:00
closewrapper.go Add initial connection tracking 2018-11-21 17:02:22 +11:00
config.go Fix small cache transfer tests 2020-04-16 14:12:17 +10:00
conn_stats.go Add doc comments related to #383 2020-03-16 16:30:39 +11:00
deferrwl.go Switch back to anacrolix/sync for the Client lock 2019-12-17 20:49:40 +11:00
dht.go Support custom DHT servers 2020-02-20 17:46:29 +11:00
dialer.go Add support for non-IP-based networks 2020-02-20 16:47:37 +11:00
doc.go List implemented BEPs 2016-07-11 13:53:00 +10:00
example_test.go Add File.NewReader 2018-01-06 16:37:13 +11:00
file.go Rewrite file.bytesLeft 2020-03-24 12:15:35 +11:00
file_test.go Rewrite file.bytesLeft 2020-03-24 12:15:35 +11:00
global.go Update the peersAddedBySource expvar 2020-04-16 11:56:58 +10:00
go.mod Fix panic in status for webrtc connections 2020-04-13 14:08:32 +10:00
go.sum Fix panic in status for webrtc connections 2020-04-13 14:08:32 +10:00
handshake.go Rework header obfuscation and add tests for fallbacks 2019-07-19 13:23:36 +10:00
handshake_test.go Support AllowedFast and enable fast extension 2018-02-05 00:18:38 +11:00
ipport.go Add support for non-IP-based networks 2020-02-20 16:47:37 +11:00
issue97_test.go Propagate back piece hashing errors 2020-01-14 10:51:09 +11:00
issue211_test.go goimports -local 2019-08-21 20:58:40 +10:00
listen.go Remove unused code 2018-11-27 23:57:17 +11:00
main_test.go Move envpprof imports around 2020-02-21 12:58:47 +11:00
misc.go Rename connection->PeerConn and fix exports 2020-02-21 11:07:50 +11:00
misc_test.go Extract the request strategy logic 2020-01-14 10:51:09 +11:00
multiless.go Apply staticcheck 2020-02-20 11:09:57 +11:00
network_test.go Use the new firewall callback support in go-libutp 2018-07-25 17:11:09 +10:00
networks.go Improve network handling and only listen networks we will use 2018-11-28 10:30:21 +11:00
peerconn.go PEX: integrate with send throttling 2020-04-16 09:37:38 +10:00
peerconn_test.go Merge branch 'webtorrent' 2020-04-15 17:26:46 +10:00
peerid.go Change a bunch of Stringer and status stuff 2018-02-05 17:47:47 +11:00
peerid_test.go Change a bunch of Stringer and status stuff 2018-02-05 17:47:47 +11:00
pex.go PEX: add periodic deltas 2020-04-15 17:24:44 +10:00
pex_test.go PEX: add periodic deltas 2020-04-15 17:24:44 +10:00
pexconn.go PEX: integrate with send throttling 2020-04-16 09:37:38 +10:00
pexconn_test.go Fix change in Client.newConnection 2020-04-15 17:28:39 +10:00
piece.go Add Piece.UpdateCompletion() method 2020-04-05 08:57:58 +10:00
piecestate.go Remove vestigial comment 2018-05-02 19:23:05 +10:00
portfwd.go Possibility to change UPnP ID (#354) 2019-12-16 13:22:24 +11:00
prioritized_peers.go Include hashed addr when comparing prioritized peers 2020-04-16 11:59:31 +10:00
prioritized_peers_test.go Add support for non-IP-based networks 2020-02-20 16:47:37 +11:00
protocol.go Abstract out making a cancel message 2017-09-18 13:42:42 +10:00
ratelimitreader.go Fix download rate limiter and add test 2018-01-28 15:28:45 +11:00
reader.go Skip 1 frame in reader.log 2020-01-23 13:55:40 +11:00
reader_test.go goimports -local 2019-08-21 20:58:40 +10:00
request_strategy.go Move requestStrategyDefaults into its own file 2020-02-27 09:45:13 +11:00
request_strategy_defaults.go Move requestStrategyDefaults into its own file 2020-02-27 09:45:13 +11:00
rlreader_test.go sortimports 2018-01-31 16:42:40 +11:00
socket.go Add support for non-IP-based networks 2020-02-20 16:47:37 +11:00
spec.go Add error return value to metainfo.MetaInfo.UnmarshalInfo 2016-09-20 12:32:15 +10:00
t.go Fix pending peer counts in transfer tests 2020-04-16 14:09:45 +10:00
testing.go Extract the transfer tests 2020-02-20 13:57:24 +11:00
torrent.go Fix small cache transfer tests 2020-04-16 14:12:17 +10:00
torrent_pending_pieces.go Use stable bit set for pending pieces PriorityBitmap 2020-02-27 18:33:44 +11:00
torrent_stats.go Add doc comments related to #383 2020-03-16 16:30:39 +11:00
torrent_test.go PEX: add connection tracking 2020-04-15 17:24:44 +10:00
tracker_scraper.go Adjust recently added logging 2020-04-16 12:17:18 +10:00
utp.go Add support for disabling IPv4 and IPv4 peers 2018-02-16 10:46:11 +11:00
utp_go.go Use the new firewall callback support in go-libutp 2018-07-25 17:11:09 +10:00
utp_libutp.go Use the new firewall callback support in go-libutp 2018-07-25 17:11:09 +10:00
utp_test.go Use the new firewall callback support in go-libutp 2018-07-25 17:11:09 +10:00
webrtc.go Big tidy up of webtorrent code 2020-04-07 14:30:27 +10:00
worst_conns.go Fix panic in status for webrtc connections 2020-04-13 14:08:32 +10:00
wstracker.go Tidy up the webtorrent package, remove buffer 2020-04-13 14:31:39 +10:00

README.md

torrent

Join the chat at https://gitter.im/anacrolix/torrent GoDoc CircleCI Astronomer Rating GitHub Release

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