Update Docs

This commit is contained in:
Mukhtar Akere
2025-06-23 11:59:26 +01:00
parent 1b98b994b7
commit 54c421a480
10 changed files with 36 additions and 9 deletions

View File

@@ -14,7 +14,7 @@ Here are the fundamental configuration options:
"discord_webhook_url": "",
"min_file_size": 0,
"max_file_size": 0,
"allowed_file_types": [".mp4", ".mkv", ".avi", ...],
"allowed_file_types": ["mp4", "mkv", "avi", ...],
}
```
@@ -55,8 +55,8 @@ When enabled, you'll need to provide a username and password to access the Decyp
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)
"min_file_size": 0,
"max_file_size": 0
```
#### Allowed File Types
@@ -64,9 +64,9 @@ You can restrict the types of files that Decypharr will process by specifying al
```json
"allowed_file_types": [
".mp4", ".mkv", ".avi", ".mov",
".m4v", ".mpg", ".mpeg", ".wmv",
".m4a", ".mp3", ".flac", ".wav"
"mp4", "mkv", "avi", "mov",
"m4v", "mpg", "mpeg", "wmv",
"m4a", "mp3", "flac", "wav"
]
```

View File

@@ -1,5 +1,7 @@
# Repair Worker
![Repair Worker](../images/repair.png)
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

View File

@@ -1,5 +1,7 @@
# WebDAV Server
![WebDAV Server](../images/webdav.png)
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.

View File

@@ -0,0 +1,22 @@
### Downloading with Decypharr
While Decypharr provides a Qbittorent API for integration with media management applications, it also allows you to manually download torrents directly through its interface. This guide will walk you through the process of downloading torrents using Decypharr.
- You can either use the Decypharr UI to add torrents manually or use its API to automate the process.
## Manual Downloading
![Downloading UI](../images/download.png)
To manually download a torrent using Decypharr, follow these steps:
1. **Access the Download Page**: Navigate to the "Download" section in the Decypharr UI.
2. You can either upload torrent file(s) or paste magnet links directly into the input fields
3. Select the action(defaults to Symlink)
5. Add any additional options, such as:
- *Download Folder*: Specify the folder where the downloaded files will be saved.
- *Arr Category*: Choose the category for the download, which helps in organizing files in your media management applications.
- **Debrid Provider**: Choose which Debrid service to use for the download(if you have multiple)
- **File Size Limits**: Set minimum and maximum file size limits if needed.
- **Allowed File Types**: Specify which file types are allowed for download.
Note:
- If you use an arr category, your download will go into **{download_folder}/{arr}**

View File

@@ -1,4 +1,5 @@
# Guides for setting up Decypharr
- [Setting up with Rclone](rclone.md)
- [Setting up with Rclone](rclone.md)
- [Manual Downloading with Decypharr](downloading.md)

View File

@@ -51,7 +51,7 @@ Create a `config.json` file in `/opt/decypharr/` with your Decypharr configurati
"folder": "/mnt/remote/realdebrid/__all__/",
"rate_limit": "250/minute",
"use_webdav": true,
"rc_url": "http://your-ip-address:5572"
"rc_url": "rclone:5572"
}
],
"qbittorrent": {

Binary file not shown.

After

Width:  |  Height:  |  Size: 218 KiB

BIN
docs/docs/images/repair.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 226 KiB

BIN
docs/docs/images/webdav.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 62 KiB

View File

@@ -52,7 +52,7 @@ services:
ports:
- "8282:8282"
volumes:
- /mnt/:/mnt # Mount your media directory
- /mnt/:/mnt:rslave # Mount your media directory
- ./config/:/app # config.json must be in this directory
- QBIT_PORT=8282 # qBittorrent Port (optional)
restart: unless-stopped