webtorrent
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
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, 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, mkv, mp4, ogv, mov, etc (AV1, H264, HEVC*, VP8, VP9, AAC, FLAC, MP3, OPUS, Vorbis, etc))To install WebTorrent for use in node or the browser with import WebTorrent from '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!
import WebTorrent from 'webtorrent'
const client = new WebTorrent()
const magnetURI = '...'
client.add(magnetURI, torrent => {
// Got torrent metadata!
console.log('Client is downloading:', torrent.infoHash)
for (const file of torrent.files) {
document.body.append(file.name)
}
})
import dragDrop from 'drag-drop'
import WebTorrent from 'webtorrent'
const client = new WebTorrent()
// When user drops files on the browser, create a new torrent and start seeding it!
dragDrop('body', files => {
client.seed(files, 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 lets 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, another module bundler. However, webpack requires extra configuration which you can find in the webpack bundle config used by webtorrent.
Or, you can just use the pre-built version via
import WebTorrent from 'webtorrent/dist/webtorrent.min.js' and skip the webpack configuration.
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 type='module'>
import WebTorrent from '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 type='module'>
import WebTorrent from 'https://esm.sh/webtorrent'
</script>
If you want to use WebTorrent in a Chrome App, you can include the following script:
<script type='module'>
import WebTorrent from 'webtorrent.chromeapp.js'
</script>
Be sure to enable the chrome.sockets.udp and chrome.sockets.tcp permissions!
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 |
| bittorrent-lsd |  |  | bittorrent local service discovery |
| create-torrent |  |  | create .torrent files |
| magnet-uri |  |  | parse magnet uris |
| parse-torrent |  |  | parse torrent identifiers |
| torrent-discovery |  |  | find peers via dht, tracker, and lsd |
| 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.setItem('debug', '*')
Disable by running this:
localStorage.removeItem('debug')
MIT. Copyright (c) Feross Aboukhadijeh and WebTorrent, LLC.
FAQs
Streaming torrent client
The npm package webtorrent receives a total of 2,507 weekly downloads. As such, webtorrent popularity was classified as popular.
We found that webtorrent demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago.Ā It has 10 open source maintainers 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.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.