Alldebrid-watcher is an open-source application that allows for automatic downloading of torrent files using AllDebrid services. The application is divided into 4 configurable services: Watcher, Debrider, Downloader, and Notifier.
Important Information
If you are using a version older than 2.0.0, please refer to the old documentation
The application is divided into 5 parts:
- AppKernel
- Watchers
- Debrider(s) (other debriders may come later)
- Downloaders
- Notifiers
Enables the operation of the application by calling different services
Monitors torrent files or magnets to be downloaded.
Available Watchers:
- FileSystem: Monitors a folder and downloads a torrent as soon as a file is dropped.
- Coming soon
Only one watcher can be used at a time
Transforms a torrent or magnet file into a direct link
Available Debriders:
- Alldebrid
- May come in the future
Only one debrider can be used at a time
Downloads a file transformed by the debrider
Available Downloaders:
- FileSystem: Uses node JS to download the file locally
- QNAP Download Station: Use unofficial API for QNAP Download Station
Only one downloader can be used at a time
Notifies the user of actions taken. It is possible to select which actions you want to be informed of.
Possible notification types:
- A torrent or magnet file was found
- A torrent or magnet file was debridled
- The download of a file has begun
- Download progress (x% downloaded)
- The download is finished
- The download encountered an error
Available Notifiers:
- Stdout: Log event in standard out
- Pushover: Sends notifications using the Pushover service
- Webhook: Sends POST HTTP request on event
- Coming soon
Multiple notifiers can be used at the same time
Each notifier can inform of different actions (example: Stdout => verbose mode + Pushover => Downloads started, Downloads finished)
- A valid AllDebrid account with an API key
- Node.js
- npm or yarn
Clone the Github repository on your machine using the following command:
git clone https://github.com/vlacour97/alldebrid-watcher.gitInstall the dependencies using npm or yarn:
npm install ts-node -g
npm install or
yarn install ts-node -g
yarn install Each service can be configured independently using environment variables
Launch the application using npm or yarn:
ALLDEBRID_TOKEN=allbredid-token TORRENT_FOLDER=path/to/torrents DOWNLOAD_FOLDER=path/to/downloads npm run startor
ALLDEBRID_TOKEN=allbredid-token TORRENT_FOLDER=path/to/torrents DOWNLOAD_FOLDER=path/to/downloads yarn start- A valid AllDebrid account with an API key
- Docker
Each service can be configured independently using environment variables
docker run -v path/tot/torrent:/torrents -v path/to/download:/downloads -e ALLDEBRID_TOKEN=allbredid-token vlacour97/alldebrid-watcherThe options used in this command are:
-e ALLDEBRID_TOKEN: sets the environment variable for your AllDebrid token-v <path/to/torrents>:/app/torrents: binds the local folder containing the torrent files to the folder in the container where the application will look for torrent files-v <path/to/downloads>:/app/downloads: binds the local folder where downloaded files will be saved to the folder in the container where the application will save downloaded files
| Environment Variable | Required ? | Default value | Description |
|---|---|---|---|
| TORRENT_FOLDER | No | /torrents | Path to the folder containing the torrent files |
| REMOVE_TORRENT_AFTER_DOWNLOAD | No | false | Determine if torrent must be removed after download |
| Environment Variable | Required ? | Default value | Description |
|---|---|---|---|
| ALLDEBRID_TOKEN | Yes | AllDebrid API key | |
| AUTHORIZED_EXTENSIONS | No | null | List of authorized extensions for download separated by a comma (example: avi,mkv,..) |
| CLEAN_MAGNETS_AFTER_DOWNLOAD | No | false | Determine if torrent or magnet must be deleted from alldebrid |
| Environment Variable | Required ? | Default value | Available values | Description |
|---|---|---|---|---|
| DOWNLOADER_SERVICE | No | filesystem | filesystem, qnap_download_station | Choice of the download service |
| Environment Variable | Required ? | Default value | Description |
|---|---|---|---|
| DOWNLOAD_FOLDER | No | /downloads | Path to the folder where the files are downloaded |
| MAX_PARALLELS_DOWNLOADS | No | 5 | Number of parallel downloads |
| Environment Variable | Required ? | Default value | Description |
|---|---|---|---|
| QNAP_ENDPOINT | Yes | Url of QNAP server. eg: http://localhost:8080 | |
| QNAP_USERNAME | Yes | admin | Username of QNAP user |
| QNAP_PASSWORD | Yes | password | Password of QNAP user |
| TEMPORARY_FOLDER | Yes | Temporary folder use by download station | |
| DOWNLOAD_FOLDER | Yes | Download destination folder use by download station | |
| QNAP_SESSION_TIMEOUT | No | 1200 (20 min.) | Max timeout in seconds of QNAP user session |
| Environment Variable | Required ? | Default value | Available values | Description |
|---|---|---|---|---|
| NOTIFIER_SERVICES | No | stdout | stdout, pushover,webhook | Choice of notification services separated by a comma |
| NOTIFIER_SERVICES_CONFIG | No | {} | Keys: stdout, pushover Values: 'all' or an array with the values specified in the table below |
Choice of which actions should be notified on which service in JSON Example: {"stdout": "all", "pushover": ["download_start", "download_done"]} |
| Valeur | Description |
|---|---|
| watch | A torrent or magnet file was found |
| debrid | A torrent or magnet file was debrid |
| download_start | The download of a file has begun |
| download_progress | Download progress (x% downloaded) |
| download_done | The download is complete |
| torrent_done | The torrent's download is complete |
| download_error | The download encounters an error |
| torrent_error | The torrent's download encounters an error |
No configuration possible
Action
download_progresswas not supported by pushover notifier.
| Environment Variable | Required ? | Default value | Description |
|---|---|---|---|
| PUSHOVER_USER_TOKEN | Yes | Pushover User Token. Set PUSHOVER_USER_TOKEN and PUSHOVER_APP_TOKEN to use pushover app to be notified when download was finish | |
| PUSHOVER_APP_TOKEN | Yes | Pushover App Token. Set PUSHOVER_USER_TOKEN and PUSHOVER_APP_TOKEN to use pushover app to be notified when download was finish |
Action
download_progresswas not supported by webhook notifier.
| Environment Variable | Required ? | Default value | Description |
|---|---|---|---|
| WEBHOOK_ENDPOINT | Yes | URL of webhook endpoint. POST request was sended when notify |
Alldebrid-watcher is licensed under the MIT
The project is open to contributions from the community.
Whether you're a beginner or an experienced developer, feel free to submit pull requests with bug fixes, new features, and improvements to the code. Your contributions will be greatly appreciated and will help make this project even better. If you have any questions or suggestions, please don't hesitate to reach out to us.