webtorrent-rit
Advanced tools
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
require('webtorrent') with browserify. 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, 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.
 |  |
|---|
<video> tag (webm (vp8, vp9) or mp4 (h.264))
To install WebTorrent for use in node or the browser with require('webtorrent'), run:
npm install webtorrent
To install a webtorrent
command line program, run:
npm install webtorrent-cli -g
To install a WebTorrent desktop application for Mac, Windows, or Linux, see WebTorrent Desktop.
#webtorrent to help
with development or to hang out with some mad science hackers :)Read the full API Documentation.
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!
var WebTorrent = require('webtorrent')
var client = new WebTorrent()
var magnetURI = '...'
client.add(magnetURI, function (torrent) {
// Got torrent metadata!
console.log('Client is downloading:', torrent.infoHash)
torrent.files.forEach(function (file) {
// Display the file by appending it to the DOM. Supports video, audio, images, and
// more. Specify a container element (CSS selector or reference to DOM node).
file.appendTo('body')
})
})
var dragDrop = require('drag-drop')
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 (torrent) {
console.log('Client is seeding:', torrent.infoHash)
})
})
There are more examples in docs/get-started.md.
WebTorrent works great with browserify, an npm package that let's you use node-style require() to organize your browser code and load modules installed by npm (as seen in the previous examples).
WebTorrent also works with webpack, a module bundler similar to browserify. However, webpack requires the following extra configuration:
{
target: 'web',
node: {
fs: 'empty'
}
}
If you are on webpack 1.x, you will also need to add the json-loader:
{
module: {
loaders: [
// make sure to install the 'json-loader' package: npm install json-loader
{
test: /\.json$/,
loader: 'json'
}
]
}
}
Otherwise you could also directly use the pre-built version via require('webtorrent/webtorrent.min').
WebTorrent is also available as a standalone script
(webtorrent.min.js) which exposes WebTorrent on the window
object, so it can be used with just a script tag:
<script src="webtorrent.min.js"></script>
The WebTorrent script is also hosted on fast, reliable CDN infrastructure (Cloudflare and MaxCDN) for easy inclusion on your site:
<script src="https://cdn.jsdelivr.net/npm/webtorrent@latest/webtorrent.min.js"></script>
WebTorrent also works in node.js, using the same npm package! It's mad science!
NOTE: To connect to "web peers" (browsers) in addition to normal BitTorrent peers, use webtorrent-hybrid which includes WebRTC support for node.
WebTorrent is also available as a command line app. Here's how to use it:
$ npm install webtorrent-cli -g
$ webtorrent --help
To download a torrent:
$ webtorrent magnet_uri
To stream a torrent to a device like AirPlay or Chromecast, just pass a flag:
$ webtorrent magnet_uri --airplay
There are many supported streaming options:
--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.
Most of the active development is happening inside of small npm packages which are used by WebTorrent.
"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"
These are the main modules that make up WebTorrent:
| module | tests | version | description |
|---|---|---|---|
| webtorrent | | | torrent client (this module) |
| bittorrent-dht |  |  | distributed hash table client |
| bittorrent-peerid |  |  | identify client name/version |
| bittorrent-protocol |  |  | bittorrent protocol stream |
| bittorrent-tracker |  |  | bittorrent tracker server/client |
| create-torrent |  |  | create .torrent files |
| magnet-uri |  |  | parse magnet uris |
| parse-torrent |  |  | parse torrent identifiers |
| render-media |  |  | intelligently render media files |
| torrent-discovery |  |  | find peers via dht and tracker |
| ut_metadata |  |  | metadata for magnet uris (protocol extension) |
| ut_pex |  |  | peer discovery (protocol extension) |
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).
DEBUG=* webtorrent
In the browser, enable debug logs by running this in the developer console:
localStorage.debug = '*'
Disable by running this:
localStorage.removeItem('debug')
MIT. Copyright (c) Feross Aboukhadijeh and WebTorrent, LLC.
FAQs
Streaming torrent client
We found that webtorrent-rit demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.