Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/webtorrent/instant.io

🚀 Streaming file transfer over WebTorrent (torrents on the web)
https://github.com/webtorrent/instant.io

bittorrent javascript nodejs p2p streaming webrtc webtorrent

Last synced: 24 days ago
JSON representation

🚀 Streaming file transfer over WebTorrent (torrents on the web)

Host: GitHub
URL: https://github.com/webtorrent/instant.io
Owner: webtorrent
License: mit
Created: 2014-08-02T18:11:53.000Z (over 10 years ago)
Default Branch: master
Last Pushed: 2024-03-28T15:01:39.000Z (8 months ago)
Last Synced: 2024-05-21T01:05:28.684Z (6 months ago)
Topics: bittorrent, javascript, nodejs, p2p, streaming, webrtc, webtorrent
Language: JavaScript
Homepage: https://instant.io
Size: 1.21 MB
Stars: 3,396
Watchers: 95
Forks: 430
Open Issues: 38
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Authors: AUTHORS.md

Awesome Lists containing this project

awesome-list - instant.io
awesome-network-js - instant.io
awesome-starred - webtorrent/instant.io - 🚀 Streaming file transfer over WebTorrent (torrents on the web) (p2p)
StarryDivineSky - webtorrent/instant.io
awesome-homelab - instant.io

README

Streaming file transfer over WebTorrent (torrents on the web)

Download/upload files using the [WebTorrent](http://webtorrent.io) protocol (BitTorrent
over WebRTC). This is a beta.

Powered by [WebTorrent](http://webtorrent.io), the first torrent client that works in the
browser without plugins. WebTorrent is powered by JavaScript and WebRTC. Supports Chrome,
Firefox, Opera (desktop and Android). Run localStorage.debug = '*' in the
console and refresh to get detailed log output.

## Install

If you just want to do file transfer on your site, or fetch/seed files over WebTorrent, then there's no need to run a copy of instant.io on your own server. Just use the WebTorrent script directly. You can learn more at https://webtorrent.io.

The client-side code that instant.io uses is [here](https://github.com/webtorrent/instant.io/blob/master/client/index.js).

### Run a copy of this site on your own server

To get a clone of https://instant.io running on your own server, follow these instructions.

Get the code:

```
git clone https://github.com/webtorrent/instant.io
cd instant.io
npm install
```

Modify the configuration options in [`config.js`](https://github.com/webtorrent/instant.io/blob/master/config.js) to set the IP/port you want the server to listen on.

Copy [`secret/index-sample.js`](https://github.com/webtorrent/instant.io/blob/master/secret/index-sample.js) to `secret/index.js` and update the options in there to a valid TURN server if you want a NAT traversal service (to help peers connect when behind a firewall).

To start the server, run `npm run build && npm start`. That should be it!

## Tips

1. Create a shareable link by adding a torrent infohash or magnet link to the end
of the URL. For example: `https://instant.io#INFO_HASH` or `https://instant.io/#MAGNET_LINK`.

2. You can add multiple torrents in the same browser window.

## License