README.md

   1 # torrent
   2
   3 [![Join the chat at https://gitter.im/anacrolix/torrent](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/anacrolix/torrent?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
   4 [![GoDoc](https://godoc.org/github.com/anacrolix/torrent?status.svg)](https://godoc.org/github.com/anacrolix/torrent)
   5 [![CircleCI](https://circleci.com/gh/anacrolix/torrent.svg?style=shield)](https://circleci.com/gh/anacrolix/torrent)
   6
   7 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](https://godoc.org/github.com/anacrolix/torrent#Reader) exposing torrents and their files with the various Go idiomatic `io` package interfaces. This is also demonstrated through [torrentfs](#torrentfs).
   8
   9 There is [support for protocol encryption, DHT, PEX, uTP, and various extensions](https://godoc.org/github.com/anacrolix/torrent). There are [several data storage backends provided](https://godoc.org/github.com/anacrolix/torrent/storage): blob, file, bolt, and mmap, to name a few. You can [write your own](https://godoc.org/github.com/anacrolix/torrent/storage#ClientImpl) to store data for example on S3, or in a database.
  10
  11 Some noteworthy package dependencies that can be used for other purposes include:
  12
  13  * [go-libutp](https://github.com/anacrolix/go-libutp)
  14  * [dht](https://github.com/anacrolix/dht)
  15  * [bencode](https://godoc.org/github.com/anacrolix/torrent/bencode)
  16  * [tracker](https://godoc.org/github.com/anacrolix/torrent/tracker)
  17
  18 ## Installation
  19
  20 Install the library package with `go get github.com/anacrolix/torrent`, or the provided cmds with `go get github.com/anacrolix/torrent/cmd/...`.
  21
  22 ## Library examples
  23
  24 There are some small [examples](https://godoc.org/github.com/anacrolix/torrent#pkg-examples) in the package documentation.
  25
  26 ## Downstream projects
  27
  28 There are several web-frontends and Android clients among the known public projects:
  29
  30  * [Torrent.Express](https://torrent.express/)
  31  * [Confluence](https://github.com/anacrolix/confluence)
  32  * [Trickl](https://github.com/arranlomas/Trickl)
  33  * [Elementum](http://elementum.surge.sh/)
  34  * [goTorrent](https://github.com/deranjer/goTorrent)
  35  * [Go Peerflix](https://github.com/Sioro-Neoku/go-peerflix)
  36  * [Cloud Torrent](https://github.com/jpillora/cloud-torrent)
  37  * [Android Torrent Client](https://gitlab.com/axet/android-torrent-client)
  38  * [libtorrent](https://gitlab.com/axet/libtorrent)
  39  * [Remote-Torrent](https://github.com/BruceWangNo1/remote-torrent)
  40  * [ANT-Downloader](https://github.com/anatasluo/ant)
  41
  42 ## Help
  43
  44 Communication about the project is primarily through [Gitter](https://gitter.im/anacrolix/torrent) and the [issue tracker](https://github.com/anacrolix/torrent/issues).
  45
  46 ## Command packages
  47
  48 Here I'll describe what some of the packages in `./cmd` do.
  49
  50 Note that the [`godo`](https://github.com/anacrolix/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.
  51
  52 ### torrent
  53
  54 Downloads torrents from the command-line. This first example does not use `godo`.
  55
  56         $ go get github.com/anacrolix/torrent/cmd/torrent
  57     # Now 'torrent' should be in $GOPATH/bin, which should be in $PATH.
  58         $ torrent 'magnet:?xt=urn:btih:KRWPCX3SJUM4IMM4YF5RPHL6ANPYTQPU'
  59     ubuntu-14.04.2-desktop-amd64.iso [===================================================================>]  99% downloading (1.0 GB/1.0 GB)
  60     2015/04/01 02:08:20 main.go:137: downloaded ALL the torrents
  61     $ md5sum ubuntu-14.04.2-desktop-amd64.iso
  62     1b305d585b1918f297164add46784116  ubuntu-14.04.2-desktop-amd64.iso
  63     $ echo such amaze
  64     wow
  65
  66 ### torrentfs
  67
  68 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`.
  69
  70     $ mkdir mnt torrents
  71     $ godo github.com/anacrolix/torrent/cmd/torrentfs -mountDir=mnt -metainfoDir=torrents &
  72     $ cd torrents
  73     $ wget http://releases.ubuntu.com/14.04.2/ubuntu-14.04.2-desktop-amd64.iso.torrent
  74     $ cd ..
  75     $ ls mnt
  76     ubuntu-14.04.2-desktop-amd64.iso
  77     $ pv mnt/ubuntu-14.04.2-desktop-amd64.iso | md5sum
  78     996MB 0:04:40 [3.55MB/s] [========================================>] 100%
  79     1b305d585b1918f297164add46784116  -
  80
  81 ### torrent-magnet
  82
  83 Creates a magnet link from a torrent file. Note the extracted trackers, display name, and info hash.
  84
  85     $ godo github.com/anacrolix/torrent/cmd/torrent-magnet < ubuntu-14.04.2-desktop-amd64.iso.torrent
  86         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