周玉环 d906a41c2e first commit vor 2 Tagen
..
bencode d906a41c2e first commit vor 2 Tagen
common d906a41c2e first commit vor 2 Tagen
dialer d906a41c2e first commit vor 2 Tagen
internal d906a41c2e first commit vor 2 Tagen
iplist d906a41c2e first commit vor 2 Tagen
logonce d906a41c2e first commit vor 2 Tagen
merkle d906a41c2e first commit vor 2 Tagen
metainfo d906a41c2e first commit vor 2 Tagen
mmap_span d906a41c2e first commit vor 2 Tagen
mse d906a41c2e first commit vor 2 Tagen
peer_protocol d906a41c2e first commit vor 2 Tagen
request-strategy d906a41c2e first commit vor 2 Tagen
segments d906a41c2e first commit vor 2 Tagen
smartban d906a41c2e first commit vor 2 Tagen
storage d906a41c2e first commit vor 2 Tagen
tracker d906a41c2e first commit vor 2 Tagen
typed-roaring d906a41c2e first commit vor 2 Tagen
types d906a41c2e first commit vor 2 Tagen
version d906a41c2e first commit vor 2 Tagen
webseed d906a41c2e first commit vor 2 Tagen
webtorrent d906a41c2e first commit vor 2 Tagen
.deepsource.toml d906a41c2e first commit vor 2 Tagen
.gitignore d906a41c2e first commit vor 2 Tagen
.golangci.yml d906a41c2e first commit vor 2 Tagen
Dockerfile d906a41c2e first commit vor 2 Tagen
LICENSE d906a41c2e first commit vor 2 Tagen
NOTES.md d906a41c2e first commit vor 2 Tagen
README.md d906a41c2e first commit vor 2 Tagen
SECURITY.md d906a41c2e first commit vor 2 Tagen
TODO d906a41c2e first commit vor 2 Tagen
bad_storage.go d906a41c2e first commit vor 2 Tagen
bep40.go d906a41c2e first commit vor 2 Tagen
callbacks.go d906a41c2e first commit vor 2 Tagen
client-stats.go d906a41c2e first commit vor 2 Tagen
client.go d906a41c2e first commit vor 2 Tagen
config.go d906a41c2e first commit vor 2 Tagen
conn_stats.go d906a41c2e first commit vor 2 Tagen
deferrwl.go d906a41c2e first commit vor 2 Tagen
dht.go d906a41c2e first commit vor 2 Tagen
dial-pool.go d906a41c2e first commit vor 2 Tagen
dialer.go d906a41c2e first commit vor 2 Tagen
doc.go d906a41c2e first commit vor 2 Tagen
file.go d906a41c2e first commit vor 2 Tagen
global.go d906a41c2e first commit vor 2 Tagen
handshake.go d906a41c2e first commit vor 2 Tagen
ipport.go d906a41c2e first commit vor 2 Tagen
listen.go d906a41c2e first commit vor 2 Tagen
logging.go d906a41c2e first commit vor 2 Tagen
ltep.go d906a41c2e first commit vor 2 Tagen
misc.go d906a41c2e first commit vor 2 Tagen
netip-addrport.go d906a41c2e first commit vor 2 Tagen
networks.go d906a41c2e first commit vor 2 Tagen
ordered-bitmap.go d906a41c2e first commit vor 2 Tagen
otel.go d906a41c2e first commit vor 2 Tagen
peer-conn-msg-writer.go d906a41c2e first commit vor 2 Tagen
peer-impl.go d906a41c2e first commit vor 2 Tagen
peer.go d906a41c2e first commit vor 2 Tagen
peer_info.go d906a41c2e first commit vor 2 Tagen
peer_infos.go d906a41c2e first commit vor 2 Tagen
peerconn.go d906a41c2e first commit vor 2 Tagen
peerid.go d906a41c2e first commit vor 2 Tagen
pex.go d906a41c2e first commit vor 2 Tagen
pexconn.go d906a41c2e first commit vor 2 Tagen
piece.go d906a41c2e first commit vor 2 Tagen
piecestate.go d906a41c2e first commit vor 2 Tagen
portfwd.go d906a41c2e first commit vor 2 Tagen
prioritized-peers.go d906a41c2e first commit vor 2 Tagen
protocol.go d906a41c2e first commit vor 2 Tagen
ratelimitreader.go d906a41c2e first commit vor 2 Tagen
reader.go d906a41c2e first commit vor 2 Tagen
request-strategy-impls.go d906a41c2e first commit vor 2 Tagen
requesting.go d906a41c2e first commit vor 2 Tagen
roaring.go d906a41c2e first commit vor 2 Tagen
smartban.go d906a41c2e first commit vor 2 Tagen
socket.go d906a41c2e first commit vor 2 Tagen
sockopts.go d906a41c2e first commit vor 2 Tagen
sockopts_unix.go d906a41c2e first commit vor 2 Tagen
sockopts_wasm.go d906a41c2e first commit vor 2 Tagen
sockopts_windows.go d906a41c2e first commit vor 2 Tagen
sources.go d906a41c2e first commit vor 2 Tagen
spec.go d906a41c2e first commit vor 2 Tagen
stats.go d906a41c2e first commit vor 2 Tagen
string-addr.go d906a41c2e first commit vor 2 Tagen
t.go d906a41c2e first commit vor 2 Tagen
testing.go d906a41c2e first commit vor 2 Tagen
torrent-piece-request-order.go d906a41c2e first commit vor 2 Tagen
torrent-stats.go d906a41c2e first commit vor 2 Tagen
torrent.go d906a41c2e first commit vor 2 Tagen
tracker_scraper.go d906a41c2e first commit vor 2 Tagen
undirtied-chunks-iter.go d906a41c2e first commit vor 2 Tagen
url-net-addr.go d906a41c2e first commit vor 2 Tagen
ut-holepunching.go d906a41c2e first commit vor 2 Tagen
utp.go d906a41c2e first commit vor 2 Tagen
utp_go.go d906a41c2e first commit vor 2 Tagen
utp_libutp.go d906a41c2e first commit vor 2 Tagen
webrtc.go d906a41c2e first commit vor 2 Tagen
webseed-peer.go d906a41c2e first commit vor 2 Tagen
worse-conns.go d906a41c2e first commit vor 2 Tagen
wstracker.go d906a41c2e first commit vor 2 Tagen
zero-reader.go d906a41c2e first commit vor 2 Tagen

