search

kzahel / jstorrent

JavaScript Torrent Client primarily for ChromeOS and the Chrome Web Store
https://www.jstorrent.com
Other
407 stars 114 forks source link

readme

JSTorrent

Try it now in CWS

JSTorrent Available for install Chrome Web Store

Get the JSTorrent Helper Extension, which adds a right click "Add to JSTorrent" menu for magnet links and .torrent files

JSTorrent is the original Chrome Packaged/Platform App for downloading torrents. It stands for "JavaScript Torrent." It is perfect for cheap ARM Chromebooks when you need to torrent something, but also perfect for your high end Chromebook Pixel. :-) While it is specifically designed to integrate well with ChromeOS, it will also run on Windows / Mac / Linux, or anywhere else you are able to install Google Chrome.

JSTorrent is the world's most secure Torrent client. It runs in the Chrome sandbox, so it does not have access to any files on your system (except the Download folder you choose). With JSTorrent, you are in control.

I don't frequently keep this readme very up to date. You can find the actual changelogs in the Chrome Web Store listing, or sometimes in the CHANGES.txt

One of my main goals with this project is to get it nearly as fast as the other clients. Disk I/O is pretty slow with the chrome APIs, which I am working on optimizing for. Some other bottlenecks at this point include SHA1 hashing (done in a worker) as well as suboptimal peer selection and queueing.

I am frequently adding features and improvements to this project, and welcome user feedback, as it directs the future growth of the program.

This software was totally rewritten from scratch (Dec 2013). This is about the third time I've written a torrent client, so it should be the least buggy of them all :-)

I'm currently charging $3 for the install on the chrome web store. But you can also run it from source here. I want to do some kind of donate/freemium model, once I can figure out this: http://stackoverflow.com/questions/21147236/get-user-openid-url-without-user-interaction (I want to be able to detect users who already paid $3)

The source code is available here for auditing and education purposes. I believe open software is great, and I would not ask any user to install something that they can't reasonably verify is not doing anything malicious. However, the license does not permit redistribution of the jstorrent code or assets in your own projects.

Installation:

Most people would usually install by the Chrome Web Store (link) but you can install from source too.

Websites:

Special New Features

Private tracker support notes for site admins

Private tracker support is very lacking. I don't know of any sites that have whitelisted/allowed JSTorrent. I am working on addressing this by improving the seeding and tracker funcions.

I have disabled the "spoofing" feature.

Todo

Credits