README

WebTorrent
  
  


The streaming torrent client. For node.js and the web.


  
  
  
  
  



  Sponsored by        



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 node.js, this module is a simple torrent client, using TCP and UDP to talk to
other torrent clients.

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™. Note: WebTorrent does not support UDP/TCP peers in browser.

Simply include the
webtorrent.min.js script
on your page to start fetching files over WebRTC using the BitTorrent protocol, or
import WebTorrent from 'webtorrent' with browserify or webpack. See demo apps
 and code examples 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 or "web
peer" can only connect to other clients that support WebTorrent/WebRTC.

To seed files to web peers, use a client that supports WebTorrent, e.g.
[WebTorrent Desktop][webtorrent-desktop], a desktop client with a
familiar UI that can connect to web peers,
webtorrent-hybrid, a command line program,
or Instant.io, a website. Established torrent clients like
Vuze have already added WebTorrent support so
they can connect to both normal and web peers. We hope other clients will follow.

!Network

 Features

- Torrent client for node.js & the browser (same npm package!)
- 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
  - peer discovery via dht,
    tracker,
    lsd, and
    ut_pex
  - protocol extension api
    for adding new extensions
- Comprehensive test suite (runs completely offline, so it's reliable and fast)
- Check all the supported BEPs here

 Browser/WebRTC environment 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  tag (webm, mkv, mp4, ogv, mov, etc (AV1, H264, HEVC, VP8, VP9, AAC, FLAC, MP3, OPUS, Vorbis, etc))
- Supports Chrome, Firefox, Opera and Safari.


  
    
  
 --

 Install

To install WebTorrent for use in node or the browser with import WebTorrent from 'webtorrent', run:

bash
npm install webtorrent


To install a webtorrent
command line program, run: