Skip to content

Commit 54c421a

Browse files
committed
Update Docs
1 parent 1b98b99 commit 54c421a

File tree

10 files changed

+36
-9
lines changed

10 files changed

+36
-9
lines changed

docs/docs/configuration/general.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Here are the fundamental configuration options:
1414
"discord_webhook_url": "",
1515
"min_file_size": 0,
1616
"max_file_size": 0,
17-
"allowed_file_types": [".mp4", ".mkv", ".avi", ...],
17+
"allowed_file_types": ["mp4", "mkv", "avi", ...],
1818

1919
}
2020
```
@@ -55,18 +55,18 @@ When enabled, you'll need to provide a username and password to access the Decyp
5555

5656
You can set minimum and maximum file size limits for torrents:
5757
```json
58-
"min_file_size": 0, // Minimum file size in bytes (0 = no minimum)
59-
"max_file_size": 0 // Maximum file size in bytes (0 = no maximum)
58+
"min_file_size": 0,
59+
"max_file_size": 0
6060
```
6161

6262
#### Allowed File Types
6363
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.
6464

6565
```json
6666
"allowed_file_types": [
67-
".mp4", ".mkv", ".avi", ".mov",
68-
".m4v", ".mpg", ".mpeg", ".wmv",
69-
".m4a", ".mp3", ".flac", ".wav"
67+
"mp4", "mkv", "avi", "mov",
68+
"m4v", "mpg", "mpeg", "wmv",
69+
"m4a", "mp3", "flac", "wav"
7070
]
7171
```
7272

docs/docs/features/repair-worker.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Repair Worker
22

3+
![Repair Worker](../images/repair.png)
4+
35
The Repair Worker is a powerful feature that helps maintain the health of your media library by scanning for and fixing issues with files.
46

57
## What It Does

docs/docs/features/webdav.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# WebDAV Server
22

3+
![WebDAV Server](../images/webdav.png)
4+
35
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.
46

57

docs/docs/guides/downloading.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
### Downloading with Decypharr
2+
3+
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.
4+
5+
- You can either use the Decypharr UI to add torrents manually or use its API to automate the process.
6+
7+
## Manual Downloading
8+
9+
![Downloading UI](../images/download.png)
10+
To manually download a torrent using Decypharr, follow these steps:
11+
1. **Access the Download Page**: Navigate to the "Download" section in the Decypharr UI.
12+
2. You can either upload torrent file(s) or paste magnet links directly into the input fields
13+
3. Select the action(defaults to Symlink)
14+
5. Add any additional options, such as:
15+
- *Download Folder*: Specify the folder where the downloaded files will be saved.
16+
- *Arr Category*: Choose the category for the download, which helps in organizing files in your media management applications.
17+
- **Debrid Provider**: Choose which Debrid service to use for the download(if you have multiple)
18+
- **File Size Limits**: Set minimum and maximum file size limits if needed.
19+
- **Allowed File Types**: Specify which file types are allowed for download.
20+
21+
Note:
22+
- If you use an arr category, your download will go into **{download_folder}/{arr}**

docs/docs/guides/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# Guides for setting up Decypharr
22

33

4-
- [Setting up with Rclone](rclone.md)
4+
- [Setting up with Rclone](rclone.md)
5+
- [Manual Downloading with Decypharr](downloading.md)

docs/docs/guides/rclone.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Create a `config.json` file in `/opt/decypharr/` with your Decypharr configurati
5151
"folder": "/mnt/remote/realdebrid/__all__/",
5252
"rate_limit": "250/minute",
5353
"use_webdav": true,
54-
"rc_url": "http://your-ip-address:5572"
54+
"rc_url": "rclone:5572"
5555
}
5656
],
5757
"qbittorrent": {

docs/docs/images/download.png

218 KB
Loading

docs/docs/images/repair.png

226 KB
Loading

docs/docs/images/webdav.png

61.7 KB
Loading

docs/docs/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ services:
5252
ports:
5353
- "8282:8282"
5454
volumes:
55-
- /mnt/:/mnt # Mount your media directory
55+
- /mnt/:/mnt:rslave # Mount your media directory
5656
- ./config/:/app # config.json must be in this directory
5757
- QBIT_PORT=8282 # qBittorrent Port (optional)
5858
restart: unless-stopped

0 commit comments

Comments
 (0)