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