Streaming BitTorrent client for the browser
Want to see pretty graphs? Log in now!
npm install webtorrent
|17||downloads in the last week|
|48||downloads in the last month|
|Last Published By|
|Version||0.2.4 last updated a month ago|
|Keywords||torrent, bittorrent, bittorrent client, webrtc, webrtc data, webtorrent, mad science|
|Dependencies (19)||async, bitfield, bittorrent-dht, bittorrent-protocol, bittorrent-swarm, bncode, brfs, chrome-portfinder, font-awesome, hat, humanize, inherits, jquery, keymaster, magnet-uri, parse-torrent, rusha-browserify, speedometer, moment|
WebTorrent - Streaming BitTorrent client for the browser
Warning: This is pre-alpha software. Nothing works yet. Watch/star to follow along with progress.
Ways to help
- Send pull requests. Take a look at the open issues and see if there's something you can help with. Ideas and suggestions are welcome too.
- BitTorrent in your browser!
- No plugins (uses WebRTC Data Channels for peer-to-peer data)
- Streaming playback (get first pieces first)
videotag with MediaSource API when possible
- Flash player with JS bridge for other media types
- Works with .torrent files and magnet links
- Supports DHT (trackerless torrents) over WebRTC
- Extensions to DHT protocol to work over WebRTC
- DHT nodes do "peer introductions" so WebRTC can work without a centralized signaling server
- Supports completely serverless, trackerless operation
Build a browser BitTorrent client that requires no install (no plugin/extension/etc.) and fully-interoperates with the regular BitTorrent network. Use WebRTC Data Channels for peer-to-peer transport.
Since WebTorrent is web-first, it's simple for users who do not understand .torrent files, magnet links, NATs, etc. By making BitTorrent easier, it will be accessible to new swathes of users who were previously intimidated, confused, or unwilling to install a program on their machine to participate.
Most of the active development is happening inside of smaller npm modules which will be used by WebTorrent. These are the modules I am writing to make WebTorrent work:
- webtorrent (main repo)
- bittorrent-dht (work-in-progress)
- webtorrent-protocol (todo)
- webtorrent-dht (todo)
- webtorrent-swarm (todo)
- webtorrent-bootstrap (todo)
- webworker-pool (todo)
- webtorrent-verifier (todo)
- sdp-compress (todo)
- webtorrent-chrome (todo)
The Node Way™
"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"
Interoperability with BitTorrent
Problem: WebTorrent clients and normal BitTorrent clients cannot directly connect because WebRTC cannot open UDP/TCP sockets. This is a security restriction on WebRTC that is unlikely to change. So, how do we get content into the WebTorrent network?
Best solution: Mainstream BitTorrent clients add support for WebTorrent. Basically, normal clients implement WebRTC so that WebTorrent clients can directly connect to them. (This could happen once WebTorrent has a lot of users.)
Good solution: Users who want to download torrents that aren't yet seeded by any WebTorrent users need to install a "hybrid client" that implements WebTorrent and BitTorrent. This can be implemented as a Chrome/Firefox App/Extension that bridges the two networks like this:
- Hybrid clients can seed+leech from both WebTorrent and BitTorrent users.
- Hybrid clients are DHT nodes in both the WebTorrent and BitTorrent DHTs.
- The first time a hybrid client downloads a torrent that no other WebTorrent clients are seeding, they become the first WebTorrent seeder. (They essentially "bring" the file into the WebTorrent network).
- Important note: Hybrid clients never download torrents on behalf of other users. That would be a terrible idea.
- Until BitTorrent clients support WebTorrent, "pure" WebTorrent clients can only download from other WebTorrent clients.
WebTorrent vs BitTorrent
- WebTorrent is slower at finding peers since "DHT over WebRTC" requires multiple roundtrips for peer introductions. (This is a requirement of WebRTC signaling - no way around this)
- WebTorrent peers must keep their browser tab open to seed (Show UI to encourage seeding back at least 2x)
- Slower piece verification (SHA1) (max 2MB/s with web worker pool, Web Crypto API will bring huge speed-up when it's finally ready)
- WebTorrent bootstrap DHT node does a bit more work than a BitTorrent one since it must do WebRTC signaling. (Not a huge deal)
Todo for basic bitorrent client as chrome app
Use UDP/TCP APIs Support DHT Support peer wire protocol Support magnet links (fetching .torrent from network) Basic UI
- Fetching logic
- Large file saving (downloading in-memory for now, later IndexedDB/FileSystem API)
- Streaming video, options:
- HTTP stream to VLC, like peerflix
- MediaSource into
- Flash player for other media types
Todo for webtorrent
- DHT over WebRTC (add new method for peer introduction)
- Use bootstrap server for initial introduction
- POST endpoint for sending offer/getting answer
- Easy torrent creation
- UPnP or NAT-PMP (so the hybrid client can get listed in peers' routing tables)
Run the app
git clone firstname.lastname@example.org:feross/webtorrent.git cd webtorrent npm start
(Currently requires Chrome Canary (OS X) to be installed, but this will be easy to fix)
Introduction to WebRTC Data and WebTorrent
Watch the talk from RealtimeConf on Vimeo (skip to end for stuff about WebTorrent):
- BitTorrent Spec (BEP 0003)
- BitTorrent Spec (Wiki)
- Reference BitTorrent Client (BTPD)
- DHT Protocol
- Kademlia Paper
- Feross Aboukhadijeh (author)
- Daniel Posch
- John Hiesey
- Contributions welcome! Add yourself here when you send a pull request.
MIT. Copyright (c) Feross Aboukhadijeh.