Skip to content

Latest commit

 

History

History
247 lines (172 loc) · 10.3 KB

README.md

File metadata and controls

247 lines (172 loc) · 10.3 KB
Raw

Real-Debrid Torrent Client

This is a web interface to manage your torrents on Real-Debrid, AllDebrid or Premiumize. It supports the following features:

  • Add new torrents through magnets or files
  • Download all files from Real-Debrid, AllDebrid or Premiumize to your local machine automatically
  • Unpack all files when finished downloading
  • Implements a fake qBittorrent API so you can hook up other applications like Sonarr, Radarr or Couchpotato.
  • Built with Angular 15 and .NET 8

You will need a Premium service at Real-Debrid, AllDebrid or Premiumize!

Click here to sign up for Real-Debrid.

Click here to sign up for AllDebrid.

Click here to sign up for Premiumize.

(referal links so I can get a few free premium days)

Docker Setup

You can run the docker container on Windows, Linux. To get started either use Docker Run or Docker Compose.

Docker Run

docker run --pull=always
		   --volume /your/download/path/:/data/downloads \
		   --volume /your/storage/path/:/data/db \
		   --log-driver json-file \
		   --log-opt max-size=10m \
		   -p 6500:6500 \
		   --name rdtclient \
		   rogerfar/rdtclient:latest

Replace /your/download/path/ with your local path to download files to. For Windows i.e. C:/Downloads. Replace /your/storage/path/ with your local path to store persistent database and log files in. For Windows i.e. C:/Docker/rdt-client.

Docker Compose

You can use the provided docker compose to run:

version: '3.3'
services:
    rdtclient:
        container_name: rdtclient
        volumes:
            - 'D:/Downloads/:/data/downloads'
            - 'D:/Docker/rdt-client/:/data/db'
        image: rogerfar/rdtclient
        restart: always
        logging:
            driver: json-file
            options:
                max-size: 10m
        ports:
            - '6500:6500'

And to run:

docker-compose up -d

Replace the paths in volumes as in the above step.

Run as a Service

Instead of running in Docker you can install it as a service in Windows or Linux.

Windows Service

  1. Make sure you have the ASP.NET Core Runtime 8 installed: https://dotnet.microsoft.com/download/dotnet/8.0
  2. Get the latest zip file from the Releases page and extract it to your host.
  3. Open the appsettings.json file and replace the LogLevel Path to a path on your host.
  4. In appsettings.json replace the Database Path to a path on your host.
  5. When using Windows paths, make sure to escape the slashes. For example: D:\\RdtClient\\db\\rdtclient.db

Linux Service

Instead of running in Docker you can install it as a service in Linux.

  1. Install .NET: https://docs.microsoft.com/en-us/dotnet/core/install/linux

    Ubuntu 20.04 example:
    wget https://packages.microsoft.com/config/ubuntu/20.04/packages-microsoft-prod.deb -O packages-microsoft-prod.deb

    sudo dpkg -i packages-microsoft-prod.deb

    rm packages-microsoft-prod.deb

    sudo apt-get update && sudo apt-get install -y dotnet-sdk-8.0

  2. Get latest archive from releases:
    wget <zip_url>

  3. Extract to path of your choice (~/rtdc in this example):
    unzip RealDebridClient.zip -d ~/rdtc && cd ~/rdtc

  4. In appsettings.json replace the Database Path to a path on your host. Any directories in path must already exist. Or just remove "/data/db/" for ease.

  5. Test rdt client runs ok:
    dotnet RdtClient.Web.dll
    navigate to http://:6500, if all is good then we'll create a service

  6. Create a service (systemd in this example):
    sudo nano /etc/systemd/system/rdtc.service

    paste in this service file content and edit path of your directory:

    [Unit]
Description=RdtClient Service

[Service]

WorkingDirectory=/home/<username>/rdtc
ExecStart=/usr/bin/dotnet RdtClient.Web.dll
SyslogIdentifier=RdtClient
User=<username>

[Install]
WantedBy=multi-user.target

  7. enable and start the service:
    sudo systemctl daemon-reload
    sudo systemctl enable rdtc
    sudo systemctl start rdtc

Proxmox LXC

If you use Proxmox for your homelab, you can run rdt-client in a linux container (LXC), check it here: https://tteck.github.io/Proxmox/

Setup

