Merge branch 'experimental' into beta

2025-04-16 11:35:53 +01:00
parent 003f73c456 58fb4e6e14
commit ea79e2a6fb
96 changed files with 6096 additions and 2851 deletions
--- a/docs/docs/changelog.md
+++ b/docs/docs/changelog.md
@@ -0,0 +1,182 @@
+# Changelog
+
+## 0.6.0
+
+- Add WebDAV support for all debrid providers
+- Some refactors and code cleanup
+- Fixes
+    - Fix Alldebrid not downloading torrents
+    - Fix Alldebrid not downloading uncached torrents
+    - Fix uncached torrents not being downloaded for RealDebrid
+- Add support for multiple download API keys for debrid providers
+
+
+## 0.5.0
+
+- A more refined repair worker (with more control)
+- UI Improvements
+    - Pagination for torrents
+    - Dark mode
+    - Ordered torrents table
+- Fix Arr API flaky behavior
+- Discord Notifications
+- Minor bug fixes
+- Add Tautulli support
+    - playback_failed event triggers a repair
+- Miscellaneous improvements
+    - Add an option to skip the repair worker for a specific arr
+    - Arr specific uncached downloading option
+    - Option to download uncached torrents from UI
+- Remove QbitTorrent Log level (Use the global log level)
+
+## 0.4.2
+
+- Hotfixes
+    - Fix saving torrents error
+    - Fix bugs with the UI
+- Speed improvements
+
+## 0.4.1
+
+- Adds optional UI authentication
+- Downloaded Torrents persist on restart
+- Fixes
+    - Fix Alldebrid struggling to find the correct file
+- Minor bug fixes or speed-gains
+- A new cleanup worker to clean up ARR queues
+
+## 0.4.0
+
+- Add support for multiple debrid providers
+- A full-fledged UI for adding torrents, repairing files, viewing config and managing torrents
+- Fix issues with Alldebrid
+    - Fix file transversal bug
+    - Fix files with no parent directory
+- Logging
+    - Add a more robust logging system
+    - Add logging to a file
+    - Add logging to the UI
+- Qbittorrent
+    - Add support for tags (creating, deleting, listing)
+    - Add support for categories (creating, deleting, listing)
+    - Fix issues with arr sending torrents using a different content type
+
+## 0.3.3
+
+- Add AllDebrid Support
+- Fix Torbox not downloading uncached torrents
+- Fix Rar files being downloaded
+
+## 0.3.2
+
+- Fix DebridLink not downloading
+- Fix Torbox with uncached torrents
+- Add new /internal/cached endpoint to check if an hash is cached
+- Implement per-debrid local cache
+- Fix file check for torbox
+- Other minor bug fixes
+
+## 0.3.1
+
+- Add DebridLink Support
+- Refactor error handling
+
+## 0.3.0
+
+- Add UI for adding torrents
+- Refraction of the code
+- Fix Torbox bug
+- Update CI/CD
+- Update Readme
+
+## 0.2.7
+
+- Add support for multiple debrid providers
+- Add Torbox support
+- Add support for configurable debrid cache checks
+- Add support for configurable debrid download uncached torrents
+
+## 0.2.6
+
+- Delete torrent for empty matched files
+- Update Readme
+
+## 0.2.5
+
+- Fix ContentPath not being set prior
+- Rewrote Readme
+- Cleaned up the code
+
+## 0.2.4
+
+- Add file download support (Sequential Download)
+- Fix http handler error
+- Fix *arrs map failing concurrently
+- Fix cache not being updated
+
+## 0.2.3
+
+- Delete uncached items from RD
+- Fail if the torrent is not cached (optional)
+- Fix cache not being updated
+
+## 0.2.2
+
+- Fix name mismatch in the cache
+- Fix directory mapping with mounts
+- Add Support for refreshing the *arrs
+
+## 0.2.1
+
+- Fix Uncached torrents not being downloaded/downloaded
+- Minor bug fixed
+- Fix Race condition in the cache and file system
+
+## 0.2.0
+
+- Implement 0.2.0-beta changes
+- Removed Blackhole
+- Added QbitTorrent API
+- Cleaned up the code
+
+## 0.2.0-beta
+
+- Switch to QbitTorrent API instead of Blackhole
+- Rewrote the whole codebase
+
+## 0.1.4
+
+- Rewrote Report log
+- Fix YTS, 1337x not grabbing infohash
+- Fix Torrent symlink bug
+
+## 0.1.3
+
+- Searching for infohashes in the xml description/summary/comments
+- Added local cache support
+- Added max cache size
+- Rewrite blackhole.go
+- Bug fixes
+    - Fixed indexer getting disabled
+    - Fixed blackhole not working
+
+## 0.1.2
+
+- Bug fixes
+- Code cleanup
+- Get available hashes at once
+
+## 0.1.1
+
+- Added support for "No Blackhole" for Arrs
+- Added support for "Cached Only" for Proxy
+- Bug Fixes
+
+## 0.1.0
+
+- Initial Release
+- Added Real Debrid Support
+- Added Arrs Support
+- Added Proxy Support
+- Added Basic Authentication for Proxy
+- Added Rate Limiting for Debrid Providers
--- a/docs/docs/configuration/arrs.md
+++ b/docs/docs/configuration/arrs.md
@@ -0,0 +1,75 @@
+# Arr Applications Configuration
+
+DecyphArr can integrate directly with Sonarr, Radarr, and other Arr applications. This section explains how to configure the Arr integration in your `config.json` file.
+
+## Basic Configuration
+
+The Arr applications are configured under the `arrs` key:
+
+```json
+"arrs": [
+  {
+    "name": "sonarr",
+    "host": "http://sonarr:8989",
+    "token": "your-sonarr-api-key",
+    "cleanup": true
+  },
+  {
+    "name": "radarr",
+    "host": "http://radarr:7878",
+    "token": "your-radarr-api-key",
+    "cleanup": true
+  }
+]
+```
+
+### !!! note
+This configuration is optional if you've already set up the qBittorrent client in your Arr applications with the correct host and token information. It's particularly useful for the Repair Worker functionality.
+
+
+### Configuration Options
+Each Arr application supports the following options:
+
+- `name`: The name of the Arr application, which should match the category in qBittorrent
+- `host`: The host URL of the Arr application, including protocol and port
+- `token`: The API token/key of the Arr application
+- `cleanup`: Whether to clean up the Arr queue (removes completed downloads). This is only useful for Sonarr.
+
+### Finding Your API Key
+#### Sonarr/Radarr/Lidarr
+
+1. Go to Sonarr > Settings > General
+2. Look for "API Key" in the "Security" section
+3. Copy the API key
+
+### Multiple Arr Applications
+You can configure multiple Arr applications by adding more entries to the arrs array:
+
+```json
+"arrs": [
+  {
+    "name": "sonarr",
+    "host": "http://sonarr:8989",
+    "token": "your-sonarr-api-key",
+    "cleanup": true
+  },
+  {
+    "name": "sonarr-anime",
+    "host": "http://sonarr-anime:8989",
+    "token": "your-sonarr-anime-api-key",
+    "cleanup": true
+    },
+  {
+    "name": "radarr",
+    "host": "http://radarr:7878",
+    "token": "your-radarr-api-key",
+    "cleanup": false
+  },
+  {
+    "name": "lidarr",
+    "host": "http://lidarr:8686",
+    "token": "your-lidarr-api-key",
+    "cleanup": false
+  }
+]
+```
--- a/docs/docs/configuration/debrid.md
+++ b/docs/docs/configuration/debrid.md
@@ -0,0 +1,133 @@
+
+# Debrid Providers Configuration
+
+DecyphArr supports multiple Debrid providers. This section explains how to configure each provider in your `config.json` file.
+
+## Basic Configuration
+
+Each Debrid provider is configured in the `debrids` array:
+
+```json
+"debrids": [
+  {
+    "name": "realdebrid",
+    "host": "https://api.real-debrid.com/rest/1.0",
+    "api_key": "your-api-key",
+    "folder": "/mnt/remote/realdebrid/__all__/"
+  },
+  {
+    "name": "alldebrid",
+    "host": "https://api.alldebrid.com/v4",
+    "api_key": "your-api-key",
+    "folder": "/mnt/remote/alldebrid/downloads/"
+  }
+]
+```
+
+### Provider Options
+
+Each Debrid provider accepts the following configuration options:
+
+
+#### Basic Options
+
+- `name`: The name of the Debrid provider (realdebrid, alldebrid, debridlink, torbox)
+- `host`: The API endpoint of the Debrid provider
+- `api_key`: Your API key for the Debrid service (can be comma-separated for multiple keys)
+- `folder`: The folder where your Debrid content is mounted (via webdav, rclone, zurg, etc.)
+
+#### Advanced Options
+
+- `download_api_keys`: Array of API keys used specifically for downloading torrents (defaults to the same as api_key)
+- `rate_limit`: Rate limit for API requests (null by default)
+- `download_uncached`: Whether to download uncached torrents (disabled by default)
+- `check_cached`: Whether to check if torrents are cached (disabled by default)
+- `use_webdav`: Whether to create a WebDAV server for this Debrid provider (disabled by default)
+- `torrents_refresh_interval`: Interval for refreshing torrent data (e.g., `15s`, `1m`, `1h`).
+- `download_links_refresh_interval`: Interval for refreshing download links (e.g., `40m`, `1h`).
+- `workers`: Number of concurrent workers for processing requests.
+- folder_naming: Naming convention for folders:
+    - `original_no_ext`: Original file name without extension
+    - `original`: Original file name with extension
+    - `filename`: Torrent filename
+    - `filename_no_ext`: Torrent filename without extension
+    - `id`: Torrent ID
+- `auto_expire_links_after`: Time after which download links will expire (e.g., `3d`, `1w`).
+- `rc_url`, `rc_user`, `rc_pass`: Rclone RC configuration for VFS refreshes
+
+### Using Multiple API Keys
+For services that support it, you can provide multiple download API keys for better load balancing:
+
+```json
+{
+  "name": "realdebrid",
+  "host": "https://api.real-debrid.com/rest/1.0",
+  "api_key": "key1",
+  "download_api_keys": ["key1", "key2", "key3"],
+  "folder": "/mnt/remote/realdebrid/__all__/"
+}
+
+
+```
+
+### Example Configuration
+
+#### Real Debrid
+
+```json
+{
+  "name": "realdebrid",
+  "host": "https://api.real-debrid.com/rest/1.0",
+  "api_key": "your-api-key",
+  "folder": "/mnt/remote/realdebrid/__all__/",
+  "rate_limit": null,
+  "download_uncached": false,
+  "check_cached": true,
+  "use_webdav": true
+}
+```
+
+#### All Debrid
+
+```json
+{
+  "name": "alldebrid",
+  "host": "https://api.alldebrid.com/v4",
+  "api_key": "your-api-key",
+  "folder": "/mnt/remote/alldebrid/torrents/",
+  "rate_limit": null,
+  "download_uncached": false,
+  "check_cached": true,
+  "use_webdav": true
+}
+```
+
+#### Debrid Link
+
+```json
+{
+  "name": "debridlink",
+  "host": "https://debrid-link.com/api/v2",
+  "api_key": "your-api-key",
+  "folder": "/mnt/remote/debridlink/torrents/",
+  "rate_limit": null,
+  "download_uncached": false,
+  "check_cached": true,
+  "use_webdav": true
+}
+```
+
+#### Torbox
+
+```json
+{
+  "name": "torbox",
+  "host": "https://api.torbox.com/v1",
+  "api_key": "your-api-key",
+  "folder": "/mnt/remote/torbox/torrents/",
+  "rate_limit": null,
+  "download_uncached": false,
+  "check_cached": true,
+  "use_webdav": true
+}
+```
--- a/docs/docs/configuration/general.md
+++ b/docs/docs/configuration/general.md
@@ -0,0 +1,69 @@
+# General Configuration
+
+This section covers the basic configuration options for DecyphArr that apply to the entire application.
+
+## Basic Settings
+
+Here are the fundamental configuration options:
+
+```json
+{
+  "use_auth": false,
+  "log_level": "info",
+  "discord_webhook_url": "",
+  "min_file_size": 0,
+  "max_file_size": 0,
+  "allowed_file_types": [".mp4", ".mkv", ".avi", ...]
+}
+```
+
+### Configuration Options
+
+#### Log Level
+The `log_level` setting determines how verbose the application logs will be:
+
+- `debug`: Detailed information, useful for troubleshooting
+- `info`: General operational information (default)
+- `warn`: Warning messages
+- `error`: Error messages only
+- `trace`: Very detailed information, including all requests and responses
+
+
+#### Authentication
+The `use_auth` option enables basic authentication for the UI:
+
+```json
+"use_auth": true
+```
+
+When enabled, you'll need to provide a username and password to access the DecyphArr interface.
+
+
+#### File Size Limits
+
+You can set minimum and maximum file size limits for torrents:
+```json
+"min_file_size": 0,  // Minimum file size in bytes (0 = no minimum)
+"max_file_size": 0   // Maximum file size in bytes (0 = no maximum)
+```
+
+#### Allowed File Types
+You can restrict the types of files that DecyphArr will process by specifying allowed file extensions. This is useful for filtering out unwanted file types.
+
+```json
+"allowed_file_types": [
+  ".mp4", ".mkv", ".avi", ".mov",
+  ".m4v", ".mpg", ".mpeg", ".wmv",
+  ".m4a", ".mp3", ".flac", ".wav"
+]
+```
+
+If not specified, all movie, TV show, and music file types are allowed by default.
+
+
+#### Discord Notifications
+To receive notifications on Discord, add your webhook URL:
+```json
+"discord_webhook_url": "https://discord.com/api/webhooks/..."
+```
+This will send notifications for various events, such as successful downloads or errors.
--- a/docs/docs/configuration/index.md
+++ b/docs/docs/configuration/index.md
@@ -0,0 +1,45 @@
+# Configuration Overview
+
+DecyphArr uses a JSON configuration file to manage its settings. This file should be named `config.json` and placed in your configured directory.
+
+## Basic Configuration
+
+Here's a minimal configuration to get started:
+
+```json
+{
+  "debrids": [
+    {
+      "name": "realdebrid",
+      "host": "https://api.real-debrid.com/rest/1.0",
+      "api_key": "realdebrid_key",
+      "folder": "/mnt/remote/realdebrid/__all__/",
+      "use_webdav": true
+    }
+  ],
+  "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"
+}
+```
+
+### Configuration Sections
+
+DecyphArr's configuration is divided into several sections:
+
+- [General Configuration](general.md) - Basic settings like logging and authentication
+- [Debrid Providers](debrid.md) - Configure one or more Debrid services
+- [qBittorrent Settings](qbittorrent.md) - Settings for the qBittorrent API
+- [Arr Integration](arrs.md) - Configuration for Sonarr, Radarr, etc.
+
+Full Configuration Example
+For a complete configuration file with all available options, see our [full configuration example](../extras/config.full.json).
--- a/docs/docs/configuration/qbittorrent.md
+++ b/docs/docs/configuration/qbittorrent.md
@@ -0,0 +1,74 @@
+# qBittorrent Configuration
+
+DecyphArr emulates a qBittorrent instance to integrate with Arr applications. This section explains how to configure the qBittorrent settings in your `config.json` file.
+
+## Basic Configuration
+
+The qBittorrent functionality is configured under the `qbittorrent` key:
+
+```json
+"qbittorrent": {
+  "port": "8282",
+  "download_folder": "/mnt/symlinks/",
+  "categories": ["sonarr", "radarr", "lidarr"],
+  "refresh_interval": 5
+}
+```
+
+### Configuration Options
+#### Essential Settings
+
+- `port`: The port on which the qBittorrent API will listen (default: 8282)
+- `download_folder`: The folder where symlinks or downloaded files will be placed
+- `categories`: An array of categories to organize downloads (usually matches your Arr applications)
+
+#### Advanced Settings
+
+- `refresh_interval`: How often (in seconds) to refresh the Arrs Monitored Downloads (default: 5)
+
+#### Categories
+Categories help organize your downloads and match them to specific Arr applications. Typically, you'll want to configure categories that match your Sonarr, Radarr, or other Arr applications:
+
+```json
+"categories": ["sonarr", "radarr", "lidarr", "readarr"]
+```
+
+When setting up your Arr applications to connect to DecyphArr, you'll specify these same category names.
+
+#### Download Folder
+
+The `download_folder` setting specifies where DecyphArr will place downloaded files or create symlinks:
+
+```json
+"download_folder": "/mnt/symlinks/"
+```
+
+This folder should be:
+
+- Accessible to DecyphArr
+- Accessible to your Arr applications
+- Have sufficient space if downloading files locally
+
+
+#### Port Configuration
+The `port` setting determines which port the qBittorrent API will listen on:
+
+```json
+"port": "8282"
+```
+
+Ensure this port:
+
+- Is not used by other applications
+- Is accessible to your Arr applications
+- Is properly exposed if using Docker (see the Docker Compose example in the Installation guide)
+
+#### Refresh Interval
+The refresh_interval setting controls how often DecyphArr checks for updates from your Arr applications:
+
+```json
+"refresh_interval": 5
+```
+
+
+This value is in seconds. Lower values provide more responsive updates but may increase CPU usage.
--- a/docs/docs/extras/config.full.json
+++ b/docs/docs/extras/config.full.json
@@ -0,0 +1,96 @@
+{
+  "debrids": [
+    {
+      "name": "realdebrid",
+      "host": "https://api.real-debrid.com/rest/1.0",
+      "api_key": "realdebrid_key",
+      "folder": "/mnt/remote/realdebrid/__all__/",
+      "download_api_keys": [],
+      "proxy": "",
+      "rate_limit": "250/minute",
+      "download_uncached": false,
+      "check_cached": false,
+      "use_webdav": true,
+      "torrents_refresh_interval": "15s",
+      "folder_naming": "original_no_ext",
+      "auto_expire_links_after": "3d",
+      "rc_url": "http://your-ip-address:9990",
+      "rc_user": "your_rclone_rc_user",
+      "rc_pass": "your_rclone_rc_pass"
+    },
+    {
+      "name": "torbox",
+      "host": "https://api.torbox.app/v1",
+      "api_key": "torbox_api_key",
+      "folder": "/mnt/remote/torbox/torrents/",
+      "rate_limit": "250/minute",
+      "download_uncached": false,
+      "check_cached": true
+    },
+    {
+      "name": "debridlink",
+      "host": "https://debrid-link.com/api/v2",
+      "api_key": "debridlink_key",
+      "folder": "/mnt/remote/debridlink/torrents/",
+      "rate_limit": "250/minute",
+      "download_uncached": false,
+      "check_cached": false
+    },
+    {
+      "name": "alldebrid",
+      "host": "http://api.alldebrid.com/v4.1",
+      "api_key": "alldebrid_key",
+      "folder": "/mnt/remote/alldebrid/magnet/",
+      "rate_limit": "600/minute",
+      "download_uncached": false,
+      "check_cached": false
+    }
+  ],
+  "max_cache_size": 1000,
+  "qbittorrent": {
+    "port": "8282",
+    "download_folder": "/mnt/symlinks/",
+    "categories": ["sonarr", "radarr"],
+    "refresh_interval": 5,
+    "skip_pre_cache": false
+  },
+  "arrs": [
+    {
+      "name": "sonarr",
+      "host": "http://sonarr:8989",
+      "token": "arr_key",
+      "cleanup": true,
+      "skip_repair": true,
+      "download_uncached": false
+    },
+    {
+      "name": "radarr",
+      "host": "http://radarr:7878",
+      "token": "arr_key",
+      "cleanup": false,
+      "download_uncached": false
+    },
+    {
+      "name": "lidarr",
+      "host": "http://lidarr:8686",
+      "token": "arr_key",
+      "cleanup": false,
+      "skip_repair": true,
+      "download_uncached": false
+    }
+  ],
+  "repair": {
+    "enabled": false,
+    "interval": "12h",
+    "run_on_start": false,
+    "zurg_url": "",
+    "use_webdav": false,
+    "auto_process": false
+  },
+  "log_level": "info",
+  "min_file_size": "",
+  "max_file_size": "",
+  "allowed_file_types": [],
+  "use_auth": false,
+  "discord_webhook_url": "https://discord.com/api/webhooks/..."
+}
--- a/docs/docs/extras/rclone.conf
+++ b/docs/docs/extras/rclone.conf
@@ -0,0 +1,5 @@
+[decypharr]
+type = webdav
+url = http://decypharr:8282/webdav/realdebrid
+vendor = other
+pacer_min_sleep = 0
--- a/docs/docs/features/index.md
+++ b/docs/docs/features/index.md
@@ -0,0 +1,40 @@
+# Features Overview
+
+DecyphArr extends the functionality of qBittorrent by integrating with Debrid services, providing several powerful features that enhance your media management experience.
+
+## Core Features
+
+### Mock qBittorrent API
+
+DecyphArr implements a complete qBittorrent-compatible API that can be used with Sonarr, Radarr, Lidarr, and other Arr applications. This allows you to:
+
+- Seamlessly integrate with your existing Arr setup
+- Use familiar interfaces to manage your downloads
+- Benefit from Debrid services without changing your workflow
+
+### Comprehensive UI
+
+The DecyphArr user interface provides:
+
+- Torrent management capabilities
+- Status monitoring
+- Configuration options
+- Multiple Debrid provider integration
+
+## Advanced Features
+
+DecyphArr includes several advanced features that extend its capabilities:
+
+- [Repair Worker](repair-worker.md): Identifies and fixes issues with your media files
+- [WebDAV Server](webdav.md): Provides direct access to your Debrid files
+
+## Supported Debrid Providers
+
+DecyphArr supports multiple Debrid providers:
+
+- Real Debrid
+- Torbox
+- Debrid Link
+- All Debrid
+
+Each provider can be configured separately, allowing you to use one or multiple services simultaneously.
--- a/docs/docs/features/repair-worker.md
+++ b/docs/docs/features/repair-worker.md
@@ -0,0 +1,41 @@
+# Repair Worker
+
+The Repair Worker is a powerful feature that helps maintain the health of your media library by scanning for and fixing issues with files.
+
+## What It Does
+
+The Repair Worker performs the following tasks:
+
+- Searches for broken symlinks or file references
+- Identifies missing files in your library
+- Locates deleted or unreadable files
+- Automatically repairs issues when possible
+
+## Configuration
+
+To enable and configure the Repair Worker, add the following to your `config.json`:
+
+```json
+"repair": {
+  "enabled": true,
+  "interval": "12h",
+  "run_on_start": false,
+  "use_webdav": false,
+  "zurg_url": "http://localhost:9999",
+  "auto_process": true
+}
+```
+
+### Configuration Options
+
+- `enabled`: Set to `true` to enable the Repair Worker.
+- `interval`: The time interval for the Repair Worker to run (e.g., `12h`, `1d`).
+- `run_on_start`: If set to `true`, the Repair Worker will run immediately after DecyphArr starts.
+- `use_webdav`: If set to `true`, the Repair Worker will use WebDAV for file operations.
+- `zurg_url`: The URL for the Zurg service (if using).
+- `auto_process`: If set to `true`, the Repair Worker will automatically process files that it finds issues with.
+
+
+### Performance Tips
+- For users of the WebDAV server, enable `use_webdav` for exponentially faster repair processes
+- If using Zurg, set the `zurg_url` parameter to greatly improve repair speed
--- a/docs/docs/features/webdav.md
+++ b/docs/docs/features/webdav.md
@@ -0,0 +1,60 @@
+# WebDAV Server
+
+DecyphArr includes a built-in WebDAV server that provides direct access to your Debrid files, making them easily accessible to media players and other applications.
+
+## Overview
+
+While most Debrid providers have their own WebDAV servers, DecyphArr's implementation offers faster access and additional features. The WebDAV server listens on port `8080` by default.
+
+## Accessing the WebDAV Server
+
+- URL: `http://localhost:8282/webdav` or `http://<your-server-ip>:8080/webdav`
+
+## Configuration
+
+You can configure WebDAV settings either globally or per-Debrid provider in your `config.json`:
+
+```json
+"webdav": {
+  "torrents_refresh_interval": "15s",
+  "download_links_refresh_interval": "40m",
+  "folder_naming": "original_no_ext",
+  "auto_expire_links_after": "3d",
+  "rc_url": "http://localhost:5572",
+  "rc_user": "username",
+  "rc_pass": "password"
+}
+```
+
+### Configuration Options
+
+- `torrents_refresh_interval`: Interval for refreshing torrent data (e.g., `15s`, `1m`, `1h`).
+- `download_links_refresh_interval`: Interval for refreshing download links (e.g., `40m`, `1h`).
+- `workers`: Number of concurrent workers for processing requests.
+- folder_naming: Naming convention for folders:
+  - `original_no_ext`: Original file name without extension
+  - `original`: Original file name with extension
+  - `filename`: Torrent filename
+  - `filename_no_ext`: Torrent filename without extension
+  - `id`: Torrent ID
+- `auto_expire_links_after`: Time after which download links will expire (e.g., `3d`, `1w`).
+- `rc_url`, `rc_user`, `rc_pass`: Rclone RC configuration for VFS refreshes
+
+### Using with Media Players
+The WebDAV server works well with media players like:
+
+- Infuse
+- VidHub
+- Plex (via mounting)
+- Kodi
+
+### Mounting with Rclone
+You can mount the WebDAV server locally using Rclone. Example configuration:
+
+```conf
+[decypharr]
+type = webdav
+url = http://localhost:8282/webdav/realdebrid
+vendor = other
+```
+For a complete Rclone configuration example, see our [sample rclone.conf](../extras/rclone.conf).
--- a/docs/docs/images/logo.png
+++ b/docs/docs/images/logo.png
--- a/docs/docs/images/main.png
+++ b/docs/docs/images/main.png
--- a/docs/docs/images/sonarr-setup.png
+++ b/docs/docs/images/sonarr-setup.png
--- a/docs/docs/index.md
+++ b/docs/docs/index.md
@@ -0,0 +1,28 @@
+# DecyphArr
+
+![DecyphArr UI](images/main.png)
+
+**DecyphArr** is an implementation of QbitTorrent with **Multiple Debrid service support**, written in Go.
+
+## What is DecyphArr?
+
+DecyphArr combines the power of QBittorrent with popular Debrid services to enhance your media management. It provides a familiar interface for Sonarr, Radarr, and other \*Arr applications while leveraging the capabilities of Debrid providers.
+
+## Key Features
+
+- 🔄 Mock Qbittorent API that supports Sonarr, Radarr, Lidarr and other Arr applications
+- 🖥️ Full-fledged UI for managing torrents
+- 🔌 Multiple Debrid providers support
+- 📁 WebDAV server support for each Debrid provider
+- 🔧 Repair Worker for missing files
+
+## Supported Debrid Providers
+
+- [Real Debrid](https://real-debrid.com)
+- [Torbox](https://torbox.app)
+- [Debrid Link](https://debrid-link.com)
+- [All Debrid](https://alldebrid.com)
+
+## Getting Started
+
+Check out our [Installation Guide](installation.md) to get started with DecyphArr.
--- a/docs/docs/installation.md
+++ b/docs/docs/installation.md
@@ -0,0 +1,71 @@
+# Installation
+
+There are multiple ways to install and run DecyphArr. Choose the method that works best for your setup.
+
+## Docker Installation (Recommended)
+
+Docker is the easiest way to get started with DecyphArr.
+
+### Available Docker Registries
+
+You can use either Docker Hub or GitHub Container Registry to pull the image:
+
+- Docker Hub: `cy01/blackhole:latest`
+- GitHub Container Registry: `ghcr.io/sirrobot01/decypharr:latest`
+
+### Docker 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 (usually unstable)
+- `experimental`: The latest experimental build (highly unstable)
+
+### Docker Compose Setup
+
+Create a `docker-compose.yml` file with the following content:
+
+```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
+      - ./configs/:/app # config.json must be in this directory
+    environment:
+      - PUID=1000
+      - PGID=1000
+      - UMASK=002
+      - QBIT_PORT=8282 # qBittorrent Port (optional)
+      - PORT=8181 # Proxy Port (optional)
+    restart: unless-stopped
+    depends_on:
+      - rclone # If you are using rclone with docker
+
+
+```
+
+Run the Docker Compose setup:
+```bash
+docker-compose up -d
+```
+
+
+## Binary Installation
+If you prefer not to use Docker, you can download and run the binary directly.
+
+Download the binary from the releases page
+Create a configuration file (see Configuration)
+Run the binary:
+```bash
+chmod +x decypharr
+./decypharr --config /path/to/config
+```
+
+The config directory should contain your config.json file.
--- a/docs/docs/usage.md
+++ b/docs/docs/usage.md
@@ -0,0 +1,39 @@
+# Usage Guide
+
+This guide will help you get started with DecyphArr after installation.
+
+## Basic Setup
+
+1. Create your `config.json` file (see [Configuration](configuration/index.md) for details)
+2. Start the DecyphArr service using Docker or binary
+3. Access the UI at `http://localhost:8282` (or your configured host/port)
+4. Connect your Arr applications (Sonarr, Radarr, etc.)
+
+## Connecting to Sonarr/Radarr
+
+To connect DecyphArr to your Sonarr or Radarr instance:
+
+1. In Sonarr/Radarr, go to **Settings → Download Client → Add Client → qBittorrent**
+2. Configure the following settings:
+   - **Host**: `localhost` (or the IP of your DecyphArr server)
+   - **Port**: `8282` (or your configured qBittorrent port)
+   - **Username**: `http://sonarr:8989` (your Arr host with http/https)
+   - **Password**: `sonarr_token` (your Arr API token)
+   - **Category**: e.g., `sonarr`, `radarr` (match what you configured in DecyphArr)
+   - **Use SSL**: `No`
+   - **Sequential Download**: `No` or `Yes` (if you want to download torrents locally instead of symlink)
+3. Click **Test** to verify the connection
+4. Click **Save** to add the download client
+
+![Sonarr/Radarr Setup](images/sonarr-setup.png)
+
+## Using the UI
+
+The DecyphArr UI provides a familiar qBittorrent-like interface with additional features for Debrid services:
+
+- View and manage all your torrents
+- Monitor download status
+- Check cache status across different Debrid providers
+- Access WebDAV functionality
+
+Access the UI at `http://localhost:8282` or your configured host/port.
--- a/docs/mkdocs.yml
+++ b/docs/mkdocs.yml
@@ -0,0 +1,77 @@
+site_name: Decypharr
+site_url: https://sirrobot01.github.io/decypharr
+site_description: QbitTorrent with Debrid Support
+repo_url: https://github.com/sirrobot01/decypharr
+repo_name: sirrobot01/decypharr
+edit_uri: blob/main/docs
+
+
+theme:
+  name: material
+  logo: images/logo.png
+  font:
+    text: Roboto
+    code: Roboto Mono
+  palette:
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      primary: indigo
+      accent: indigo
+      toggle:
+        icon: material/weather-night
+        name: Switch to dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      primary: indigo
+      accent: indigo
+      toggle:
+        icon: material/weather-sunny
+        name: Switch to light mode
+  features:
+    - navigation.search.highlight
+    - navigation.search.suggest
+    - navigation.search.share
+    - navigation.search.suggest
+    - navigation.search.share
+    - navigation.search.highlight
+    - navigation.search.suggest
+    - navigation.search.share
+  icon:
+    repo: fontawesome/brands/github
+
+markdown_extensions:
+  - admonition
+  - pymdownx.details
+  - pymdownx.superfences
+  - pymdownx.highlight
+  - pymdownx.inlinehilite
+  - pymdownx.tabbed
+  - pymdownx.emoji:
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:materialx.emoji.to_svg
+  - attr_list
+  - md_in_html
+  - def_list
+  - toc:
+      permalink: true
+
+nav:
+  - Home: index.md
+  - Installation: installation.md
+  - Usage: usage.md
+  - Configuration:
+      - Overview: configuration/index.md
+      - General: configuration/general.md
+      - Debrid Providers: configuration/debrid.md
+      - qBittorrent: configuration/qbittorrent.md
+      - Arr Integration: configuration/arrs.md
+  - Features:
+      - Overview: features/index.md
+      - Repair Worker: features/repair-worker.md
+      - WebDAV: features/webdav.md
+  - Changelog: changelog.md
+
+
+plugins:
+  - search
+  - tags