abhishek1io / TorrentiumApi

The backend for Torrentium Android App

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

TorrentiumAPI

The backend for the Torrentium Android app.

Features

  • RESTful - The RESTful API is built using the FastAPI framework
  • Scraper - API to torrents site such as nyaa.si and sukebei.nyaa.si
  • Caching - The server is configured cache the results for 2 minutes.
  • All-purpose downloader - Access to aria2c for downloading torrents
  • Automated uploads - Automated uploads of downloads via rclone to cloud storage.

Deploy on heroku

Deploy

Required tools

git clone https://github.com/itsZECHS/TorrentiumAPI.git
cd TorrentiumAPI
heroku create
heroku stack:set container -a {app_name}
heroku git:remote -a {app_name}
git push heroku main

Set environment variables

Heroku Config Vars

  • Here RCLONE_REMOTE is the token from rclone config, to obtain this follow steps below

  • rclone config show

What to copy

  • Copy all config variables (except the remote name).

To avoid your app from sleeping (if you're on free dyno) you can set the APP_NAME variable, this should be same as your heroku app name.

How to use?

Once deployed, you can vist localhost for full documentation on the api.

The intended use of this API is to be used by the Torrentium app which you can download from here.

Demo

Check out the publicly deployed version here Heroku - TorrentiumAPI.

This is only for demonstration purpose and is not intended to be used in production.

About

The backend for Torrentium Android App

License:MIT License


Languages

Language:Python 90.3%Language:Shell 8.4%Language:Dockerfile 1.3%