README.md

torrent

PkgGoDev

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, mmap, and sqlite, 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 install github.com/anacrolix/torrent/cmd/...@latest.

Library examples

There are some small examples in the package documentation.

Mentions

Downstream projects

There are several web-frontends, sites, Android clients, storage backends and supporting services among the known public projects:

  • cove: Personal torrent browser with streaming, DHT search, video transcoding and casting.
  • confluence: torrent client as a HTTP service
  • Gopeed: Gopeed (full name Go Speed), a high-speed downloader developed by Golang + Flutter, supports (HTTP, BitTorrent, Magnet) protocol, and supports all platforms.
  • Erigon: an implementation of Ethereum (execution layer with embeddable consensus layer), on the efficiency frontier.
  • exatorrent: Elegant self-hostable torrent client
  • bitmagnet: A self-hosted BitTorrent indexer, DHT crawler, content classifier and torrent search engine with web UI, GraphQL API and Servarr stack integration.
  • TorrServer: Torrent streaming server over http
  • distribyted: Distribyted is an alternative torrent client. It can expose torrent files as a standard FUSE, webDAV or HTTP endpoint and download them on demand, allowing random reads using a fixed amount of disk space.
  • Mangayomi: Cross-platform app that allows users to read manga and stream anime from a variety of sources including BitTorrent.
  • Simple Torrent: self-hosted HTTP remote torrent client
  • autobrr: autobrr redefines download automation for torrents and Usenet, drawing inspiration from tools like trackarr, autodl-irssi, and flexget.
  • mabel: Fancy BitTorrent client for the terminal
  • Toru: Stream anime from the the terminal!
  • webtor.io: free cloud BitTorrent-client
  • Android Torrent Client: Android torrent client
  • libtorrent: gomobile wrapper
  • Go-PeersToHTTP: Simple torrent proxy to http stream controlled over REST-like api
  • CortexFoundation/torrentfs: Independent HTTP service for file seeding and P2P file system of cortex full node
  • Torrent WebDAV Client: Automatic torrent download, streaming, WebDAV server and client.
  • goTorrent: torrenting server with a React web frontend
  • Go Peerflix: Start watching the movie while your torrent is still downloading!
  • hTorrent: HTTP to BitTorrent gateway with seeking support.
  • Remote-Torrent: Download Remotely and Retrieve Files Over HTTP
  • Trickl: torrent client for android
  • ANT-Downloader: ANT Downloader is a BitTorrent Client developed by golang, angular 7, and electron
  • Elementum (up to version 0.0.71)

Help

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

Command packages

Here I'll describe what some of the packages in ./cmd do. See installation to make them available.

torrent

torrent download

Downloads torrents from the command-line.

$ torrent download 'magnet:?xt=urn:btih:KRWPCX3SJUM4IMM4YF5RPHL6ANPYTQPU'
... lots of jibber jabber ...
downloading "ubuntu-14.04.2-desktop-amd64.iso": 1.0 GB/1.0 GB, 1989/1992 pieces completed (1 partial)
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

torrent metainfo magnet

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

$ torrent metainfo testdata/debian-10.8.0-amd64-netinst.iso.torrent magnet
magnet:?xt=urn:btih:4090c3c2a394a49974dfbbf2ce7ad0db3cdeddd7&dn=debian-10.8.0-amd64-netinst.iso&tr=http%3A%2F%2Fbttracker.debian.org%3A6969%2Fannounce

See torrent metainfo --help for other metainfo related commands.

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
$ 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  -