Warning
The Real-Debrid integration has a serious bug that can result in a large number of download links being generated per file. It is recommended to take a backup of the root directory, and disable Real-Debrid until this is fixed.
A small app written in Kotlin that emulates the qBittorrent and SABnzbd APIs and creates virtual files that are mapped to remotely cached files at debrid services, essentially acting as a download client that creates virtual file representations of remotely hosted files rather than downloading them. DebriDav exposes these files via the WebDav protocol so that they can be mounted.
- Stream content from Real Debrid, Premiumize and Easynews with Plex/Jellyfin.
- Sort your content as you would regular files. You can create directories, rename files, and move them around any way you like. No need to write regular expressions.
- Seamless integration into the arr-ecosystem, providing a near identical experience to downloading torrents. DebriDav integrates with Sonarr and Radarr using the qBittorrent API, so they can add content, and automatically move your files for you.
- Supports multiple debrid providers. DebriDav supports enabling both Premiumize and Real Debrid concurrently with defined priorities. If a torrent is not cached in the primary provider, it will fall back to the secondary.
It is designed to be used with the *arr ecosystem. DebriDav emulates the qBittorrent and SABnzbd APIs, so you can add it as download clients in the arrs. Once a magnet/nzb is sent to DebriDav it will check if it is cached in any of the available debrid providers and create file representations for the streamable files hosted at debrid providers.
Note that DebriDav does not read the torrents added to your Real Debrid account, or your Premiumize cloud storage. Content you wish to be accessible through DebriDav must be added with the qBittorrent API. An feature to import these files to DebriDav may be added in the future.
Currently Real Debrid, Premiumize and Easynews are supported. If there is demand more may be added in the future.
Due to changes in the Real Debrid API, to the authors best knowledge, the only way to check if a file is instantly available is to start the torrent and then check if the contained files have links available for streaming. This means that if Real Debrid is enabled, every time a magnet is added to Debridav, the torrent will potentially be started on Real Debrid's service. DebriDav will attempt to immediately delete the torrent if no links are available.
Easynews does not provide apis to use the contents of an nzb file to search for streamable content, so instead DebriDav will attempt to use the search feature to find an approximate match for the name of the nzb or torrent.
DebriDav support caching byte ranged requests to remote files. This is useful as metadata from these files will be frequently read, and Easynews in particular can be slow in responding to these requests leading to timeouts.
DEBRIDAV_CHUNKCACHINGGRACEPERIOD controls the amount of time that should pass from the last time the item is
read from the cache until it should be deleted in string format ( ie 10m, 2h, 4d ). The default value is 4h ( 4 hours )
DEBRIDAV_CHUNKCACHINGSIZETHRESHOLD controls the maxiumum size of byte range requests to cache in bytes.
The default value is 102400000 ( 100Mb )
debridav.cached-file-chunk-purge-after-last-read
Since 0.8.0 DebriDav uses a PostgreSQL database to store it's content. Unless disabled by setting
DEBRIDAV_ENABLEFILEIMPORTONSTARTUP to false, DebriDav will attempt to import existing content into the database.
It is recommended to disable this feature after a successful import to improve startup time.
Like the concept of streaming your Premiumize / EasyNews content, but don't want the hassle of configuring and self-hosting?
ElfHosted is a geeky, open-source PaaS, which provides all the "plumbing" (hosting, security, updates, etc) for your self-hosted apps. ElfHosted provide entire hosted streaming "bundles", so all you have to do is plug in your EasyNews / Premiumize credentials, fire up Radarr / Sonarr, and start streaming!
ElfHosted offer pre-configured bundles (with a $1 7-day trial) for Streaming from Premiumize with Plex, Emby, or Jellyfin, as well as from EasyNews with Plex, Emby, or Jellyfin, and also offers DebriDav "unbundled" to augment their existing, debrid-connected stacks.
Important
A portion of your ElfHosted DebriDav subscription supports further development of DebriDav, under the "Elf-illiate" program
Since 0.8.0, DebriDav requires a postgres server. To build the project you will need a java 21 JDK.
See QUICKSTART
Run ./gradlew bootJar to build the jar, and then java -jar build/libs/debridav-0.1.0-SNAPSHOT.jar to run the app.
Alternatively ./gradlew bootRun can be used.
docker run ghcr.io/skjaere/debridav:v0
To build the docker image run ./gradlew jibDockerBuild
You will want to use rclone to mount DebriDav to a directory which can be shared among docker containers. docker-compose.yaml in examples/ can be used as a starting point.
The following values can be defined as environment variables.
| NAME | Explanation | Default |
|---|---|---|
| DEBRIDAV_ROOTPATH | The root path of DebriDav. DebriDav will store configuration data, databases, files under this directory. When running as docker this directory refers to the path within the docker container. | ./debridav-files |
| DEBRIDAV_DOWNLOADPATH | The path under DEBRIDAV_ROOTPATH where downloaded files will be placed. |
/downloads |
| DEBRIDAV_DEBRIDCLIENTS | A comma separated list of enabled debrid providers. Allowed values are REAL_DEBRID, PREMIUMIZE. Note that the order determines the priority in which they are used. |
|
| DEBRIDAV_DB_HOST | The host of the PostgresSQL database server | localhost |
| DEBRIDAV_DB_PORT | The port of the PostgresSQL database server | 5432 |
| DEBRIDAV_DB_DATABASENAME | The name of the database to use within the PostgresSQL server | debridav |
| DEBRIDAV_DB_USERNAME | The username to use when connecting the PostgresSQL server | debridav |
| DEBRIDAV_DB_PASSWORD | The password to use when connecting the PostgresSQL server | debridav |
| DEBRIDAV_ENABLEFILEIMPORTONSTARTUP | Enables importing content from the filesystem to the database. | debridav |
| DEBRIDAV_DEFAULTCATEGORIES | A comma separated list of categories to create on startup | |
| DEBRIDAV_LOCALENTITYMAXSIZEMB | The maximum allowed size in MB for locally stored files. Useful to prevent accidentally large files in the database. Set to 0 for no limit | 50 |
| DEBRIDAV_CHUNKCACHINGGRACEPERIOD | The amount of time to keep chunks in the cache as a duration string ( 2m, 4h, 2d etc) | 4h |
| DEBRIDAV_CHUNKCACHINGSIZETHRESHOLD | The maximum chunk size to cache in bytes. | 1048576 ( 1Mb ) |
| DEBRIDAV_CACHEMAXSIZE | The maximum size of the cache in gigabytes. | 2 |
| PREMIUMIZE_APIKEY | The api key for Premiumize | |
| REAL-DEBRID_APIKEY | The api key for Real Debrid | |
| EASYNEWS_USERNAME | The Easynews username | |
| EASYNEWS_PASSWORD | The Easynews password | |
| EASYNEWS_ENABLEDFORTORRENTS | If set to true, DebriDav will search for releases in Easynews matching the torrent name of torrents added via the qBittorrent API | true |
| EASYNEWS_RATELIMITWINDOWDURATION | The size of the time window to use for rate limiting. | 15 seconds |
| EASYNEWS_ALLOWEDREQUESTSINWINDOW | The number of requests allowed in the time window. eg: EASYNEWS_RATELIMITWINDOWDURATION=10s and EASYNEWS_ALLOWEDREQUESTSINWINDOW=3 will allow 3 requests per 10 seconds before forcing subsequent requests to wait. | 10 |
| EASYNEWS_CONNECTTIMEOUT | The amount of time in milliseconds to wait while establishing a connection to Easynews' servers. | 20000 |
| EASYNEWS_SOCKETTIMEOUT | The amount of time in milliseconds to wait between receiving bytes from Easynews' servers. | 5000 |
| SONARR_INTEGRATIONENABLED | Enable integration of Sonarr. | true |
| SONARR_HOST | The host of Sonarr | sonarr-debridav |
| SONARR_PORT | The port of Sonarr | 8989 |
| SONARR_API_KEY | The API key for Sonarr | |
| SONARR_CATEGORY | The qBittorrent cateogy Sonarr uses | tv-sonarr |
| RADARR_INTEGRATIONENABLED | Enable integration of Radarr. See description of SONARR_INTEGRATION_ENABLED | true |
| RADARR_HOST | The host of Radarr | radarr-debridav |
| RADARR_PORT | The port of Radarr | 7878 |
| RADARR_API_KEY | The API key for Radarr | |
| RADARR_CATEGORY | The qBittorrent cateogy Radarr uses | radarr |
A docker compose file is provided in the dev directory, with Prowlarr and rclone defined. You can add a qBittorrent
download client in prowlarr and point it to the ip obtained by running ip addr show docker0 in order to reach your
locally running DebriDav server.