search

jpillora / node-torrent-cloud

Torrent Cloud – A self-hosted Bittorrent client in the Cloud
183 stars 183 forks source link

readme

The first release of version 2 is ready!

:warning: This version is deprecated. If you'd like to be the maintainer or contributer of this version, please leave a comment here.

Torrent Cloud

A torrent client in the cloud, written in Node.js

There are a various existing cloud torrent services (bitport.io, btcloud.io, put.io), though they're all subscription-based or have limits imposed. Torrent Cloud is intended to be self-hosted on your own cloud compute combined with your own cloud storage. When a file is downloaded, Torrent Cloud simultaneously downloads and uploads the file, so when a torrent is complete, you'll find it in your own storage.

screenshot

Disclaimer This project was created to bring about an addition download channel to defeat unfair BitTorrent protocol restrictions imposed by enterprises and ISPs. It was intended for downloading legal, non-copywrite material, such as: public linux distributions, personal files, large public statistical datasets, public domain images and videos from archive.org, etc. This project will not take any responsibility for any illegal use, by using this software you agree to these terms.

Features

Installation

  1. Collect the environment variables

    1. Setup your cloud storage (Choose one)

      • AWS

        1. Sign up for a free for 1 year Amazon Web Services account
        2. Go to the AWS Console
        3. Retrieve your API keys (Top-right menu [Your Name] > Security Credentials)
        4. Create an S3 bucket in the region closest to you
        5. You'll need your AWS Access key (AWS_ACCESS_KEY Required)
        6. You'll need your AWS Secret key (AWS_SECRET_KEY Required)
        7. You'll need the S3 bucket name (AWS_BUCKET Required)
        8. You'll need the S3 bucket region code (AWS_REGION Required see region codes)

      • Mega Warning: the Mega backend is quite buggy

        1. Sign up for a free Mega account
        2. You'll need your username (email address) (MEGA_EMAIL Required)
        3. You'll need your password (MEGA_PASSRequired)

      Note: See the contribute section for adding more storage backends

    2. Consider these optional variables

      1. HOST Listening interface (Optional defaults to all 0.0.0.0)
      2. PORT Listening port (Optional default 3000)
      3. AUTH_USER HTTP Basic Auth (Optional default admin)
      4. AUTH_PASSWORD HTTP Basic Auth (Optional if set HTTP auth will be enabled)
      5. SEARCH_PROVIDERS_URL URL to a JSON configuration file (Optional see below)

  2. Choose a cloud hosting environment

    1. Heroku

      1. Sign up for a free Heroku account

      2. Click this Deploy button and fill in the variables you've considered above

        Deploy

    2. Others

      1. Install Node
      2. $ npm i -g torrent-cloud
      3. env PORT=8080 torrent-cloud

  3. And that's it! (On Heroku, visit https://<appname>.herokuapp.com)

You can change these via the Heroku command-line tool or in the Heroku dashboard Apps > App > Config Variables > Reveal > Edit.

Search Providers

Torrent Cloud provides an easy way to screen-scrape any of the copyright-free (legal) torrent sites. The search provider specification can be found here: https://gist.github.com/jpillora/e667f3d16a6bd403edc4. Please add your custom providers in the comment section.

Contributing

Backend A Node.js app using Express, WebSockets, and many other modules. The server entry point is server.js and the modules are inside lib/, they're documented in the comments though questions are welcome via Issues. Currently there are only Mega and AWS storage backends, though contributions are wanted. To get started, take a look at lib/backends/_template.js for the required interface.

Frontend An Angular app with related all files in static/. The HTTP API is for initiating all actions (e.g. start/stop torrent), and will return an error or an empty OK. The entire app state is sent, on change, via WebSockets.

Help!

Ask questions on the Issues page.

Known Issues

Todo

Credits

Built around @mafintosh's awesome torrent-stream.

MIT License

Copyright © 2015 Jaime Pillora <dev@jpillora.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.