First Login

  1. Browse to http://127.0.0.1:6500 (or the path of your server).
  2. The very first credentials you enter in will be remembered for future logins.
  3. Click on Settings on the top and enter your Real-Debrid API key (found here: https://real-debrid.com/apitoken.
  4. If you are using docker then the Download path setting needs to be the same as in your docker file mapping. By default this is /data/downloads. If you are using Windows, this is a path on your host.
  5. Same goes for Mapped path, but this is the destination path from your docker mapping. This is a path on your host. For Windows, this will most likely be the same as the Download path.
  6. Save your settings.

Download Clients

Currently there 4 available download clients:

Internal Downloader

This experimental downloader can be used to download files with multiple sections in parallel.

It has the following options:

  • Download speed (in MB/s): This number indicates the speed in MB/s per download over all parallel downloads and chunks.
  • Parallel connections per download: When a file is downloaded it is split in sections, this setting indicates how many sections you will download in parallel.
  • Connection Timeout: This number indicates the timeout in milliseconds before a download chunk times out. It will retry each chunk 5 times before completely failing.

Bezzad Downloader

This downloader can be used to download files in parallel and with multiple chunks.

It has the following options:

  • Download speed (in MB/s): This number indicates the speed in MB/s per download over all parallel downloads and chunks.
  • Parallel connections per download: This number indicates how many parallel it will use per download. This can increase speed, recommended is no more than 8.
  • Parallel chunks per download: This number indicates in how many chunks each download is split, recommended is no more than 8.
  • Connection Timeout: This number indicates the timeout in milliseconds before a download chunk times out. It will retry each chunk 5 times before completely failing.

Aria2c downloader

This will use an external Aria2c downloader client. You will need to install this client yourself on your host, it is not included in the docker image.

It has the following options:

  • Url: The full URL to your Aria2c service. This must end in /jsonrpc. A standard path is http://192.168.10.2:6800/jsonrpc.
  • Secret: Optional secret to connecto to your Aria2c service.

If Aria2c is selected, none of the above options for Internal Downloader are used, you have to configure Aria2c manually.

Symlink downloader

Symlink downloader requires a rclone mount to be mounted into your filesystem. Be sure to keep the exact path to mounted files in other apps exactly the same as used by rdt-client. Otherwise the symlinks wont resolve the file its trying to point to.

If the mount path folder cant be found the client wont start downloading anything.

Required configuration:

  • Post Download Action = DO NOT SELECT REMOVE FROM PROVIDER
  • Rclone mount path = /PATH_TO_YOUR_RCLONE_MOUNT/torrents/

Suggested configuration:

  • Automatic retry downloads > 3

Troubleshooting

  • If you forgot your logins simply delete the rdtclient.db and restart the service.
  • A log file is written to your persistent path as rdtclient.log. When you run into issues please change the loglevel in your docker script to Debug.

Connecting Sonarr/Radarr

RdtClient emulates the qBittorrent web protocol and allow applications to use those APIs. This way you can use Sonarr and Radarr to download directly from RealDebrid.

  1. Login to Sonarr or Radarr and click Settings.
  2. Go to the Download Client tab and click the plus to add.
  3. Click qBittorrent in the list.
  4. Enter the IP or hostname of the RealDebridClient in the Host field.
  5. Enter the 6500 in the Port field.
  6. Enter your Username/Password you setup above in the Username/Password field.
  7. Set the category to sonarr for Sonarr or radarr for Radarr.
  8. Leave the other settings as is.
  9. Hit Test and then Save if all is well.
  10. Sonarr will now think you have a regular Torrent client hooked up.

When downloading files it will append the category setting in the Sonarr/Radarr Download Client setting. For example if your Remote Path setting is set to C:\Downloads and your Sonarr Download Client setting category is set to sonarr files will be downloaded to C:\Downloads\sonarr.

Notice: the progress and ETA reported in Sonarr's Activity tab will not be accurate, but it will report the torrent as completed so it can be processed after it is done downloading.

Running within a folder

By default the application runs in the root of your hosted address (i.e. https://rdt.myserver.com/), but if you want to run it as a relative folder (i.e. https://myserver.com/rdt) you will have to change the BasePath setting in the appsettings.json file. You can set the BASE_PATH environment variable for docker enviroments.

Build instructions

Prerequisites

  • NodeJS
  • NPM
  • Angular CLI
  • .NET 8
  • Visual Studio 2022
  • (optional) Resharper
  1. Open the client folder project in VS Code and run npm install.
  2. To debug run ng serve, to build run ng build --prod.
  3. Open the Visual Studio 2019 project RdtClient.sln and Publish the RdtClient.Web to the given PublishFolder target.
  4. When debugging, make sure to run RdtClient.Web.dll and not IISExpress.
  5. The result is found in Publish.

Build docker container

  1. In the root of the project run docker build --tag rdtclient .
  2. To create the docker container run docker run --publish 6500:6500 --detach --name rdtclientdev rdtclient:latest
  3. To stop: docker stop rdtclient
  4. To remove: docker rm rdtclient
  5. Or use docker-build.bat