path: root/README.md

# ![WebTorrent](img/wordmark.png)

### Streaming torrent client for node & the browser

[![Build Status][webtorrent-ti]][webtorrent-tu]
[![NPM Version][webtorrent-ni]][webtorrent-nu]
[![NPM Downloads][webtorrent-downloads-image]][webtorrent-downloads-url]
[![Gratipay][webtorrent-gratipay-image]][webtorrent-gratipay-url]

[![Sauce Test Status][webtorrent-sauce-image]][webtorrent-sauce-url]

**WebTorrent** is a streaming torrent client for **node.js** and the **browser**. YEP,
THAT'S RIGHT. THE BROWSER. It's written completely in JavaScript – the language of the web
– so the same code works in both runtimes.

In the browser, WebTorrent uses **WebRTC** (data channels) for peer-to-peer transport.
It can be used **without** browser plugins, extensions, or installations. It's Just
JavaScript™.

Simply include the `webtorrent.min.js` script on your page to start fetching files over
WebRTC using the BitTorrent protocol, or `require('webtorrent')` with
[browserify](http://browserify.org/). See [demo apps](#webtorrent-in-production) and
[code examples](#usage) below.

To make BitTorrent work over WebRTC (which is the only p2p transport that works on the
web) we made some protocol changes. Therefore, a browser-based WebTorrent client can only
connect to other clients that support WebTorrent (and WebRTC).

We hope established torrent clients (uTorrent, Transmission, Vuze, etc.) will add support
for WebTorrent (and WebRTC) so they can swarm with both normal *and* web peers.

In node, this module acts like a normal torrent client, using TCP and UDP to talk to
regular torrent clients. Soon, it will gain the ability to swarm with web peers, making
it the first "hybrid" client.

![Network](img/network.png)

> Warning: This is pre-alpha software. **Watch/star to follow along with progress.**

### Features

- **Torrent client for node.js & the browser** (same npm module!)
- **Insanely fast**
- Download **multiple torrents** simultaneously, efficiently
- **Pure Javascript** (no native dependencies)
- Exposes files as **streams**
  - Fetches pieces from the network on-demand so seeking is supported (even before torrent is finished)
  - Seamlessly switches between sequential and rarest-first piece selection strategy
- Supports advanced torrent client features
  - **magnet uri** support via **[ut_metadata](https://github.com/feross/ut_metadata)**
  - **peer discovery** via **[dht](https://github.com/feross/bittorrent-dht)**,
    **[tracker](https://github.com/feross/bittorrent-tracker)**, and
    **[ut_pex](https://github.com/fisch0920/ut_pex)**
  - **[protocol extension api](https://github.com/feross/bittorrent-protocol#extension-api)**
    for adding new extensions
- **Comprehensive test suite** (runs completely offline, so it's reliable and fast)

#### Browser-only features

- **WebRTC data channels** for lightweight peer-to-peer communication with **no plugins**
- **No silos.** WebTorrent is a P2P network for the **entire web.** WebTorrent clients
  running on one domain can connect to clients on any other domain.
- Stream video torrents into a `<video>` tag (`webm (vp8, vp9)` or `mp4 (h.264)`)

#### Node-only features

- Stream to **AirPlay**, **Chromecast**, **VLC player**, and many other devices/players

### Ways to help

- **Join us in IRC** on freenode at `#webtorrent` if you want to help with development, or
  you just want to hang out with some cool mad science hackers :)
- **[Create a new issue](https://github.com/feross/webtorrent/issues/new)** to report bugs
- **[Fix an issue](https://github.com/feross/webtorrent/issues?state=open)**. Note:
  WebTorrent is an [OPEN Open Source Project](CONTRIBUTING.md)!
- **Donate bitcoin** if you believe in the vision and wish to support the project.
  Use **[Coinbase](https://www.coinbase.com/feross)**, or send to *1B6aystcqu8fd6ejzpmMFMPRqH9b86iiwh*. ([proof](https://keybase.io/feross))

### WebTorrent in production

- **[Instant](http://instant.io)** – Secure, anonymous, streaming file transfer [[code](https://github.com/feross/instant.io)]
- Your app here! (send a PR or open an issue with your app's URL)

### Install

With [npm](https://npmjs.org/), run:

```bash
npm install webtorrent
```

### Usage

WebTorrent is the first BitTorrent client that works in the browser, using open web
standards (no plugins, just HTML5 and WebRTC)! It's easy to get started!

#### In the browser

##### Downloading a file is simple:

```js
var WebTorrent = require('webtorrent')
var concat = require('concat-stream')

var client = new WebTorrent()

client.download(magnet_uri, function (torrent) {
  // Got torrent metadata!
  console.log('Torrent info hash:', torrent.infoHash)

  torrent.files.forEach(function (file) {
    // Get the file data as a Buffer (Uint8Array typed array)
    file.createReadStream().pipe(concat(function (buf) {

      // Append a link to download the file
      var a = document.createElement('a')
      a.download = file.name
      a.href = URL.createObjectURL(new Blob([ buf ]))
      a.textContent = 'download ' + file.name
      document.body.appendChild(a)
    }))
  })
})
```

##### Seeding a file is simple, too:

```js
var dragDrop = require('drag-drop/buffer')
var WebTorrent = require('webtorrent')

var client = new WebTorrent()

// When user drops files on the browser, create a new torrent and start seeding it!
dragDrop('body', function (files) {
  client.seed(files, function onTorrent (torrent) {
    // Client is seeding the file!
    console.log('Torrent info hash:', torrent.infoHash)
  })
})
```

##### Streaming to an HTML5 video element?  Also simple!

```js
var WebTorrent = require('webtorrent')

var client = new WebTorrent()

client.download(magnet_uri, function (torrent) {
  // Got torrent metadata!
  console.log('Torrent info hash:', torrent.infoHash)

  // Let's say the first file is a webm (vp8) or mp4 (h264) video...
  var file = torrent.files[0]

  // Create a video element
  var video = document.createElement('video')
  video.controls = true
  document.body.appendChild(video)

  // Stream the video into the video tag
  file.createReadStream().pipe(video)
})
```

##### Browserify

WebTorrent works great with [browserify](http://browserify.org/), an npm module that let's
you use [node](http://nodejs.org/)-style require() to organize your browser code and load modules installed by [npm](https://npmjs.org/) (as seen in the previous examples).

WebTorrent is also available as a standalone script
([`webtorrent.min.js`](webtorrent.min.js)) which exposes `WebTorrent` on the `window`
object, so it can be used with just a script tag:

```html
<script src="webtorrent.min.js"></script>
```

#### In node.js

WebTorrent also works in node.js, using the *same npm module!* It's mad science!

#### As a command line app

WebTorrent is available as a command line app. Here's how to use it:

```bash
$ npm install -g webtorrent
$ webtorrent --help
```

To download a torrent:

```bash
$ webtorrent magnet_uri
```

To stream a torrent to a device like **AirPlay** or **Chromecast**, just pass a flag:

```bash
$ webtorrent magnet_uri --airplay
```

There are many supported streaming options:

```bash
--airplay               Apple TV
--chromecast            Chromecast
--mplayer               MPlayer
--mpv                   MPV
--omx [jack]            omx [default: hdmi]
--vlc                   VLC
--xbmc                  XBMC
--stdout                standard out [implies --quiet]
```

In addition to magnet uris, webtorrent supports [many ways to specify a torrent](#clientaddtorrentid-opts-function-ontorrent-torrent-).

### API

This API should work exactly the same in node and the browser. Open an issue if this is
not the case.

#### `client = new WebTorrent([opts])`

Create a new `WebTorrent` instance.

If `opts` is specified, then the default options (shown below) will be overridden.

``` js
{
  dht: Boolean,          // Whether or not to enable DHT (default=true)
  maxPeers: Number,      // Max number of peers to connect to per torrent (default=100)
  nodeId: String|Buffer, // DHT protocol node ID (default=randomly generated)
  peerId: String|Buffer, // Wire protocol peer ID (default=randomly generated)
  storage: Function      // custom storage engine, or `false` to use in-memory engine
  tracker: Boolean,      // Whether or not to enable trackers (default=true)
  verify: Boolean        // Verify previously stored data before starting (default=false)
}
```

#### `client.add(torrentId, [opts], [function ontorrent (torrent) {}])`

Start downloading a new torrent. Aliased as `client.download`.

`torrentId` can be one of:

- magnet uri (utf8 string)
- torrent file (buffer)
- info hash (hex string or buffer)
- parsed torrent (from [parse-torrent](https://github.com/feross/parse-torrent))
- http/https url to a torrent file (string)
- filesystem path to a torrent file (string)

If `ontorrent` is specified, then it will be called when **this** torrent is ready to be
used (i.e. metadata is available). Note: this is distinct from the 'torrent' event which
will fire for **all** torrents.

If you want access to the torrent object immediately in order to listen to events as the
metadata is fetched from the network, then use the return value of `client.add`. If you
just want the file data, then use `ontorrent` or the 'torrent' event.

#### `client.seed(input, [opts], [function onseed (torrent) {}])`

Start seeding a new torrent.

`input` can be any of the following:

- path to the file or folder on filesystem (string)
- W3C [File](https://developer.mozilla.org/en-US/docs/Web/API/File) object (from an `<input>` or drag and drop)
- W3C [FileList](https://developer.mozilla.org/en-US/docs/Web/API/FileList) object (basically an array of `File` objects)
- Node [Buffer](http://nodejs.org/api/buffer.html) object (works in [the browser](https://www.npmjs.org/package/buffer))

Or, an **array of `File` or `Buffer` objects**.

If `opts` is specified, it should contain the following types of options:

- options for [create-torrent](https://github.com/feross/create-torrent#createtorrentinput-opts-function-callback-err-torrent-) (to allow configuration of the .torrent file that is created)
- options for `client.add` (see above)

If `onseed` is specified, it will be called when the client has begun seeding the file.

#### `client.on('torrent', function (torrent) {})`

Emitted when a torrent is ready to be used (i.e. metadata is available and storage is
ready). See the torrent section for more info on what methods a `torrent` has.

#### `client.remove(torrentId, [function callback (err) {}])`

Remove a torrent from the client. Destroy all connections to peers and delete all saved
file data. If `callback` is specified, it will be called when file data is removed.

#### `client.destroy()`

Destroy the client, including all torrents and connections to peers.

#### `client.torrents[...]`

An array of all torrents in the client.

#### `client.get(torrentId)`

Returns the torrent with the given `torrentId`. Convenience method. Easier than
searching through the `client.torrents` array.

#### `client.ratio`

Seed ratio for all torrents in the client.


### torrent api

#### `torrent.infoHash`

Get the info hash of the torrent.

#### `torrent.magnetURI`

Get the magnet URI of the torrent.

#### `torrent.files[...]`

An array of all files in the torrent. See the file section for more info on what methods
the file has.

#### `torrent.swarm`

The attached [bittorrent-swarm](https://github.com/feross/bittorrent-swarm) instance.

#### `torrent.remove()`

Alias for `client.remove(torrent)`.

#### `torrent.addPeer(addr)`

Adds a peer to the underlying [bittorrent-swarm](https://github.com/feross/bittorrent-swarm) instance.

#### `torrent.select(start, end, [priority], [notify])`

Selects a range of pieces to prioritize starting with `start` and ending with `end` (both inclusive)
at the given `priority`. `notify` is an optional callback to be called when the selection is updated
with new data.

#### `torrent.deselect(start, end, priority)`

Deprioritizes a range of previously selected pieces.

#### `torrent.critical(start, end)`

Marks a range of pieces as critical priority to be downloaded ASAP. From `start` to `end`
(both inclusive).

#### `torrent.createServer([opts])`

Create an http server to serve the contents of this torrent, dynamically fetching the
needed torrent pieces to satisfy http requests. Range requests are supported.

Returns an `http.Server` instance (got from calling `http.createServer`). If `opts` is specified, it is passed to the `http.createServer` function.

Visiting the root of the server `/` will show a list of links to individual files. Access
individual files at `/<index>` where `<index>` is the index in the `torrent.files` array
(e.g. `/0`, `/1`, etc.)

Here is a usage example:

```js
var client = new WebTorrent()
client.add(magnet_uri, function (torrent) {
  // create HTTP server for this torrent
  var server = torrent.createServer()
  server.listen(port) // start the server listening to a port

  // visit http://localhost:<port>/ to see a list of files

  // access individual files at http://localhost:<port>/<index> where index is the index
  // in the torrent.files array

  // later, cleanup...
  server.close()
  client.destroy()
})
```

### file api

#### `file.name`

File name, as specified by the torrent. *Example: 'some-filename.txt'*

#### `file.path`

File path, as specified by the torrent. *Example: 'some-folder/some-filename.txt'*

#### `file.length`

File length (in bytes), as specified by the torrent. *Example: 12345*

#### `file.select()`

Selects the file to be downloaded, but at a lower priority than files with streams.
Useful if you know you need the file at a later stage.

#### `file.deselect()`

Deselects the file, which means it won't be downloaded unless someone creates a stream
for it.

#### `stream = file.createReadStream([opts])`

Create a [readable stream](http://nodejs.org/api/stream.html#stream_class_stream_readable)
to the file. Pieces needed by the stream will be prioritized highly and fetched from the
swarm first.

You can pass `opts` to stream only a slice of a file.

``` js
{
  start: startByte,
  end: endByte
}
```

Both `start` and `end` are inclusive.

#### `file.getBlobURL(function callback (err, url) {})`

Get a url which can be used in the browser to refer to the file.

The file will be fetched from the network with highest priority, and `callback` will be
called when it is ready. `callback` must be specified and may be called with a an `Error`
or the blob url (`String`) when the file data is available and ready to be used.

```js
file.getBlobURL(function (err, url) {
  if (err) throw err
  var a = document.createElement('a')
  a.download = file.name
  a.href = url
  a.textContent = 'Download ' + file.name
  body.appendChild(a)
})
```

### Modules

Most of the active development is happening inside of small npm modules which are used by WebTorrent.

#### The Node Way&trade;

> "When applications are done well, they are just the really application-specific, brackish residue that can't be so easily abstracted away. All the nice, reusable components sublimate away onto github and npm where everybody can collaborate to advance the commons." — substack from ["how I write modules"](http://substack.net/how_I_write_modules)

![node.js is shiny](http://feross.net/x/node2.gif)

#### Modules

These are the modules I am writing to make WebTorrent work:

| module | tests | version | description |
|---|---|---|---|
| **[webtorrent][webtorrent]** | [![][webtorrent-ti]][webtorrent-tu] | [![][webtorrent-ni]][webtorrent-nu] | **torrent client (this module)**
| [addr-to-ip-port][addr-to-ip-port] | [![][addr-to-ip-port-ti]][addr-to-ip-port-tu] | [![][addr-to-ip-port-ni]][addr-to-ip-port-nu] | cache for addr->ip:port
| [bittorrent-dht][bittorrent-dht] | [![][bittorrent-dht-ti]][bittorrent-dht-tu] | [![][bittorrent-dht-ni]][bittorrent-dht-nu] | distributed hash table client
| [bittorrent-peerid][bittorrent-peerid] | [![][bittorrent-peerid-ti]][bittorrent-peerid-tu] | [![][bittorrent-peerid-ni]][bittorrent-peerid-nu] | identify client name/version
| [bittorrent-protocol][bittorrent-protocol] | [![][bittorrent-protocol-ti]][bittorrent-protocol-tu] | [![][bittorrent-protocol-ni]][bittorrent-protocol-nu] | bittorrent protocol stream
| [bittorrent-swarm][bittorrent-swarm] | [![][bittorrent-swarm-ti]][bittorrent-swarm-tu] | [![][bittorrent-swarm-ni]][bittorrent-swarm-nu] | bittorrent connection manager
| [bittorrent-tracker][bittorrent-tracker] | [![][bittorrent-tracker-ti]][bittorrent-tracker-tu] | [![][bittorrent-tracker-ni]][bittorrent-tracker-nu] | bittorrent tracker server/client
| [buffer][buffer] | [![][buffer-ti]][buffer-tu] | [![][buffer-ni]][buffer-nu] | node buffer api for the browser
| [create-torrent][create-torrent] | [![][create-torrent-ti]][create-torrent-tu] | [![][create-torrent-ni]][create-torrent-nu] | create .torrent files
| [ip-set][ip-set] | [![][ip-set-ti]][ip-set-tu] | [![][ip-set-ni]][ip-set-nu] | efficient mutable ip set
| [load-ip-set][load-ip-set] | [![][load-ip-set-ti]][load-ip-set-tu] | [![][load-ip-set-ni]][load-ip-set-nu] | load ip sets from local/network
| [magnet-uri][magnet-uri] | [![][magnet-uri-ti]][magnet-uri-tu] | [![][magnet-uri-ni]][magnet-uri-nu] | parse magnet uris
| [parse-torrent][parse-torrent] | [![][parse-torrent-ti]][parse-torrent-tu] | [![][parse-torrent-ni]][parse-torrent-nu] | parse torrent identifiers
| [parse-torrent-file][parse-torrent-file] | [![][parse-torrent-file-ti]][parse-torrent-file-tu] | [![][parse-torrent-file-ni]][parse-torrent-file-nu] | parse .torrent files
| [simple-peer][simple-peer] | [![][simple-peer-ti]][simple-peer-tu] | [![][simple-peer-ni]][simple-peer-nu] | simpler webrtc api
| [simple-websocket][simple-websocket] | [![][simple-websocket-ti]][simple-websocket-tu] | [![][simple-websocket-ni]][simple-websocket-nu] | simpler websocket api
| [string2compact][string2compact] | [![][string2compact-ti]][string2compact-tu] | [![][string2compact-ni]][string2compact-nu] | convert 'hostname:port' to compact
| [torrent-discovery][torrent-discovery] | [![][torrent-discovery-ti]][torrent-discovery-tu] | [![][torrent-discovery-ni]][torrent-discovery-nu] | find peers via dht and tracker
| [typedarray-to-buffer][typedarray-to-buffer] | [![][typedarray-to-buffer-ti]][typedarray-to-buffer-tu] | [![][typedarray-to-buffer-ni]][typedarray-to-buffer-nu] | efficient buffer creation
| [ut_metadata][ut_metadata] | [![][ut_metadata-ti]][ut_metadata-tu] | [![][ut_metadata-ni]][ut_metadata-nu] | metadata for magnet uris **(ext)**
| [ut_pex][ut_pex] | [![][ut_pex-ti]][ut_pex-tu] | [![][ut_pex-ni]][ut_pex-nu] | peer discovery **(ext)**
| [webtorrent-swarm][webtorrent-swarm] | [![][webtorrent-swarm-ti]][webtorrent-swarm-tu] | [![][webtorrent-swarm-ni]][webtorrent-swarm-nu] | webtorrent connection management
| [webtorrent-tracker][webtorrent-tracker] | [![][webtorrent-tracker-ti]][webtorrent-tracker-tu] | [![][webtorrent-tracker-ni]][webtorrent-tracker-nu] | webtorrent tracker server/client

[webtorrent]: https://github.com/feross/webtorrent
[webtorrent-ti]: https://img.shields.io/travis/feross/webtorrent.svg?style=flat
[webtorrent-tu]: https://travis-ci.org/feross/webtorrent
[webtorrent-ni]: https://img.shields.io/npm/v/webtorrent.svg?style=flat
[webtorrent-nu]: https://npmjs.org/package/webtorrent
[webtorrent-downloads-image]: https://img.shields.io/npm/dm/webtorrent.svg?style=flat
[webtorrent-downloads-url]: https://npmjs.org/package/webtorrent
[webtorrent-gratipay-image]: https://img.shields.io/gratipay/feross.svg?style=flat
[webtorrent-gratipay-url]: https://gratipay.com/feross/
[webtorrent-sauce-image]: https://saucelabs.com/browser-matrix/webtorrent.svg
[webtorrent-sauce-url]: https://saucelabs.com/u/webtorrent

[addr-to-ip-port]: https://github.com/feross/addr-to-ip-port
[addr-to-ip-port-ti]: https://img.shields.io/travis/feross/addr-to-ip-port.svg?style=flat
[addr-to-ip-port-tu]: https://travis-ci.org/feross/addr-to-ip-port
[addr-to-ip-port-ni]: https://img.shields.io/npm/v/addr-to-ip-port.svg?style=flat
[addr-to-ip-port-nu]: https://npmjs.org/package/addr-to-ip-port

[bittorrent-dht]: https://github.com/feross/bittorrent-dht
[bittorrent-dht-ti]: https://img.shields.io/travis/feross/bittorrent-dht.svg?style=flat
[bittorrent-dht-tu]: https://travis-ci.org/feross/bittorrent-dht
[bittorrent-dht-ni]: https://img.shields.io/npm/v/bittorrent-dht.svg?style=flat
[bittorrent-dht-nu]: https://npmjs.org/package/bittorrent-dht

[bittorrent-peerid]: https://github.com/fisch0920/bittorrent-peerid
[bittorrent-peerid-ti]: https://img.shields.io/travis/fisch0920/bittorrent-peerid.svg?style=flat
[bittorrent-peerid-tu]: https://travis-ci.org/fisch0920/bittorrent-peerid
[bittorrent-peerid-ni]: https://img.shields.io/npm/v/bittorrent-peerid.svg?style=flat
[bittorrent-peerid-nu]: https://npmjs.org/package/bittorrent-peerid

[bittorrent-protocol]: https://github.com/feross/bittorrent-protocol
[bittorrent-protocol-ti]: https://img.shields.io/travis/feross/bittorrent-protocol.svg?style=flat
[bittorrent-protocol-tu]: https://travis-ci.org/feross/bittorrent-protocol
[bittorrent-protocol-ni]: https://img.shields.io/npm/v/bittorrent-protocol.svg?style=flat
[bittorrent-protocol-nu]: https://npmjs.org/package/bittorrent-protocol

[bittorrent-swarm]: https://github.com/feross/bittorrent-swarm
[bittorrent-swarm-ti]: https://img.shields.io/travis/feross/bittorrent-swarm.svg?style=flat
[bittorrent-swarm-tu]: https://travis-ci.org/feross/bittorrent-swarm
[bittorrent-swarm-ni]: https://img.shields.io/npm/v/bittorrent-swarm.svg?style=flat
[bittorrent-swarm-nu]: https://npmjs.org/package/bittorrent-swarm

[bittorrent-tracker]: https://github.com/feross/bittorrent-tracker
[bittorrent-tracker-ti]: https://img.shields.io/travis/feross/bittorrent-tracker.svg?style=flat
[bittorrent-tracker-tu]: https://travis-ci.org/feross/bittorrent-tracker
[bittorrent-tracker-ni]: https://img.shields.io/npm/v/bittorrent-tracker.svg?style=flat
[bittorrent-tracker-nu]: https://npmjs.org/package/bittorrent-tracker

[buffer]: https://github.com/feross/buffer
[buffer-ti]: https://img.shields.io/travis/feross/buffer.svg?style=flat
[buffer-tu]: https://travis-ci.org/feross/buffer
[buffer-ni]: https://img.shields.io/npm/v/buffer.svg?style=flat
[buffer-nu]: https://npmjs.org/package/buffer

[create-torrent]: https://github.com/feross/create-torrent
[create-torrent-ti]: https://img.shields.io/travis/feross/create-torrent.svg?style=flat
[create-torrent-tu]: https://travis-ci.org/feross/create-torrent
[create-torrent-ni]: https://img.shields.io/npm/v/create-torrent.svg?style=flat
[create-torrent-nu]: https://npmjs.org/package/create-torrent

[ip-set]: https://github.com/fisch0920/ip-set
[ip-set-ti]: https://img.shields.io/travis/fisch0920/ip-set.svg?style=flat
[ip-set-tu]: https://travis-ci.org/fisch0920/ip-set
[ip-set-ni]: https://img.shields.io/npm/v/ip-set.svg?style=flat
[ip-set-nu]: https://npmjs.org/package/ip-set

[load-ip-set]: https://github.com/feross/load-ip-set
[load-ip-set-ti]: https://img.shields.io/travis/feross/load-ip-set.svg?style=flat
[load-ip-set-tu]: https://travis-ci.org/feross/load-ip-set
[load-ip-set-ni]: https://img.shields.io/npm/v/load-ip-set.svg?style=flat
[load-ip-set-nu]: https://npmjs.org/package/load-ip-set

[magnet-uri]: https://github.com/feross/magnet-uri
[magnet-uri-ti]: https://img.shields.io/travis/feross/magnet-uri.svg?style=flat
[magnet-uri-tu]: https://travis-ci.org/feross/magnet-uri
[magnet-uri-ni]: https://img.shields.io/npm/v/magnet-uri.svg?style=flat
[magnet-uri-nu]: https://npmjs.org/package/magnet-uri

[parse-torrent]: https://github.com/feross/parse-torrent
[parse-torrent-ti]: https://img.shields.io/travis/feross/parse-torrent.svg?style=flat
[parse-torrent-tu]: https://travis-ci.org/feross/parse-torrent
[parse-torrent-ni]: https://img.shields.io/npm/v/parse-torrent.svg?style=flat
[parse-torrent-nu]: https://npmjs.org/package/parse-torrent

[parse-torrent-file]: https://github.com/feross/parse-torrent-file
[parse-torrent-file-ti]: https://img.shields.io/travis/feross/parse-torrent-file.svg?style=flat
[parse-torrent-file-tu]: https://travis-ci.org/feross/parse-torrent-file
[parse-torrent-file-ni]: https://img.shields.io/npm/v/parse-torrent-file.svg?style=flat
[parse-torrent-file-nu]: https://npmjs.org/package/parse-torrent-file

[simple-peer]: https://github.com/feross/simple-peer
[simple-peer-ti]: https://img.shields.io/travis/feross/simple-peer.svg?style=flat
[simple-peer-tu]: https://travis-ci.org/feross/simple-peer
[simple-peer-ni]: https://img.shields.io/npm/v/simple-peer.svg?style=flat
[simple-peer-nu]: https://npmjs.org/package/simple-peer

[simple-websocket]: https://github.com/feross/simple-websocket
[simple-websocket-ti]: https://img.shields.io/travis/feross/simple-websocket.svg?style=flat
[simple-websocket-tu]: https://travis-ci.org/feross/simple-websocket
[simple-websocket-ni]: https://img.shields.io/npm/v/simple-websocket.svg?style=flat
[simple-websocket-nu]: https://npmjs.org/package/simple-websocket

[string2compact]: https://github.com/feross/string2compact
[string2compact-ti]: https://img.shields.io/travis/feross/string2compact.svg?style=flat
[string2compact-tu]: https://travis-ci.org/feross/string2compact
[string2compact-ni]: https://img.shields.io/npm/v/string2compact.svg?style=flat
[string2compact-nu]: https://npmjs.org/package/string2compact

[torrent-discovery]: https://github.com/feross/torrent-discovery
[torrent-discovery-ti]: https://img.shields.io/travis/feross/torrent-discovery.svg?style=flat
[torrent-discovery-tu]: https://travis-ci.org/feross/torrent-discovery
[torrent-discovery-ni]: https://img.shields.io/npm/v/torrent-discovery.svg?style=flat
[torrent-discovery-nu]: https://npmjs.org/package/torrent-discovery

[typedarray-to-buffer]: https://github.com/feross/typedarray-to-buffer
[typedarray-to-buffer-ti]: https://img.shields.io/travis/feross/typedarray-to-buffer.svg?style=flat
[typedarray-to-buffer-tu]: https://travis-ci.org/feross/typedarray-to-buffer
[typedarray-to-buffer-ni]: https://img.shields.io/npm/v/typedarray-to-buffer.svg?style=flat
[typedarray-to-buffer-nu]: https://npmjs.org/package/typedarray-to-buffer

[ut_metadata]: https://github.com/feross/ut_metadata
[ut_metadata-ti]: https://img.shields.io/travis/feross/ut_metadata.svg?style=flat
[ut_metadata-tu]: https://travis-ci.org/feross/ut_metadata
[ut_metadata-ni]: https://img.shields.io/npm/v/ut_metadata.svg?style=flat
[ut_metadata-nu]: https://npmjs.org/package/ut_metadata

[ut_pex]: https://github.com/fisch0920/ut_pex
[ut_pex-ti]: https://img.shields.io/travis/fisch0920/ut_pex.svg?style=flat
[ut_pex-tu]: https://travis-ci.org/fisch0920/ut_pex
[ut_pex-ni]: https://img.shields.io/npm/v/ut_pex.svg?style=flat
[ut_pex-nu]: https://npmjs.org/package/ut_pex

[webtorrent-swarm]: https://github.com/feross/webtorrent-swarm
[webtorrent-swarm-ti]: https://img.shields.io/travis/feross/webtorrent-swarm.svg?style=flat
[webtorrent-swarm-tu]: https://travis-ci.org/feross/webtorrent-swarm
[webtorrent-swarm-ni]: https://img.shields.io/npm/v/webtorrent-swarm.svg?style=flat
[webtorrent-swarm-nu]: https://npmjs.org/package/webtorrent-swarm

[webtorrent-tracker]: https://github.com/feross/webtorrent-tracker
[webtorrent-tracker-ti]: https://img.shields.io/travis/feross/webtorrent-tracker.svg?style=flat
[webtorrent-tracker-tu]: https://travis-ci.org/feross/webtorrent-tracker
[webtorrent-tracker-ni]: https://img.shields.io/npm/v/webtorrent-tracker.svg?style=flat
[webtorrent-tracker-nu]: https://npmjs.org/package/webtorrent-tracker

#### Todo

- compress-sdp (compress sdp messages to lighten load on webtorrent trackers & dht)
- protocol extension: protocol encryption
- protocol extension: µTP
- protocol extension: UPnP and NAT-PMP port forwarding
- protocol extension: webseed support
- webtorrent-dht

### Contribute

WebTorrent is an **[OPEN Open Source Project](https://github.com/feross/webtorrent/blob/master/CONTRIBUTING.md)**. Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit.

WebTorrent is only possible due to the excellent work of the following contributors:

<table><tbody>
<tr><th align="left">Feross Aboukhadijeh</th><td><a href="https://github.com/feross">GitHub/feross</a></td><td><a href="http://twitter.com/feross">Twitter/@feross</a></td></tr>
<tr><th align="left">Daniel Posch</th><td><a href="https://github.com/dcposch">GitHub/dcposch</a></td><td><a href="http://twitter.com/dcposch">Twitter/@dcposch</a></td></tr>
<tr><th align="left">John Hiesey</th><td><a href="https://github.com/jhiesey">GitHub/jhiesey</a></td><td><a href="http://twitter.com/jhiesey">Twitter/@jhiesey</a></td></tr>
<tr><th align="left">Travis Fischer</th><td><a href="https://github.com/fisch0920">GitHub/fisch0920</a></td><td><a href="http://twitter.com/fisch0920">Twitter/@fisch0920</a></td></tr>
<tr><th align="left">Astro</th><td><a href="https://github.com/astro">GitHub/astro</a></td><td><a href="http://twitter.com/astro1138">Twitter/@astro1138</a></td></tr>
<tr><th align="left">Iván Todorovich</th><td><a href="https://github.com/ivantodorovich">GitHub/ivantodorovich</a></td><td><a href="http://twitter.com/ivantodorovich">Twitter/@ivantodorovich</a></td></tr>
<tr><th align="left">Mathias Buus</th><td><a href="https://github.com/mafintosh">GitHub/mafintosh</a></td><td><a href="http://twitter.com/mafintosh">Twitter/@mafintosh</a></td></tr>
<tr><th align="left">Bob Ren</th><td><a href="https://github.com/bobrenjc93">GitHub/bobrenjc93</a></td><td><a href="http://twitter.com/bobrenjc93">Twitter/@bobrenjc93</a></td></tr>
</tbody></table>

#### Clone the code

```bash
git clone https://github.com/feross/webtorrent.git
cd webtorrent
npm install
./bin/cmd.js --help
```

#### Enable debug logs

In **node**, enable debug logs by setting the `DEBUG` environment variable to the name of the
module you want to debug (e.g. `bittorrent-protocol`, or `*` to print **all logs**).

```bash
DEBUG=* webtorrent
```

Of course, this also works for the development version:

```bash
DEBUG=* ./bin/cmd.js
```

In the **browser**, enable debug logs by running this in the developer console:

```js
localStorage.debug = '*'
```

Disable by running this:

```js
localStorage.removeItem('debug')
```

#### Clone all dependencies

WebTorrent is a modular BitTorrent client, so functionality is split up into many
npm modules. You can `git clone` all the relevant dependencies with one command. This
makes it easier to send PRs:

```bash
./bin/clone.sh
```

### Talks about WebTorrent

- Sep 2014 (NodeConf EU) – WebTorrent &amp; WebRTC: Mad Science (first working demo of WebTorrent)
- May 2014 (JS.LA) – [How I Built a BitTorrent Client in the Browser](https://vimeo.com/97324247) (progress update; node client working)
- Oct 2013 (RealtimeConf) – [WebRTC Black Magic (RealtimeConf)](https://vimeo.com/77265280) (where I first shared the idea of WebTorrent)

### Known issues

#### Downloads don't start on Chromebook

Chromebooks are set to refuse all incoming connections by default. To change this, run:

```bash
sudo iptables -P INPUT ACCEPT
```

### License

MIT. Copyright (c) [Feross Aboukhadijeh](http://feross.org).

![Magic](img/logo.png)