0f53cbf07e
|
||
|---|---|---|
| .circleci | ||
| .github/workflows | ||
| analysis | ||
| bencode | ||
| cmd | ||
| common | ||
| fs | ||
| internal | ||
| iplist | ||
| logonce | ||
| metainfo | ||
| mmap_span | ||
| mse | ||
| peer_protocol | ||
| request-strategy | ||
| segments | ||
| storage | ||
| test | ||
| testdata | ||
| tracker | ||
| types | ||
| util/dirwatch | ||
| version | ||
| webseed | ||
| webtorrent | ||
| .deepsource.toml | ||
| .gitignore | ||
| .golangci.yml | ||
| LICENSE | ||
| NOTES.md | ||
| README.md | ||
| SECURITY.md | ||
| TODO | ||
| bad_storage.go | ||
| bep40.go | ||
| bep40_test.go | ||
| callbacks.go | ||
| client-nowasm_test.go | ||
| client.go | ||
| client_test.go | ||
| config.go | ||
| conn_stats.go | ||
| deferrwl.go | ||
| dht.go | ||
| dialer.go | ||
| doc.go | ||
| example_test.go | ||
| file.go | ||
| file_test.go | ||
| global.go | ||
| go.mod | ||
| go.sum | ||
| handshake.go | ||
| handshake_test.go | ||
| ipport.go | ||
| issue97_test.go | ||
| issue211_test.go | ||
| listen.go | ||
| main_test.go | ||
| misc.go | ||
| misc_test.go | ||
| multiless.go | ||
| network_test.go | ||
| networks.go | ||
| peer-conn-msg-writer.go | ||
| peer-impl.go | ||
| peer_info.go | ||
| peer_infos.go | ||
| peerconn.go | ||
| peerconn_test.go | ||
| peerid.go | ||
| peerid_test.go | ||
| pex.go | ||
| pex_test.go | ||
| pexconn.go | ||
| pexconn_test.go | ||
| piece.go | ||
| piecestate.go | ||
| portfwd.go | ||
| prioritized_peers.go | ||
| prioritized_peers_test.go | ||
| protocol.go | ||
| ratelimitreader.go | ||
| reader.go | ||
| reader_test.go | ||
| requesting.go | ||
| requesting_test.go | ||
| rlreader_test.go | ||
| roaring.go | ||
| socket.go | ||
| spec.go | ||
| struct_test.go | ||
| t.go | ||
| testing.go | ||
| torrent.go | ||
| torrent_mmap_test.go | ||
| torrent_pending_pieces.go | ||
| torrent_stats.go | ||
| torrent_test.go | ||
| tracker_scraper.go | ||
| url-net-addr.go | ||
| utp.go | ||
| utp_go.go | ||
| utp_libutp.go | ||
| utp_test.go | ||
| webrtc.go | ||
| webseed-peer.go | ||
| worst_conns.go | ||
| wstracker.go | ||
README.md
torrent
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
- @anacrolix is interviewed about this repo in Console 32.
Downstream projects
There are several web-frontends and Android clients among the known public projects:
- Torrent.Express
- Confluence
- Trickl
- Elementum (up to version 0.0.71)
- goTorrent
- Go Peerflix
- Simple Torrent (fork of Cloud Torrent, unmaintained)
- Android Torrent Client
- libtorrent
- Remote-Torrent
- ANT-Downloader
- Go-PeersToHTTP
- CortexFoundation/torrentfs: P2P file system of cortex full node
- TorrServ: Torrent streaming server over http.
- Webtor: free cloud BitTorrent-client
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 jibba 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 -