1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
# 
[](https://travis-ci.org/feross/webtorrent)
[](https://npmjs.org/package/webtorrent)
[](https://www.gittip.com/feross/)
### WebTorrent - Streaming torrent client for node and the browser
> Warning: This is pre-alpha software. Nothing works yet. **Watch/star to follow along with progress.**
### Ways to help
- **Donations.** I fight for the users. JavaScript and WebRTC are my sword and shield. I'm working on WebTorrent almost every night so please support me if you believe in the vision. Send bitcoin to *1B6aystcqu8fd6ejzpmMFMPRqH9b86iiwh* or [donate via Coinbase](https://coinbase.com/checkouts/7c683397e33166651dedfebee6fb0f96).
- **Fix bugs, add features.** Join `#webtorrent` on Freenode. Take a look at the [open issues](https://github.com/feross/webtorrent/issues?state=open) and see what you can help with.
Here's how to get started:
```
git clone https://github.com/feross/webtorrent.git
cd webtorrent
npm install
npm start
```
### Planned Features
- **BitTorrent in your browser!**
- **No plugins** (uses WebRTC Data Channels for peer-to-peer data)
- **Streaming playback** (get first pieces first)
- Into `video` tag 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**
### Project Goal
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.
### NPM Modules
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:
#### Targets:
- [webtorrent](https://github.com/feross/webtorrent) (bittorrent client on command line)
- [webtorrent.app](https://github.com/feross/webtorrent.app) (bittorrent client for os x, windows & linux) (coming soon)
- [webtorrent-chrome](https://github.com/feross/webtorrent-chrome) (bittorrent client for chrome -- on hold)
- [webtorrent.js](https://github.com/feross/webtorrent.js) (bittorrent client for the web) (coming soon)
#### Modules:
- [bittorrent-client](https://github.com/feross/bittorrent-client) (bittorrent client engine)
- [bittorrent-dht](https://github.com/feross/bittorrent-dht)
- [bittorrent-protocol](https://github.com/feross/bittorrent-protocol)
- [extension: ut_metadata](https://github.com/feross/ut_metadata) (magnet uris)
- extension: encryption (todo)
- extension: peer exchange protocol (PEX) (todo)
- extension: µTP (todo)
- extension: UPnP and NAT-PMP port forwarding (todo)
- extension: webseed support (todo)
- [bittorrent-swarm](https://github.com/feross/bittorrent-swarm)
- [bittorrent-tracker](https://github.com/feross/bittorrent-tracker)
- [buffer](https://github.com/feross/buffer)
- [chrome-dgram](https://github.com/feross/chrome-dgram)
- [chrome-net](https://github.com/feross/chrome-net)
- [chrome-portfinder](https://github.com/feross/chrome-portfinder)
- [drag-drop](https://github.com/feross/drag-drop)
- [magnet-uri](https://github.com/feross/magnet-uri)
- [parse-torrent](https://github.com/feross/parse-torrent)
- [string2compact](https://github.com/feross/string2compact)
- [typedarray-to-buffer](https://github.com/feross/typedarray-to-buffer)
- compress-sdp (todo)
- webtorrent-bootstrap (todo)
- webtorrent-dht (todo)
- webtorrent-protocol (todo)
- webtorrent-swarm (todo)
- webtorrent-verifier (todo)
- webworker-pool (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"](http://substack.net/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 `video` tag
- 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)
### Contributors
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>
</tbody></table>
### Talks about WebTorrent
- [WebTorrent: Bringing BitTorrent to the Web with WebRTC (CraftConf)](https://www.youtube.com/watch?v=PT8s_IVWDgw) (April 2014, progress update on WebTorrent)
- [WebRTC Black Magic (RealtimeConf)](https://vimeo.com/77265280) (October 2013, where I first shared the idea for WebTorrent (skip to end for WebTorrent))
### License
MIT. Copyright (c) [Feross Aboukhadijeh](http://feross.org).
|
