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 [![Build Status](https://drone.io/github.com/anacrolix/torrent/status.png)](https://drone.io/github.com/anacrolix/torrent/latest)
   5 [![GoDoc](https://godoc.org/github.com/anacrolix/torrent?status.svg)](https://godoc.org/github.com/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 a downstream, private service since late 2014.
   8
   9 There is support for protocol encryption, DHT, PEX, 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 `torrent` as a library for your own applications.
  10
  11 Many of the sub-packages can be used for other purposes: dht, bencode, and 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 ## Commands
  22
  23 Here I'll describe what some of the provided commands in `./cmd` do.
  24
  25 Note that [`godo`](https://github.com/anacrolix/godo) that I invoke in the following examples is a command that 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.
  26
  27 ### torrent
  28
  29 Downloads torrents from the command-line.
  30
  31         $ go get github.com/anacrolix/torrent/cmd/torrent
  32         $ torrent 'magnet:?xt=urn:btih:KRWPCX3SJUM4IMM4YF5RPHL6ANPYTQPU'
  33     2015/04/01 02:08:20 main.go:137: downloaded ALL the torrents
  34     $ md5sum ubuntu-14.04.2-desktop-amd64.iso
  35     1b305d585b1918f297164add46784116  ubuntu-14.04.2-desktop-amd64.iso
  36     $ echo such amaze
  37     wow
  38
  39 ### torrentfs
  40
  41 torrentfs mounts a FUSE filesystem at `-mountDir`. The contents are the torrents described by the torrent files and magnet links at `-torrentPath`. Data for read requests is fetched only as required from the torrent network, and stored at `-downloadDir`.
  42
  43     $ mkdir mnt torrents
  44     $ godo github.com/anacrolix/torrent/cmd/torrentfs -mountDir mnt -torrentPath torrents &
  45     $ cd torrents
  46     $ wget http://releases.ubuntu.com/14.04.2/ubuntu-14.04.2-desktop-amd64.iso.torrent
  47     $ cd ..
  48     $ ls mnt
  49     ubuntu-14.04.2-desktop-amd64.iso
  50     $ pv mnt/ubuntu-14.04.2-desktop-amd64.iso | md5sum
  51     996MB 0:04:40 [3.55MB/s] [========================================>] 100%
  52     1b305d585b1918f297164add46784116  -
  53
  54 ### torrent-magnet
  55
  56 Creates a magnet link from a torrent file. Note the extracted trackers, display name, and info hash.
  57
  58     $ godo github.com/anacrolix/torrent/cmd/torrent-magnet < ubuntu-14.04.2-desktop-amd64.iso.torrent
  59         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
  60
  61 ### dht-ping
  62
  63 Pings DHT nodes with the given network addresses.
  64
  65     $ godo ./cmd/dht-ping router.bittorrent.com:6881 router.utorrent.com:6881
  66     2015/04/01 17:21:23 main.go:33: dht server on [::]:60058
  67     32f54e697351ff4aec29cdbaabf2fbe3467cc267 (router.bittorrent.com:6881): 648.218621ms
  68     ebff36697351ff4aec29cdbaabf2fbe3467cc267 (router.utorrent.com:6881): 873.864706ms
  69     2/2 responses (100.000000%)
  70