README.md

   1 # torrent
   2
   3 [![CircleCI](https://circleci.com/gh/anacrolix/torrent.svg?style=shield)](https://circleci.com/gh/anacrolix/torrent)
   4 [![GoDoc](https://godoc.org/github.com/anacrolix/torrent?status.svg)](https://godoc.org/github.com/anacrolix/torrent)
   5 [![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)
   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 a downstream, private service since late 2014.
   8
   9 There is support for protocol encryption, [DHT](https://github.com/anacrolix/dht), PEX, [uTP](https://github.com/anacrolix/utp), and various extensions. See the package documentation for a more complete list. There are several data storage backends provided: blob, file, and mmap, and you can write your own, such as to store data on S3, or in a database. You can use the provided binaries in `./cmd`, or use package `torrent` as a library for your own applications.
  10
  11 Many of the sub-packages can be used for other purposes: [bencode](https://godoc.org/github.com/anacrolix/torrent/bencode), and [tracker](https://godoc.org/github.com/anacrolix/torrent/tracker), in particular.
  12
  13 ## Installation
  14
  15 Install the library package with `go get github.com/anacrolix/torrent`, or the provided cmds with `go get github.com/anacrolix/torrent/cmd/...`.
  16
  17 ## Library example
  18
  19 There is a small example in the [package documentation](https://godoc.org/github.com/anacrolix/torrent).
  20
  21 ## Other public projects using torrent
  22
  23  * [Go Peerflix](https://github.com/Sioro-Neoku/go-peerflix)
  24  * [Cloud Torrent](https://github.com/jpillora/cloud-torrent)
  25  * [Android Torrent Client](https://gitlab.com/axet/android-torrent-client)
  26  * [Android libtorrent](https://gitlab.com/axet/libtorrent)
  27  * [Trickl - Torrent Client](https://play.google.com/store/apps/details?id=com.shwifty.tex)
  28  * [Confluence](https://github.com/anacrolix/confluence)
  29
  30 ## Commands
  31
  32 Here I'll describe what some of the provided commands in `./cmd` do.
  33
  34 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.
  35
  36 ### torrent
  37
  38 Downloads torrents from the command-line. This first example does not use `godo`.
  39
  40         $ go get github.com/anacrolix/torrent/cmd/torrent
  41     # Now 'torrent' should be in $GOPATH/bin, which should be in $PATH.
  42         $ torrent 'magnet:?xt=urn:btih:KRWPCX3SJUM4IMM4YF5RPHL6ANPYTQPU'
  43     ubuntu-14.04.2-desktop-amd64.iso [===================================================================>]  99% downloading (1.0 GB/1.0 GB)
  44     2015/04/01 02:08:20 main.go:137: downloaded ALL the torrents
  45     $ md5sum ubuntu-14.04.2-desktop-amd64.iso
  46     1b305d585b1918f297164add46784116  ubuntu-14.04.2-desktop-amd64.iso
  47     $ echo such amaze
  48     wow
  49
  50 ### torrentfs
  51
  52 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`.
  53
  54     $ mkdir mnt torrents
  55     $ godo github.com/anacrolix/torrent/cmd/torrentfs -mountDir=mnt -metainfoDir=torrents &
  56     $ cd torrents
  57     $ wget http://releases.ubuntu.com/14.04.2/ubuntu-14.04.2-desktop-amd64.iso.torrent
  58     $ cd ..
  59     $ ls mnt
  60     ubuntu-14.04.2-desktop-amd64.iso
  61     $ pv mnt/ubuntu-14.04.2-desktop-amd64.iso | md5sum
  62     996MB 0:04:40 [3.55MB/s] [========================================>] 100%
  63     1b305d585b1918f297164add46784116  -
  64
  65 ### torrent-magnet
  66
  67 Creates a magnet link from a torrent file. Note the extracted trackers, display name, and info hash.
  68
  69     $ godo github.com/anacrolix/torrent/cmd/torrent-magnet < ubuntu-14.04.2-desktop-amd64.iso.torrent
  70         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