Data

Tools

Indexes

Applications

Experiments

Awesome

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

https://github.com/sirrobot01/debrid-blackhole

A Qbittorent API with Debrid Support
https://github.com/sirrobot01/debrid-blackhole

debrid golang plex qbittorrent torrent

Last synced: 6 months ago
JSON representation

A Qbittorent API with Debrid Support

Awesome Lists containing this project

README 

          
### DecyphArr(Qbittorent, but with Debrid Support)



![ui](doc/main.png)



This is an implementation of QbitTorrent with a **Multiple Debrid service support**. Written in Go.



### Table of Contents



- [DecyphArr(Qbittorent, but with Debrid Support)](#decypharrqbittorent-but-with-debrid-support)

- [Table of Contents](#table-of-contents)

- [Features](#features)

- [Supported Debrid Providers](#supported-debrid-providers)

- [Installation](#installation)

    - [Docker](#docker)

      - [Registry](#registry)

      - [Tags](#tags)

    - [Binary](#binary)

- [Usage](#usage)

  - [Connecting to Sonarr/Radarr](#connecting-to-sonarrradarr)

  - [Basic Sample Config](#basic-sample-config)

    - [Debrid Config](#debrid-config)

    - [Repair Config (**BETA**)](#repair-config-beta)

    - [Proxy Config](#proxy-config)

    - [Qbittorrent Config](#qbittorrent-config)

    - [Arrs Config](#arrs-config)

- [Repair Worker](#repair-worker)

- [Proxy](#proxy)

  - [**Note**: Proxy has stopped working for Real Debrid, Debrid Link, and All Debrid. It still works for Torbox. This is due to the changes in the API of the Debrid Providers.](#note-proxy-has-stopped-working-for-real-debrid-debrid-link-and-all-debrid-it-still-works-for-torbox-this-is-due-to-the-changes-in-the-api-of-the-debrid-providers)

- [Changelog](#changelog)

- [TODO](#todo)



### Features



- Mock Qbittorent API that supports the Arrs(Sonarr, Radarr, etc)

- A Full-fledged UI for managing torrents

- Proxy support for the Arrs

- Real Debrid Support

- Torbox Support

- Debrid Link Support

- Multi-Debrid Providers support

- Repair Worker for missing files (**BETA**)



The proxy is useful for filtering out un-cached Debrid torrents



### Supported Debrid Providers

- [Real Debrid](https://real-debrid.com)

- [Torbox](https://torbox.app)

- [Debrid Link](https://debrid-link.com)

- [All Debrid](https://alldebrid.com)



### Installation



##### Docker



###### Registry

You can use either hub.docker.com or ghcr.io to pull the image. The image is available on both platforms.



- Docker Hub: `cy01/blackhole:latest`

- GitHub Container Registry: `ghcr.io/sirrobot01/decypharr:latest`



###### Tags



- `latest`: The latest stable release

- `beta`: The latest beta release

- `vX.Y.Z`: A specific version (e.g `v0.1.0`)

- `nightly`: The latest nightly build. This is highly unstable



```yaml

version: '3.7'

services:

  decypharr:

    image: cy01/blackhole:latest # or cy01/blackhole:beta

    container_name: decypharr

    ports:

      - "8282:8282" # qBittorrent

      - "8181:8181" # Proxy

    user: "1000:1000"

    volumes:

      - /mnt/:/mnt

      - ~/plex/configs/decypharr/:/app # config.json must be in this directory

    environment:

      - PUID=1000

      - PGID=1000

      - UMASK=002

      - QBIT_PORT=8282 # qBittorrent Port. This is optional. You can set this in the config file

      - PORT=8181 # Proxy Port. This is optional. You can set this in the config file

    restart: unless-stopped

    depends_on:

      - rclone # If you are using rclone with docker

    

```



##### Binary

Download the binary from the releases page and run it with the config file.



```bash

./decypharr --config /app

```



### Usage

- The UI is available at `http://localhost:8282`

- Setup the config.json file. Scroll down for the sample config file

- Setup docker compose/ binary with the config file

- Start the service

- Connect to Sonarr/Radarr/Lidarr



#### Connecting to Sonarr/Radarr



- Sonarr/Radarr

  - Settings -> Download Client -> Add Client -> qBittorrent

  - Host: `localhost` # or the IP of the server

  - Port: `8282` # or the port set in the config file/ docker-compose env

  - Username: `http://sonarr:8989` # Your arr host with http/https

  - Password: `sonarr_token` # Your arr token

  - Category: e.g `sonarr`, `radarr`

  - Use SSL -> `No`

  - Sequential Download -> `No`|`Yes` (If you want to download the torrents locally instead of symlink)

  - Click Test

  - Click Save



#### Basic Sample Config



This is the default config file. You can create a `config.json` file in the root directory of the project or mount it to /app in the docker-compose file.

```json

{

  "debrids": [

    {

      "name": "realdebrid",

      "host": "https://api.real-debrid.com/rest/1.0",

      "api_key": "realdebrid_key",

      "folder": "/mnt/remote/realdebrid/__all__/"

    }

  ],

  "proxy": {

    "enabled": false,

    "port": "8100",

    "username": "username",

    "password": "password"

  },

  "qbittorrent": {

    "port": "8282",

    "download_folder": "/mnt/symlinks/",

    "categories": ["sonarr", "radarr"]

  },

  "repair": {

    "enabled": false,

    "interval": "12h",

    "run_on_start": false

  },

  "use_auth": false,

  "log_level": "info"

}

```



Full config are [here](doc/config.full.json)



  Click Here for the full config notes



- The `log_level` key is used to set the log level of the application. The default value is `info`. log level can be set to `debug`, `info`, `warn`, `error`

- The `max_cache_size` key is used to set the maximum number of infohashes that can be stored in the availability cache. This is used to prevent round trip to the debrid provider when using the proxy/Qbittorrent. The default value is `1000`

- The `allowed_file_types` key is an array of allowed file types that can be downloaded. By default, all movie, tv show and music file types are allowed

- The `use_auth` is used to enable basic authentication for the UI. The default value is `false`

- The `discord_webhook_url` is used to send notifications to discord



##### Debrid Config

- The `debrids` key is an array of debrid providers

- The `name` key is the name of the debrid provider

- The `host` key is the API endpoint of the debrid provider

- The `api_key` key is the API key of the debrid provider

- The `folder` key is the folder where your debrid folder is mounted(webdav, rclone, zurg etc). e.g `data/realdebrid/torrents/`, `/media/remote/alldebrid/magnets/`

- The `rate_limit` key is the rate limit of the debrid provider(null by default)

- The `download_uncached` bool key is used to download uncached torrents(disabled by default)

- The `check_cached` bool key is used to check if the torrent is cached(disabled by default)



##### Repair Config (**BETA**)

The `repair` key is used to enable the repair worker

- The `enabled` key is used to enable the repair worker

- The `interval` key is the interval in either minutes, seconds, hours, days. Use any of this format, e.g 12:00, 5:00, 1h, 1d, 1m, 1s.

- The `run_on_start` key is used to run the repair worker on start

- The `zurg_url` is the url of the zurg server. Typically `http://localhost:9999` or `http://zurg:9999`

- The `auto_process` is used to automatically process the repair worker. This will delete broken symlinks and re-search for missing files



##### Proxy Config

- The `enabled` key is used to enable the proxy

- The `port` key is the port the proxy will listen on

- The `log_level` key is used to set the log level of the proxy. The default value is `info`

- The `username` and `password` keys are used for basic authentication

- The `cached_only` means only cached torrents will be returned



##### Qbittorrent Config

- The `port` key is the port the qBittorrent will listen on

- The `download_folder` is the folder where the torrents will be downloaded. e.g `/media/symlinks/`

- The `categories` key is used to filter out torrents based on the category. e.g `sonarr`, `radarr`

- The `refresh_interval` key is used to set the interval in minutes to refresh the Arrs Monitored Downloads(it's in seconds). The default value is `5` seconds



##### Arrs Config

This is an array of Arrs(Sonarr, Radarr, etc) that will be used to download the torrents. This is not required if you already set up the Qbittorrent in the Arrs with the host, token.

This is particularly useful if you want to use the Repair tool without using Qbittorent

- The `name` key is the name of the Arr/ Category

- The `host` key is the host of the Arr

- The `token` key is the API token of the Arr

- THe `cleanup` key is used to cleanup your arr queues. This is usually for removing dangling queues(downloads that all the files have been import, sometimes, some incomplete season packs)



### Repair Worker



The repair worker is a simple worker that checks for missing files in the Arrs(Sonarr, Radarr, etc). It's particularly useful for files either deleted by the Debrid provider or files with bad symlinks.



**Note**: If you're using zurg, set the `zurg_url` under repair config. This will speed up the repair process, exponentially.



- Search for broken symlinks/files

- Search for missing files

- Search for deleted/unreadable files



### Proxy



#### **Note**: Proxy has stopped working for Real Debrid, Debrid Link, and All Debrid. It still works for Torbox. This is due to the changes in the API of the Debrid Providers.



The proxy is useful in filtering out un-cached Debrid torrents. 

The proxy is a simple HTTP proxy that requires basic authentication. The proxy can be enabled by setting the `proxy.enabled` to `true` in the config file. 

The proxy listens on the port `8181` by default. The username and password can be set in the config file.



### Changelog



- View the [CHANGELOG.md](CHANGELOG.md) for the latest changes



### TODO

- [x] A proper name!!!!

- [x] Debrid

  - [x] Add more Debrid Providers



- [x] Qbittorrent

  - [x] Add more Qbittorrent features

  - [x] Persist torrents on restart/server crash

- [ ] Add tests