FonduemangVI
2 months ago
committed by
GitHub
commit
3c2ae2107e
@ -1,93 +0,0 @@
|
||||
# Contributing Guidelines
|
||||
|
||||
👍🎉 First off, thanks for taking the time to contribute! 🎉👍
|
||||
|
||||
Here you will find a set of guidelines for contributing to TRaSH Guides, Which you can find [HERE](https://trash-guides.info/),
|
||||
These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
|
||||
|
||||
## Guidelines
|
||||
|
||||
- Make sure you're editing the latest version.
|
||||
- If you propose changes make sure it doesn't break anything else in the Guides.
|
||||
- Make sure that after the changes you don't get any [markdownlint](https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md) errors
|
||||
- If the `metadata.json` and `metadata.schema.json` needs changes, announce it first in the Discord `#development` channel and ping`voidpointer` and `nitsua` so the 3rd party apps don't break :bangbang:
|
||||
|
||||
## Branch naming
|
||||
|
||||
We're trying to be as consistent as possible for automation of the changelog.
|
||||
|
||||
- **feat/xxx** Commits, that adds a new feature
|
||||
- **fix/xxx** Commits, that fixes a bug/issue
|
||||
- **style/xxx** Commits, that do not affect the meaning (white-space, formatting, missing semi-colons, etc)
|
||||
- **chore/xxx** Miscellaneous commits (administrative / cleanup / backend)
|
||||
|
||||
Where 'xxx' can stand for Starr/Sonarr/Radarr/Guide etc
|
||||
|
||||
*Examples:*
|
||||
`feat/Starr-ELEANOR-to-Scene-CF`
|
||||
`feat/Radarr-CiNEPHiLES-to-Remux-Tier-02`
|
||||
`feat/maintenance`
|
||||
`fix/dv-hdr10-cf-should-match-dv-hdr10+`
|
||||
|
||||
[Source](https://gist.github.com/qoomon/5dfcdf8eec66a051ecd85625518cfd13#types){:target="_blank" rel="noopener noreferrer"}
|
||||
|
||||
## Pull Request naming
|
||||
|
||||
We're trying to be as consistent as possible for automation of the changelog.
|
||||
|
||||
- **feat(xxx):** Commits, that adds a new feature
|
||||
- **fix(xxx):** Commits, that fixes a bug/issue
|
||||
- **style(xxx):** Commits, that do not affect the meaning (white-space, formatting, missing semi-colons, etc)
|
||||
- **chore(xxx):** Miscellaneous commits (administrative / cleanup / backend)
|
||||
|
||||
Where 'xxx' can stand for Starr/Sonarr/Radarr/Guide etc
|
||||
|
||||
*Examples:*
|
||||
`feat(starr): add ELEANOR to Scene CF`
|
||||
`feat(radarr): add CiNEPHiLES to Remux Tier 02`
|
||||
`feat(maintenance): various changes to the Starr CFs`
|
||||
`fix(starr): DV HDR10 CF should match DV HDR10+`
|
||||
|
||||
[Source](https://gist.github.com/qoomon/5dfcdf8eec66a051ecd85625518cfd13#types){:target="_blank" rel="noopener noreferrer"}
|
||||
|
||||
## When doing a PR that is WIP
|
||||
|
||||
When doing a PR that is in-progress and not yet complete / ready for review or not yet done fully, please ensure it is a **DRAFT Pull Request**
|
||||
|
||||
## Radarr/Sonarr Custom Format (JSON)
|
||||
|
||||
- Custom Format name needs to match json name :bangbang:
|
||||
- No hashcode can exists multiple times :bangbang:
|
||||
- JSON file names are always written in small letters, spaces are replaced by a dash, no spaces or special characters except a dash :bangbang:
|
||||
- When adding the hashcode for Radarr use the following naming `CF_name` on the following [link+example](https://md5.gromweb.com/?string=BR-DISK){:target="_blank" rel="noopener noreferrer"}.
|
||||
- When adding the hashcode for Radarr Anime use the following naming `Radarr Anime CF_name` on the following [link+example](https://md5.gromweb.com/?string=Radarr+Anime+BR-DISK){:target="_blank" rel="noopener noreferrer"}.
|
||||
- When adding the hashcode for Sonarr use the following naming `Sonarr CF_name` on the following [link+example](https://md5.gromweb.com/?string=Sonarr+BR-DISK){:target="_blank" rel="noopener noreferrer"}.
|
||||
- When adding the hashcode for Sonarr Anime use the following naming `Sonarr Anime CF_name` on the following [link+example](https://md5.gromweb.com/?string=Sonarr+Anime+BR-DISK){:target="_blank" rel="noopener noreferrer"}.
|
||||
- Provide a link to your regex example of your Custom Format using the following [Template](https://regex101.com/r/4DypIW/1){:target="_blank" rel="noopener noreferrer"}.
|
||||
- When adding a RlsGrp to a Custom Format for whatever reason, please add in the PR why it's added/removed/moved.
|
||||
|
||||
When adding a regex test case
|
||||
|
||||
- Replace the actual movie name with `Movie`.
|
||||
- Replace the actual series name with `Series`.
|
||||
- Remove the actual Series title.
|
||||
- Replace the actual group name with `RlsGrp`
|
||||
|
||||
When updating or adding a new CF the test case url needs to be added to the json.
|
||||
|
||||
```json
|
||||
{
|
||||
"trash_id": "hashcode",
|
||||
"trash_score": "score",
|
||||
"trash_regex": "https://regex101.com/r/pADWJD/5",
|
||||
"name": "CF_name",
|
||||
```
|
||||
|
||||
## YAML file naming
|
||||
|
||||
- If a hashcode is needed **No** hashcode can exist multiple times :bangbang:
|
||||
- YAML file names are always written in small letters, spaces are replaced by a dash, no spaces or special characters except a dash :bangbang:
|
||||
|
||||
## Recommendations
|
||||
|
||||
- use [VSCode](https://code.visualstudio.com/){:target="_blank" rel="noopener noreferrer"} for editing with the following extension [markdownlint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint){:target="_blank" rel="noopener noreferrer"}
|
||||
@ -1,47 +1,39 @@
|
||||
"Area: Backend":
|
||||
- all:
|
||||
- "docs/**/*.md"
|
||||
- "!docs/bazarr/**"
|
||||
- "!docs/downloaders/**"
|
||||
- "!docs/plex/**"
|
||||
- "!docs/prowlarr/**"
|
||||
- "!docs/radarr/**"
|
||||
- "!docs/recyclarr-configs/**"
|
||||
- "!docs/sonarr/**"
|
||||
"Area: Bazarr":
|
||||
- docs/bazarr/**
|
||||
- changed-files:
|
||||
- any-glob-to-any-file: ['docs/Bazarr/**']
|
||||
"Area: Dependencies":
|
||||
- package.json
|
||||
- package-lock.json
|
||||
- changed-files:
|
||||
- any-glob-to-any-file: ['package.json', 'package-lock.json']
|
||||
"Area: Downloaders":
|
||||
- docs/downloaders/**
|
||||
- changed-files:
|
||||
- any-glob-to-any-file: ['docs/Downloaders/**']
|
||||
"Area: Plex":
|
||||
- docs/plex/**
|
||||
- changed-files:
|
||||
- any-glob-to-any-file: ['docs/Plex/**']
|
||||
"Area: Prowlarr":
|
||||
- docs/prowlarr/**
|
||||
- changed-files:
|
||||
- any-glob-to-any-file: ['docs/Prowlarr/**']
|
||||
"Area: Radarr":
|
||||
- docs/json/radarr/cf/**
|
||||
- docs/json/radarr/quality-size/**
|
||||
- docs/json/radarr/naming/**
|
||||
- docs/radarr/**
|
||||
- changed-files:
|
||||
- any-glob-to-any-file: ['docs/json/radarr/cf/**', 'docs/json/radarr/quality-size/**', 'docs/json/radarr/naming/**', 'docs/Radarr/**']
|
||||
"Area: Recyclarr":
|
||||
- docs/recyclarr-configs/**
|
||||
- changed-files:
|
||||
- any-glob-to-any-file: ['docs/recyclarr-configs/**']
|
||||
"Area: Sonarr":
|
||||
- docs/json/sonarr/rp/**
|
||||
- docs/json/sonarr/cf/**
|
||||
- docs/json/sonarr/quality-size/**
|
||||
- docs/json/sonarr/naming/**
|
||||
- docs/sonarr/**
|
||||
- changed-files:
|
||||
- any-glob-to-any-file: ['docs/json/sonarr/rp/**', 'docs/json/sonarr/cf/**', 'docs/json/sonarr/quality-size/**', 'docs/json/sonarr/naming/**', 'docs/Sonarr/**']
|
||||
"Area: Starr Custom Formats":
|
||||
- docs/json/radarr/cf/**
|
||||
- docs/json/sonarr/cf/**
|
||||
- changed-files:
|
||||
- any-glob-to-any-file: ['docs/json/radarr/cf/**', 'docs/json/sonarr/cf/**']
|
||||
"Area: Starr Naming":
|
||||
- docs/json/radarr/naming/**
|
||||
- docs/json/sonarr/naming/**
|
||||
- changed-files:
|
||||
- any-glob-to-any-file: ['docs/json/radarr/naming/**', 'docs/json/sonarr/naming/**']
|
||||
"Area: github_actions":
|
||||
- .github/workflows/**
|
||||
- .github/dependabot.yml
|
||||
- .github/labeler.yml
|
||||
- .github/stale.yml
|
||||
- changed-files:
|
||||
- any-glob-to-any-file: ['.github/workflows/**', '.github/dependabot.yml', '.github/labeler.yml', '.github/stale.yml']
|
||||
"Area: python":
|
||||
- "**/*.py"
|
||||
- changed-files:
|
||||
- any-glob-to-any-file: ['**/*.py']
|
||||
"Area: Backend":
|
||||
- changed-files:
|
||||
- any-glob-to-any-file: ['docs/**/*.md', '!docs/Bazarr/**', '!docs/Downloaders/**', '!docs/Plex/**', '!docs/Prowlarr/**', '!docs/Radarr/**', '!docs/recyclarr-configs/**', '!docs/Sonarr/**']
|
||||
|
||||
@ -0,0 +1,17 @@
|
||||
name: Do Not Merge
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
types: [synchronize, opened, reopened, labeled, unlabeled]
|
||||
|
||||
jobs:
|
||||
do-not-merge:
|
||||
if: contains(github.event.*.labels.*.name, 'Do Not Merge')
|
||||
name: Check Do Not Merge
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: check for label
|
||||
run: |
|
||||
echo "Pull request is labeled as 'Do Not Merge'"
|
||||
echo "This workflow fails so that the pull request cannot be merged"
|
||||
exit 1
|
||||
@ -1,6 +1,7 @@
|
||||
.cache
|
||||
venv/
|
||||
mkdocs-dev-server.bat
|
||||
site/
|
||||
/docs/Notifiarr/preview.bat
|
||||
/docs/Notifiarr/Integrations/_TEMPLATE.md
|
||||
/includes/flowcharts/.$radarr-flowchart.drawio.bkp
|
||||
|
||||
@ -1,8 +0,0 @@
|
||||
{
|
||||
"default": true,
|
||||
"MD013": false,
|
||||
"MD033": false,
|
||||
"MD024": false,
|
||||
"MD028": false,
|
||||
"MD046": fenced
|
||||
}
|
||||
@ -0,0 +1,16 @@
|
||||
{
|
||||
"recommendations": [
|
||||
"aaron-bond.better-comments",
|
||||
"streetsidesoftware.code-spell-checker",
|
||||
"editorconfig.editorconfig",
|
||||
"dbaeumer.vscode-eslint",
|
||||
"eamodio.gitlens",
|
||||
"oderwat.indent-rainbow",
|
||||
"yzhang.markdown-all-in-one",
|
||||
"davidanson.vscode-markdownlint",
|
||||
"christian-kohler.path-intellisense",
|
||||
"esbenp.prettier-vscode",
|
||||
"redhat.vscode-xml",
|
||||
"redhat.vscode-yaml"
|
||||
]
|
||||
}
|
||||
@ -0,0 +1,8 @@
|
||||
{
|
||||
"files.associations": {
|
||||
".pages": "yaml"
|
||||
},
|
||||
"yaml.schemas": {
|
||||
"https://raw.githubusercontent.com/compose-spec/compose-spec/master/schema/compose-spec.json": "untitled:Untitled-1"
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,184 @@
|
||||
# Contributing Guidelines
|
||||
|
||||
👍🎉 First off, thanks for taking the time to contribute! 🎉👍
|
||||
|
||||
Here you will find a set of guidelines for contributing to [TRaSH Guides](https://trash-guides.info/),
|
||||
These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
|
||||
|
||||
## Guidelines
|
||||
|
||||
- Make sure you're editing the latest version.
|
||||
- If you propose changes make sure it doesn't break anything else in the Guides.
|
||||
- Make sure that after the changes you don't get any [markdownlint](https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md) errors
|
||||
- If the `metadata.json` and `metadata.schema.json` needs changes, announce it first in the Discord `#development` channel and ping `voidpointer` and `nitsua` so the 3rd party apps don't break :bangbang:
|
||||
|
||||
## Branch naming
|
||||
|
||||
We're trying to be as consistent as possible for automation of the changelog.
|
||||
|
||||
- **feat/xxx** Commits, that adds a new feature
|
||||
- **fix/xxx** Commits, that fixes a bug/issue
|
||||
- **style/xxx** Commits, that do not affect the meaning (white-space, formatting, missing semi-colons, etc)
|
||||
- **chore/xxx** Miscellaneous commits (administrative / cleanup / backend)
|
||||
|
||||
Where 'xxx' can stand for Starr/Sonarr/Radarr/Guide etc
|
||||
|
||||
*Examples:*
|
||||
|
||||
- `feat/Starr-ELEANOR-to-Scene-CF`
|
||||
- `feat/Radarr-CiNEPHiLES-to-Remux-Tier-02`
|
||||
- `feat/maintenance`
|
||||
- `fix/dv-hdr10-cf-should-match-dv-hdr10+`
|
||||
|
||||
[Source](https://gist.github.com/qoomon/5dfcdf8eec66a051ecd85625518cfd13#types)
|
||||
|
||||
## Pull Request naming
|
||||
|
||||
We're trying to be as consistent as possible for automation of the changelog.
|
||||
|
||||
- **feat(xxx):** Commits, that adds a new feature
|
||||
- **fix(xxx):** Commits, that fixes a bug/issue
|
||||
- **style(xxx):** Commits, that do not affect the meaning (white-space, formatting, missing semi-colons, etc)
|
||||
- **chore(xxx):** Miscellaneous commits (administrative / cleanup / backend)
|
||||
|
||||
Where 'xxx' can stand for Starr/Sonarr/Radarr/Guide etc
|
||||
|
||||
*Examples:*
|
||||
|
||||
- `feat(starr): add ELEANOR to Scene CF`
|
||||
- `feat(radarr): add CiNEPHiLES to Remux Tier 02`
|
||||
- `feat(maintenance): various changes to the Starr CFs`
|
||||
- `fix(starr): DV HDR10 CF should match DV HDR10+`
|
||||
|
||||
[Source](https://gist.github.com/qoomon/5dfcdf8eec66a051ecd85625518cfd13#types)
|
||||
|
||||
## When doing a PR that is WIP
|
||||
|
||||
When doing a PR that is in-progress and not yet complete / ready for review or not yet done fully, please ensure it is a **DRAFT Pull Request**
|
||||
|
||||
## Radarr/Sonarr Custom Format (JSON)
|
||||
|
||||
### Release Group Reclassifications, Removals, or Additions
|
||||
|
||||
- When adding a RlsGrp to a Custom Format for whatever reason, please add in the PR why it's added/removed/moved.
|
||||
|
||||
### General Guidelines
|
||||
|
||||
- Custom Format name needs to match json name :bangbang:
|
||||
- No hashcode can exists multiple times :bangbang:
|
||||
- Tiers only hold release groups that have atleast done several dozen objectively high quality releases or are added for a specific reason. (If they do mainly niche stuff and/or foreign stuff they won't be added)
|
||||
- All Tier Groups must use retail sources. Fanrest and upscaled groups are forbidden. This is due to the high effort required and near impossibility to guarantee quality systematically without manual check every single movie.
|
||||
- JSON file format shall consist of the following TRaSH specific data appended to the json exported from Starr
|
||||
|
||||
```json
|
||||
{
|
||||
"trash_id": "HASHCODE",
|
||||
"trash_scores": {
|
||||
"default": 50,
|
||||
"some_other_profile": 100
|
||||
},
|
||||
"trash_regex": "https://regex101.com/r/pADWJD/5",
|
||||
STARRJSONEXPORT
|
||||
}
|
||||
```
|
||||
|
||||
General Structure
|
||||
|
||||
- json file name - name of the [json file](#file-naming)
|
||||
- `trash_id` - Generated [HashCode](#hashcode) for the Custom Format
|
||||
- `trash_scores` - Json object of [score(s) for the Custom Format](#scoring). Note that Custom
|
||||
Formats with Default Scores of 0 should NOT have a `trash_scores.default`
|
||||
- `trash_regex` - Link to [regex test cases](#regex-test-cases) for regex
|
||||
- STARRJSONEXPORT - The exported custom format created within Starr. Note that this will have a
|
||||
leading `{` that will need to have the `trash` specific regex added after
|
||||
|
||||
### File Naming
|
||||
|
||||
- JSON file names are always written in small letters, spaces are replaced by a dash, no spaces or special characters except a dash :bangbang:
|
||||
|
||||
### Hashcode
|
||||
|
||||
- When adding the hashcode for **Radarr** use the following naming `CF_name` e.g. the Custom Format `BR-DISK` would be the hash of [`BR-DISK`](https://md5.gromweb.com/?string=BR-DISK)
|
||||
- When adding the hashcode for **Radarr Anime** use the following naming `Radarr Anime CF_name` e.g. the Custom Format `BR-DISK` would be the hash of [`Radarr Anime BR-DISK`](https://md5.gromweb.com/?string=Radarr+Anime+BR-DISK).
|
||||
- When adding the hashcode for **Sonarr** use the following naming `Sonarr CF_name` e.g. the Custom Format `BR-DISK` would be the hash of [`Sonarr BR-DISK`](https://md5.gromweb.com/?string=Sonarr+BR-DISK).
|
||||
- When adding the hashcode for **Sonarr Anime** use the following naming `Sonarr Anime CF_name` e.g. the Custom Format `BR-DISK` would be the hash of [`Sonarr Anime BR-DISK`](https://md5.gromweb.com/?string=Sonarr+Anime+BR-DISK).
|
||||
|
||||
### Regex Test Cases
|
||||
|
||||
- Provide a link to your regex example of your Custom Format using the following [Template](https://regex101.com/r/4DypIW/1).
|
||||
|
||||
When adding a regex test case:
|
||||
|
||||
- Replace the actual movie name with `Movie`.
|
||||
- Replace the actual Series name/title with `Series`.
|
||||
- Replace the actual group name with `RlsGrp`
|
||||
|
||||
When updating or adding a new CF the test case url (`trash_regex`) needs to be prepended to the exported from Starr json
|
||||
|
||||
```json
|
||||
{
|
||||
"trash_regex": "https://regex101.com/r/pADWJD/5",
|
||||
}
|
||||
```
|
||||
|
||||
### Scoring
|
||||
|
||||
- Scores must be added as JSON objects under `trash_scores`, for example:
|
||||
|
||||
```json
|
||||
{
|
||||
"trash_scores": {
|
||||
"default": 50,
|
||||
"some_other_profile": 100
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
- This allows for Custom Formats to be assigned different scores for different profiles
|
||||
- Default Scores of 0 (e.g. as in `trash_scores.default`) are FORBIDDEN
|
||||
|
||||
## YAML file naming
|
||||
|
||||
- If a hashcode is needed **No** hashcode can exist multiple times :bangbang:
|
||||
- Use [this website](https://md5.gromweb.com) to generate an md5 hash
|
||||
- YAML file names are always written in small letters, spaces are replaced by a dash, no spaces or special characters except a dash :bangbang:
|
||||
|
||||
## Recommendations
|
||||
|
||||
Use [VSCode](https://code.visualstudio.com/) for editing. VS Code should recommend extensions to you
|
||||
based on the `.vscode/extensions.json` file; you should install all of them.
|
||||
|
||||
## Preview Docs Locally
|
||||
|
||||
### Prerequisites
|
||||
|
||||
These prerequisites are taken from the [mkdocs installation instructions][mkdocinstall].
|
||||
|
||||
- Install a recent version of [Python 3](https://www.python.org/).
|
||||
- `pip` is also required, but should come with Python. Run `pip --version` to check if its available
|
||||
and working. See the [installation instructions](https://pip.pypa.io/en/stable/installation/).
|
||||
|
||||
[mkdocinstall]: https://www.mkdocs.org/user-guide/installation/
|
||||
|
||||
### Mkdocs Installation
|
||||
|
||||
First, install mkdocs:
|
||||
|
||||
```bash
|
||||
pip install mkdocs
|
||||
```
|
||||
|
||||
Then, install dependent modules using the command below. This command should be run in the root
|
||||
directory of the repository (i.e. where the `requirements.txt` file is). If the `pip` command does
|
||||
not work, refer to the mkdocs installation page linked in the Prerequisite section above.
|
||||
|
||||
```bash
|
||||
pip install -r docs/requirements.txt
|
||||
```
|
||||
|
||||
Once everything is installed, run the command below to start a local dev server to preview your
|
||||
changes to mkdocs:
|
||||
|
||||
```bash
|
||||
mkdocs serve
|
||||
```
|
||||
@ -0,0 +1,6 @@
|
||||
nav:
|
||||
- Installing: index.md
|
||||
- Basic-Setup: Basic-Setup.md
|
||||
- Using Labels: Using-Labels.md
|
||||
- Port forwarding: Port-Forwarding.md
|
||||
- Tips
|
||||
@ -0,0 +1,196 @@
|
||||
# Basic-Setup
|
||||
|
||||
{! include-markdown "../../../includes/downloaders/basic-setup.md" !}
|
||||
<!-- --8<-- "includes/downloaders/basic-setup.md" -->
|
||||
|
||||
------
|
||||
!!! Note
|
||||
Settings that aren't covered means you can change them to your liking or just leave them on default.
|
||||
|
||||
------
|
||||
|
||||
## Accessing your settings
|
||||
|
||||
`Edit` => `Preferences` will bring up your option window once you have launched Deluge for the first time.
|
||||
|
||||
## Downloads
|
||||
|
||||
Once you are here, you can edit your download settings in the `Downloads` section.
|
||||
|
||||
|
||||
|
||||
### Download Path
|
||||
|
||||
`Download to` is where you want you want Deluge to download your media. If you want to move your files upon completion - check the box and enter a path for that option as well.
|
||||
|
||||
### Saving .torrent Copies
|
||||
|
||||
Copy (and delete upon removal) of the .torrent file upon completion.
|
||||
|
||||
!!! success ""
|
||||
**Suggested: `Personal preference`**
|
||||
|
||||
### Pre-allocated Files
|
||||
|
||||
Pre-allocate disk space for the added torrents. This limits fragmentation and also makes sure if you use a cache drive or a feeder disk, that the space is available.
|
||||
|
||||
!!! success ""
|
||||
**Suggested: `Enabled`**
|
||||
|
||||
!!! warning
|
||||
Do not set Pre-allocated disk space if you are using ZFS as your filesystem as ZFS [does not support fallocate](https://github.com/openzfs/zfs/issues/326){:target="_blank" rel="noopener noreferrer"}
|
||||
|
||||
{! include-markdown "../../../includes/downloaders/warning-path-location.md" !}
|
||||
|
||||
------
|
||||
|
||||
## Bandwidth
|
||||
|
||||
Here you can set your rate limits, meaning your maximum download/upload/connections.
|
||||
|
||||
!!! info
|
||||
In Deluge, the value of `-1` is used for "infinity" or "unlimited".
|
||||
|
||||
|
||||
|
||||
The best settings depend on many factors.
|
||||
|
||||
- Your ISP speed.
|
||||
- Your hardware.
|
||||
- Bandwidth needed by other services in your home network.
|
||||
|
||||
!!! success ""
|
||||
**Suggested:** `For a home connection that you use with others it's best practice to set the upload/download rate to about 70-80% of your maximum upload/download speed.`
|
||||
|
||||
## Global Bandwidth Limits
|
||||
|
||||
These are the client-wide settings, they will apply to the total traffic of all torrents.
|
||||
|
||||
|
||||
|
||||
!!! tip
|
||||
|
||||
The only thing you NEED to place a limit on is half-open connections and connections per second.
|
||||
|
||||
For most high-speed broadband connections ~100-150 seems ideal. If you experience lag when initiating a download, try lowering these values.
|
||||
|
||||
### Per-Torrent Limits
|
||||
|
||||
In addition to global limits, you can set limits per torrent.
|
||||
|
||||
!!! info
|
||||
|
||||
If you only wish to apply global limits, set all of these to `-1`.
|
||||
|
||||
|
||||
|
||||
------
|
||||
|
||||
## Queue
|
||||
|
||||
These settings are intended to manage your number of active seeds, downloads, and uploads.
|
||||
|
||||
!!! info
|
||||
In Deluge, the value of `-1` is used for "infinity" or "unlimited".
|
||||
|
||||
### Active Torrents
|
||||
|
||||
|
||||
|
||||
Unless you have a specific reason, `Total` can be set to `-1`. These are torrents seen as seeding by the tracker.
|
||||
|
||||
`Seeding` is the number of active torrents uploading, and `Downloading` is the number of concurrently downloading torrents.
|
||||
|
||||
### Seeding Rotation & Share Ratio
|
||||
|
||||
I recommend using the seeding goals in your Starr Apps indexer settings (enable advanced) to remove completed downloads. These sections are then not necessary.
|
||||
|
||||
------
|
||||
|
||||
## Network
|
||||
|
||||
This is where you will bind Deluge to a specific interface/address, specify port usage, and disable network protocols.
|
||||
|
||||
|
||||
|
||||
### Incoming Port
|
||||
|
||||
!!! info ""
|
||||
You've followed the [Setup TorGuard for port forwarding](/Misc/How-to-setup-Torguard-for-port-forwarding/){:target="_blank" rel="noopener noreferrer"} and want to know where in your download client you should add the port you've port forwarded.
|
||||
|
||||
`Incoming Port` should be set to a specific port that you have opened/forwarded (if you are behind any NAT/Firewall/VPN.)
|
||||
|
||||
!!! WARNING
|
||||
Default ports of 6880-6890 are not recommended.
|
||||
|
||||
Make sure you click `Test Active Port` and get a ✓ before moving on.
|
||||
|
||||
!!! success ""
|
||||
**Suggested: `Critical`**
|
||||
|
||||
### Encryption
|
||||
|
||||
Encryption should be enabled on both `Incoming` and `Outgoing`. The default `Level` of `Either` will accept both encrypted and standard connections.
|
||||
|
||||
!!! success ""
|
||||
**Suggested: `Level = Full Stream`**
|
||||
|
||||
### Network Extras
|
||||
|
||||
You can configure your network protocols in this section. Depending on which type of tracker you use, some of these will be beneficial while on other trackers (private) it will put you at risk of being banned/disabled.
|
||||
|
||||
!!! warning
|
||||
Please read this section carefully.
|
||||
|
||||
1. UPnP and NAT-PMP should be both disabled in your router, as well as in Deluge, as they can pose security risks.
|
||||
|
||||
|
||||
|
||||
!!! success ""
|
||||
**Suggested: `Disabled`**
|
||||
|
||||
1. Public trackers can benefit from having settings like DHT (Distributed Hash Table) and Peer Exchange (PEX) enabled. These protocols rely on sources besides the trackers to get peers. **The following settings are recommended ONLY for public trackers.**
|
||||
|
||||
|
||||
|
||||
!!! success ""
|
||||
**Suggested: `Recommended`**
|
||||
|
||||
1. Decent private trackers will use the "private flag" and ignore these settings by default. However, it is strongly recommended that you use the following settings if you use private trackers. Almost all private trackers have rules stating that you must disable DHT, PEX, and LSD/LPD (Local Peer Discovery). Failing to do so puts your account at risk of being disabled.
|
||||
|
||||
|
||||
|
||||
!!! success ""
|
||||
**Suggested: `Disabled`**
|
||||
|
||||
------
|
||||
|
||||
## Plugins
|
||||
|
||||
Finally, you will want to enable some plugins. There are plenty of plugins on the Deluge community forums to browse once you are familiar with the client, but for the time being, we will only be covering the `WebUI` and `Label` plugins to get started.
|
||||
|
||||
|
||||
|
||||
!!! tip
|
||||
If you are familiar with the client and plugins you can find more information [here](./Tips/Plugins.md)
|
||||
|
||||
!!! info
|
||||
If you are running a docker container, such as binhex's image, the `WebUI` plugin may not need to be enabled. Instead, it may be configured in the container.
|
||||
|
||||
### WebUI
|
||||
|
||||
Once you have enabled the `WebUI` plugin, it will appear in your `Preferences` menu list, and you will need to enable the web interface and set the port you want the WebUI to listen on.
|
||||
|
||||
!!! info
|
||||
The default WebUI password is `deluge` and you can change that in preferences inside the WebUI once you access it through your browser.
|
||||
|
||||
Remember your password, we will need this later.
|
||||
|
||||
### Label
|
||||
|
||||
The `Label` plugin will allow you to categorize/sort your torrents. You can assign one Label per torrent. Starr apps can also use Deluge's labels to help them keep track of downloads and imported torrents.
|
||||
|
||||
Labels are a valuable tool, if used properly, to keep your torrents managed and organized.
|
||||
|
||||
{! include-markdown "../../../includes/support.md" !}
|
||||
<!-- --8<-- "includes/support.md" -->
|
||||
@ -1,13 +0,0 @@
|
||||
# Deluge - Basic Setup
|
||||
|
||||
{! include-markdown "../../../includes/downloaders/basic-setup.md" !}
|
||||
<!-- --8<-- "includes/downloaders/basic-setup.md" -->
|
||||
|
||||
------
|
||||
|
||||
## Soon
|
||||
|
||||
I've asked several people that used this download client for some help/feedback, but most of them just switched to qBittorrent.
|
||||
|
||||
{! include-markdown "../../../includes/support.md" !}
|
||||
<!-- --8<-- "includes/support.md" -->
|
||||
@ -1,3 +0,0 @@
|
||||
# Deluge - How to add labels
|
||||
|
||||
Placeholder
|
||||
@ -0,0 +1,23 @@
|
||||
# Port Forwarding
|
||||
|
||||
The `Network` section of `Preferences` is where you will bind Deluge to a specific interface/address, and specify port usage.
|
||||
|
||||
|
||||
|
||||
## Incoming Port
|
||||
|
||||
!!! info ""
|
||||
You've followed the [Setup TorGuard for port forwarding](/Misc/How-to-setup-Torguard-for-port-forwarding/){:target="_blank" rel="noopener noreferrer"} and want to know where in your download client you should add the port you've forwarded.
|
||||
|
||||
`Incoming Port` should be set to a specific port that you have opened/forwarded (if you are behind any NAT/Firewall/VPN.)
|
||||
|
||||
!!! WARNING
|
||||
Default ports of 6880-6890 are not recommended.
|
||||
|
||||
Make sure you click `Test Active Port` and get a ✓ before moving on.
|
||||
|
||||
!!! success ""
|
||||
**Suggested: `Critical`**
|
||||
|
||||
{! include-markdown "../../../includes/support.md" !}
|
||||
<!-- --8<-- "includes/support.md" -->
|
||||
@ -0,0 +1,110 @@
|
||||
# Plugins
|
||||
|
||||
Here you will find a list of included and available plugins that may be useful. These are not required but should be seen as ways to advance/customize your setup once you understand the client and its behaviors.
|
||||
|
||||
!!! info
|
||||
All plugins are .egg files, these files will need to be placed inside your deluge config/data directory, inside the `plugins` folder. If you are using a thin client, they will also need to be present on your local instance as well.
|
||||
|
||||
!!! tip
|
||||
Links to the plugins below are directly to the latest versions available on Deluge's forums, see the original and subsequent posts for more information concerning the plugin's features and iterations.
|
||||
|
||||
---
|
||||
|
||||
## AutoAdd
|
||||
|
||||
Use this plugin as a "Watch" directory for .torrent files, you can customize the settings using the `Edit` button for that specific directory (download directory, label, etc).
|
||||
|
||||
Place a .torrent file in a watched folder, and Deluge will add the torrent to your client. Make sure your directory is marked with a checkmark under `Active` if you wish it to be monitored.
|
||||
|
||||
---
|
||||
|
||||
## AddTorrentCheck
|
||||
|
||||
This plugin is used to continuously update the tracker when adding torrents from IRC (think autodl-irssi or autobrr) before they are registered.
|
||||
|
||||
See the forum thread for details below.
|
||||
|
||||
[AddTorrentCheck](https://forum.deluge-torrent.org/viewtopic.php?p=236070#p236070){:target="\_blank" rel="noopener noreferrer"}
|
||||
|
||||
---
|
||||
|
||||
## Blocklist
|
||||
|
||||
This plugin has mixed reception, depending on the use case. For private trackers, it is generally recommended to keep it disabled. There is an argument that some benefits, in privacy/security, could be made for public trackers - however, reports of many false positives and actual TRACKERS being flagged/blocked have been reported.
|
||||
|
||||
Use at your own discretion.
|
||||
|
||||
---
|
||||
|
||||
## Execute
|
||||
|
||||
Execute will run a program or script upon reaching a specified event. It is recommended that after adding events, you restart Deluge.
|
||||
|
||||
!!! info
|
||||
Checking or Rechecking a torrent will not trigger the "Torrent Completed" event, you will need to actually download the torrent to trigger this.
|
||||
|
||||
---
|
||||
|
||||
## Stats
|
||||
|
||||
Stats does exactly what it sounds like; provides you with statistics on torrent traffic. You can find the latest version on the forums, but depending on which version of Deluge you install an older version may be included.
|
||||
|
||||
[Stats](https://forum.deluge-torrent.org/viewtopic.php?p=236443#p236443){:target="\_blank" rel="noopener noreferrer"}
|
||||
|
||||
---
|
||||
|
||||
## YaRSS2
|
||||
|
||||
YaRSS2 should be considered unsupported/abandoned at this point. This plugin will crash your client after a random amount of time.
|
||||
|
||||
There is not currently any active development on the project, as far as I'm aware.
|
||||
|
||||
There is currently no viable RSS support natively in Deluge.
|
||||
|
||||
---
|
||||
|
||||
## AutoRemovePlus
|
||||
|
||||
This is one of the forks of the original AutoRemovePlus (also referred to as ARP) which will automatically remove torrents from your client:
|
||||
|
||||
- Select how many torrents are allowed at the same time.
|
||||
- Choose to remove or pause them based on multiple criteria age, seeders, seed time or ratio.
|
||||
- Set specific removal rules depending on the tracker or LabelPlus label.
|
||||
- Remove only torrents from specific trackers or LabelPlus labels.
|
||||
- Only remove torrents if under a certain HDD space threshold.
|
||||
- Select if torrents have to fulfill both or either criteria.
|
||||
- Delete torrents in order (e.g. delete torrents with the highest ratio first).
|
||||
- Don't remove torrents if they don't reach a minimum time (in days) or ratio.
|
||||
- Choose the removal interval.
|
||||
- Right-click and select torrents that you don't want automatically removed.
|
||||
- Remove the torrent data option.
|
||||
- Create an exempted tracker or LabelPlus label list, so that torrents that belong to those trackers or labels are not removed.
|
||||
- Fully functional WebUI.
|
||||
|
||||
Other forks, and the original plugin, can be found on the GitHub page.
|
||||
|
||||
[AutoRemovePlus](https://github.com/laur89/deluge-autoremoveplus){:target="\_blank" rel="noopener noreferrer"}
|
||||
|
||||
---
|
||||
|
||||
## ltConfig
|
||||
|
||||
If you need to set libtorrent settings to anything other than their defaults, this is the plugin for you. There are presets, but you can fine-tune the settings as you need as well.
|
||||
|
||||
!!! ATTENTION
|
||||
There is a known bug when trying to enable settings in ltConfig, double-clicking will sometimes not "check" the option.
|
||||
|
||||
Simply click the option, then use the space bar to enable that checkbox.
|
||||
|
||||
!!! tips
|
||||
If you want to seed over 1600 torrents, you will need this plugin. You will need to increase the active_tracker_limit.
|
||||
|
||||
If your tracker's SSL certificate has expired, you can disable validate_https_trackers to bypass validation.
|
||||
|
||||
See the forum thread for details below.
|
||||
|
||||
[ltConfig](https://forum.deluge-torrent.org/viewtopic.php?p=235653#p235653){:target="\_blank" rel="noopener noreferrer"}
|
||||
|
||||
{! include-markdown "../../../../includes/support.md" !}
|
||||
|
||||
<!-- --8<-- "includes/support.md" -->
|
||||
@ -0,0 +1,54 @@
|
||||
# Thin Client
|
||||
|
||||
## Daemon
|
||||
|
||||
If you are already running Deluge in `daemon` or `console` mode, or running via Docker, this is usually enabled by default. You will need to check your compose or core.conf for the "daemon_port" if you do not know it.
|
||||
|
||||
!!! tip
|
||||
You can also access the daemon settings in `Preferences` in the WebUI if you do not have access to the GTK/UI
|
||||
|
||||
You will need to have "Allow Remote Connections" enabled if you are not connecting to Deluge from localhost.
|
||||
|
||||
|
||||
|
||||
!!! info
|
||||
If you do not have access to the WebUI, and are instead doing this by editing Deluge's `core.conf`, you will need to change "allow_remote" to true.
|
||||
|
||||
Restart Deluge for the changes to take effect.
|
||||
|
||||
------
|
||||
|
||||
## Switching to Thin-Client
|
||||
|
||||
Once your daemon is up and running, it's time to set up the client you'll be using to manage your daemon. This will usually be on a second computer, but if you wish to use Deluge with Thin-Client locally (to always seed in the background) that works as well.
|
||||
|
||||
Simply go to `Edit` => `Preferences` and switch from `Standalone` to `Thin Client`
|
||||
|
||||
|
||||
|
||||
Restart Deluge.
|
||||
|
||||
!!! info
|
||||
You will still need to set the daemon to run at start-up.
|
||||
|
||||
### Connections Manager
|
||||
|
||||
After switching to `Thin Client` you will need to connect to your daemon. Go to `Edit` => `Connections Manager` and click on `Add` to add the daemon.
|
||||
|
||||
|
||||
|
||||
!!! ATTENTION
|
||||
If you mistyped your password while adding the connection, it will prompt you to enter it. There is a bug that does not accept/save the correct password unless it is entered through the `Add`/`Edit` Menu.
|
||||
|
||||
If you mistype the password while you are adding the connection, go to `Edit` on the connection and retype the password into the password field.
|
||||
|
||||
!!! WARNING
|
||||
You can find your users and passwords for the daemon in the `auth` file inside your appdata/config folder for Deluge.
|
||||
|
||||
You can add users in the `Daemon` settings in preferences as well.
|
||||
|
||||
BE AWARE: These passwords are stored in PLAIN-TEXT in your `auth` file.
|
||||
|
||||
{! include-markdown "../../../../includes/support.md" !}
|
||||
|
||||
<!-- --8<-- "includes/support.md" -->
|
||||
@ -0,0 +1,265 @@
|
||||
# unRAID Mover and Deluge
|
||||
|
||||
When you make use of the unRAID cache drive for your `/data/torrents` share, and the torrents in Deluge are still seeding, the mover can't move files since they are still in use.
|
||||
|
||||
Using the following instructions will allow you to move the files with the use of the Deluge JSON-RPC.
|
||||
|
||||
!!! abstract "Workflow Rules"
|
||||
|
||||
1. Pause torrents in a specified age range that reside on your cache drive.
|
||||
1. Run the unRAID mover.
|
||||
1. Resume the torrents after the mover has completed.
|
||||
|
||||
!!! warning
|
||||
|
||||
The screenshots below are only **EXAMPLES** to show you how it should look and where you need to place the data that you need to add. They are **NOT** always a 100% reflection of the actual data, and not always the actual values you need to add.
|
||||
|
||||
- Always follow the recommendations described in the guide.
|
||||
- If you have any questions, or aren't sure, just click the chat badge to join the Discord Channel where you can ask your questions directly.
|
||||
|
||||
## Needed
|
||||
|
||||
### `deluge-mover` script
|
||||
|
||||
Download the following standalone Python script.
|
||||
|
||||
- [Script (deluge-mover.py)](https://raw.githubusercontent.com/zakkarry/deluge-mover/master/deluge-mover.py){:target="_blank" rel="noopener noreferrer"}
|
||||
|
||||
Thanks to [zakary](https://github.com/zakkarry){:target="_blank" rel="noopener noreferrer"} (Developer on [cross-seed](https://github.com/cross-seed/cross-seed){:target="_blank" rel="noopener noreferrer"})
|
||||
|
||||
### Plugins
|
||||
|
||||
Install the following Plugins.
|
||||
|
||||
- User Scripts
|
||||
- NerdTools
|
||||
- python3 <sup>(*1*)</sup>
|
||||
- python-setuptools <sup>(*1*)</sup>
|
||||
- python-pip <sup>(*1*)</sup>
|
||||
|
||||
!!! info "<sup>(*1*)</sup> These need to be installed from NerdTools."
|
||||
|
||||
------
|
||||
|
||||
## Setup
|
||||
|
||||
After you install the needed `Plugins` - it's time to configure everything.
|
||||
|
||||
### `requests` module
|
||||
|
||||
`deluge-mover.py` needs the requests Python module, so we need to make sure it's installed when your unRAID server starts, or when the Array is started the first time.
|
||||
|
||||
You can choose one of the following 3 options (select a tab) to install `requests`.
|
||||
|
||||
=== "User scripts"
|
||||
With this option, we're going to install the `requests` module when the Array is started the first time.
|
||||
|
||||
In your unRAID Dashboard, go to your `Settings` tab and select `User Scripts` in the `User Utilities` section at the bottom.
|
||||
|
||||
|
||||
|
||||
At the bottom of the `User Scripts` page select the `ADD NEW SCRIPT` button.
|
||||
|
||||
|
||||
|
||||
A popup will appear asking you to name the script. For this example, we're going to use `Install requests (deluge-mover)` and then click on `OK`.
|
||||
|
||||
|
||||
|
||||
Click on the cogwheel of the new script in the list, and select `Edit Script`.
|
||||
|
||||
|
||||
|
||||
Copy/Paste the following in the new window that opens, then click `SAVE CHANGES`.
|
||||
|
||||
```bash
|
||||
#!/bin/bash
|
||||
pip3 install requests
|
||||
```
|
||||
|
||||
|
||||
|
||||
Select in the schedule list when the script should run, and choose `At First Array Start Only`.
|
||||
|
||||
|
||||
|
||||
Click on `Apply`.
|
||||
|
||||
Finally, you will need to choose `RUN IN BACKGROUND` or restart your unRAID server to install the `requests` module.
|
||||
=== "Python venv"
|
||||
With this option, we're going to create a [Python virtual environment](https://docs.python.org/3/library/venv.html) on our disk. We will use this to run and store dependencies (`requests`) for this specific environment.
|
||||
|
||||
By doing this, we will **only need to configure this once** and it will be persistent after reboots *(this differs from the previous steps)*.
|
||||
|
||||
First, you need to choose a location to start a new Python environment.
|
||||
|
||||
!!! info
|
||||
In the next steps, you will be asked to choose a [location to store the script](#copy-script-to-your-preferred-location), try to be consistent.
|
||||
|
||||
Suggestions:
|
||||
|
||||
- `/mnt/user/appdata/deluge/scripts/.venv`
|
||||
- `/mnt/user/data/scripts/.venv`
|
||||
|
||||
Run the following command in unRAID's terminal in the directory you chose:
|
||||
|
||||
```bash
|
||||
python3 -m venv --clear /mnt/user/data/scripts/.venv
|
||||
```
|
||||
|
||||
We now need to enter this new environment and install our dependency (`requests`) in it, run:
|
||||
|
||||
```bash
|
||||
source /mnt/user/data/scripts/.venv/bin/activate
|
||||
pip3 install requests
|
||||
deactivate # to leave the environment
|
||||
```
|
||||
|
||||
!!! info
|
||||
Replace `/mnt/user/data/scripts/.venv` with the path you have chosen.
|
||||
=== "Go File"
|
||||
With this option, we're going to install the `requests` module when the unRAID server is started.
|
||||
|
||||
On your USB stick/key go to `/boot/config` and open the `go` file with your text editor ([VSCode](https://code.visualstudio.com/){:target="_blank" rel="noopener noreferrer"}/[Notepad++](https://notepad-plus-plus.org/downloads/){:target="_blank" rel="noopener noreferrer"}).
|
||||
|
||||
Copy/paste the following command
|
||||
|
||||
```bash
|
||||
pip3 install requests
|
||||
```
|
||||
|
||||
Restart your unRAID Server or run the above command from the terminal.
|
||||
|
||||
------
|
||||
|
||||
### Script
|
||||
|
||||
Now, using your favorite text editor ([VSCode](https://code.visualstudio.com/){:target="_blank" rel="noopener noreferrer"}/[Notepad++](https://notepad-plus-plus.org/downloads/){:target="_blank" rel="noopener noreferrer"}) edit the script you downloaded at the beginning of the guide ([HERE](#deluge-mover-script)).
|
||||
|
||||
You only need to change a few options at the top of the script.
|
||||
|
||||
```python
|
||||
### CONFIGURATION VARIABLES ###
|
||||
|
||||
# this webui will need to be the JSON-RPC endpoint
|
||||
# this ends with '/json'
|
||||
deluge_webui = "http://localhost:8112/json"
|
||||
deluge_password = "deluged"
|
||||
|
||||
# this changes whether the actual cache drive is checked for
|
||||
# applicable files to pause/move before pausing.
|
||||
#
|
||||
# if this is false, it will pause all torrents in the age-range
|
||||
# instead of only torrents in that range that exist on the cache
|
||||
check_fs = False
|
||||
|
||||
# if you are using the mover tuner and don't want to use it for
|
||||
# this script, set this to true
|
||||
#
|
||||
# if you do not use mover tuner, leave this as false
|
||||
use_mover_old = False
|
||||
|
||||
# this is the absolute host path to your cache drive's downloads
|
||||
# you only need this to be changed/set if using 'check_fs = True'
|
||||
cache_download_path = "/mnt/cache/torrents/completed"
|
||||
|
||||
# the age range of days to look for relevant torrents to move
|
||||
# i dont recommend setting age_day_max to less than the schedule
|
||||
# you run the script on...
|
||||
#
|
||||
# if you run every 7 days, this should be at least 7 to prevent
|
||||
# files from being stuck on your cache forever
|
||||
#
|
||||
# 0 disables age_day_max
|
||||
# set both age vars to 0 to move everything on your cache drive
|
||||
|
||||
age_day_min = 3
|
||||
age_day_max = 0
|
||||
```
|
||||
|
||||
- `deluge_webui` => The URL you use to access Deluge locally. (*the* `"` *should remain*)
|
||||
- `deluge_password` => Your Deluge WebUI `Password`. (*the* `"` *should remain*)
|
||||
- `check_fs` => If set to `True`, it will check for the file on the cache drive before pausing.
|
||||
- `use_mover_old` => See below.
|
||||
|
||||
!!! warning ""
|
||||
- If you do not use `Mover Tuning`, you **DO NOT** have to make any changes.
|
||||
- If you use `Mover Tuning` but **DON'T** want to use it for the script, change this to `True`
|
||||
- If you use `Mover Tuning` and **DO** want to use it for the script, you will not have to make any changes. However, for this option, inside the `Mover Tuner` you will need to set `Move Now button follows plugin filters` to `Yes` and `Disable Mover running on a schedule` to `No`.
|
||||
|
||||
- `cache_download_path` => The location (host path) for your cache folder (if check_fs is True)
|
||||
- `age_day_min` => Set the minimum age (days) of the torrents that you wish to move.
|
||||
- `age_day_max` => Set the maximum age (days) of the torrents that you wish to move.
|
||||
|
||||
#### Copy the script to your preferred location
|
||||
|
||||
Place the script you just edited somewhere easy to access/remember.
|
||||
|
||||
Suggestions:
|
||||
|
||||
- `/mnt/user/appdata/deluge/scripts/deluge-mover.py`
|
||||
- `/mnt/user/data/scripts/deluge-mover.py`
|
||||
|
||||
#### Final steps
|
||||
|
||||
Set up the scheduler for when the mover should run.
|
||||
|
||||
In your unRAID Dashboard, go to your `Settings` tab and select `User Scripts` in the `User Utilities` section at the bottom.
|
||||
|
||||
|
||||
|
||||
At the bottom of the `User Scripts` page select the `ADD NEW SCRIPT` button.
|
||||
|
||||
|
||||
|
||||
A popup will appear asking you to name the script. For this example, we're going to use `deluge-mover` and then click on `OK`.
|
||||
|
||||
|
||||
|
||||
Click on the cogwheel of the new script in the list.
|
||||
|
||||
|
||||
|
||||
Choose your method (select a tab) and copy/paste the script in the new window that opens, then click `SAVE CHANGES`.
|
||||
=== "Python (Native)"
|
||||
|
||||
``` bash
|
||||
#!/bin/bash
|
||||
/usr/local/emhttp/plugins/dynamix/scripts/notify -s "Deluge Mover" -d "Deluge Mover starting @ `date +%H:%M:%S`."
|
||||
echo "executing script to pause torrents and run mover."
|
||||
python3 /mnt/user/data/scripts/deluge-mover.py
|
||||
echo "deluge-mover completed and resumed all paused torrents."
|
||||
/usr/local/emhttp/plugins/dynamix/scripts/notify -s "Deluge Mover" -d "Deluge Mover completed @ `date +%H:%M:%S`."
|
||||
```
|
||||
|
||||
=== "Python (venv)"
|
||||
|
||||
``` bash
|
||||
#!/bin/bash
|
||||
/usr/local/emhttp/plugins/dynamix/scripts/notify -s "Deluge Mover" -d "Deluge Mover starting @ `date +%H:%M:%S`."
|
||||
echo "executing script to pause torrents and run mover."
|
||||
/mnt/user/data/scripts/.venv/bin/python3 /mnt/user/data/scripts/deluge-mover.py
|
||||
echo "deluge-mover completed and resumed all paused torrents."
|
||||
/usr/local/emhttp/plugins/dynamix/scripts/notify -s "Deluge Mover" -d "Deluge Mover completed @ `date +%H:%M:%S`."
|
||||
```
|
||||
|
||||
!!! info
|
||||
Replace `/mnt/user/data/scripts/` in the script with the path you have chosen for the Python script.
|
||||
|
||||
|
||||
|
||||
Click the schedule dropdown to choose when the script should run. We want to select `Custom`.
|
||||
|
||||
|
||||
|
||||
After changing to `Custom` you will get an extra text field on the right where you can set your schedule (cron).
|
||||
|
||||
For this example, we're going to tell the script to run every day at 4 AM.
|
||||
|
||||
`0 4 * * *`
|
||||
|
||||
You can generate your scheduling [HERE](https://crontab.guru/)
|
||||
|
||||
|
||||
|
||||
{! include-markdown "../../../../includes/support.md" !}
|
||||
|
After Width: | Height: | Size: 124 KiB |
|
After Width: | Height: | Size: 975 KiB |
|
After Width: | Height: | Size: 26 KiB |
|
After Width: | Height: | Size: 17 KiB |
|
After Width: | Height: | Size: 201 KiB |
|
After Width: | Height: | Size: 31 KiB |
|
After Width: | Height: | Size: 946 KiB |
|
After Width: | Height: | Size: 472 KiB |
|
After Width: | Height: | Size: 334 KiB |
|
After Width: | Height: | Size: 341 KiB |
|
After Width: | Height: | Size: 22 KiB |
@ -0,0 +1,35 @@
|
||||
# Using Labels
|
||||
|
||||
## Labels
|
||||
|
||||
!!! info
|
||||
Labels are the equivalent of categories for qBittorrent, and how you can manage and organize your torrents in groups. Starr apps can use labels in Deluge to keep track of downloads to monitor, rather than watching every torrent in your client.
|
||||
|
||||
### Managing Labels
|
||||
|
||||
Once you have [enabled the `Label` plugin](./Basic-Setup.md#plugins), you simply right-click anywhere in the area occupied by the label index on the pane on the left and you will be presented with a menu to add/remove/edit a label or its options.
|
||||
|
||||
|
||||
|
||||
### Label Options
|
||||
|
||||
Each label can be customized by selecting the label, right-clicking, and going to its `Label Options`. Here you can specify the bandwidth settings, download location settings, and even seed goals.
|
||||
|
||||
!!! info
|
||||
In Deluge, the value of `-1` is used for "infinity" or "unlimited".
|
||||
|
||||
Below you see an example of the bandwidth options available for a specific label. These settings will be automatically applied as long as a torrent has this label.
|
||||
|
||||
|
||||
|
||||
If you want torrents to be moved upon completion to a specific folder, you can specify this in `Folder Options`. The torrent WILL need to finish downloading while under the label for this to happen.
|
||||
|
||||
|
||||
|
||||
!!! info
|
||||
Enabling a "Move completed to" for a label may require you to restart Deluge before it will take effect.
|
||||
|
||||
Rechecking torrents will not trigger the "completion" call.
|
||||
|
||||
{! include-markdown "../../../includes/support.md" !}
|
||||
<!-- --8<-- "includes/support.md" -->
|
||||
|
After Width: | Height: | Size: 504 KiB |
|
After Width: | Height: | Size: 789 KiB |
|
After Width: | Height: | Size: 791 KiB |
|
After Width: | Height: | Size: 246 KiB |
|
After Width: | Height: | Size: 81 KiB |
|
After Width: | Height: | Size: 276 KiB |
|
After Width: | Height: | Size: 149 KiB |
|
After Width: | Height: | Size: 329 KiB |
|
After Width: | Height: | Size: 321 KiB |
|
After Width: | Height: | Size: 71 KiB |
|
After Width: | Height: | Size: 71 KiB |
|
After Width: | Height: | Size: 2.7 KiB |
|
After Width: | Height: | Size: 785 KiB |
|
After Width: | Height: | Size: 827 KiB |
|
After Width: | Height: | Size: 618 KiB |
|
After Width: | Height: | Size: 769 KiB |
|
After Width: | Height: | Size: 447 KiB |
|
After Width: | Height: | Size: 788 KiB |
|
After Width: | Height: | Size: 214 KiB |
|
After Width: | Height: | Size: 138 KiB |
@ -1,3 +1,49 @@
|
||||
# Deluge Placeholder
|
||||
# Installing
|
||||
|
||||
I've asked several people that used this download client for some help/feedback, but most of them just switched to qBittorrent.
|
||||
## Introduction
|
||||
|
||||
Deluge is an open-source cross-platform torrent client written in Python. It has been around since 2006 and offers many features that, while niche, many consider to be critical to their setups.
|
||||
|
||||
------
|
||||
|
||||
## Installation
|
||||
|
||||
Information sourced mostly from [Deluge's Downloads Page](https://dev.deluge-torrent.org/wiki/Download)
|
||||
|
||||
### Windows
|
||||
|
||||
You can find the latest Windows installers [here](https://ftp.osuosl.org/pub/deluge/windows/?C=M;O=D)
|
||||
|
||||
!!! note
|
||||
`lt2.0` in the filename means the installer includes libtorrent 2.0.x instead of the older 1.2.x
|
||||
|
||||
### Linux (Native)
|
||||
|
||||
Due to most default OS repositories being outdated, I recommend using Deluge's repositories to install the latest version.
|
||||
|
||||
Using `apt-get` to install
|
||||
|
||||
sudo add-apt-repository ppa:deluge-team/stable
|
||||
sudo apt-get update
|
||||
sudo apt-get install deluge
|
||||
|
||||
Using `pip3` to install (included in the Python package)
|
||||
|
||||
pip3 install deluge
|
||||
|
||||
!!! info
|
||||
You can find this project's pip repo @ [pypi.org/project/deluge/](https://pypi.org/project/deluge/)
|
||||
|
||||
!!! Advanced
|
||||
If you want to install deluged as a service, documentation can be found [here](https://deluge.readthedocs.io/en/latest/how-to/systemd-service.html)
|
||||
|
||||
### Docker Containers
|
||||
|
||||
[LinuxServer.io](https://hub.docker.com/r/linuxserver/deluge)
|
||||
|
||||
[BinHex](https://hub.docker.com/r/binhex/arch-deluge)
|
||||
|
||||
[BinHex VPN](https://hub.docker.com/r/binhex/arch-delugevpn)
|
||||
|
||||
{! include-markdown "../../../includes/support.md" !}
|
||||
<!-- --8<-- "includes/support.md" -->
|
||||
|
||||
|
Before Width: | Height: | Size: 56 KiB After Width: | Height: | Size: 61 KiB |
@ -0,0 +1,11 @@
|
||||
# Themes
|
||||
|
||||
A list of known working qBittorrent themes.
|
||||
|
||||
| Theme | Style | Compatibility |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ----- | --------------- |
|
||||
| [Honeywell](https://github.com/stacksmash76/qbt-honeywell){:target="_blank" rel="noopener noreferrer"} | Dark | v4.3.1 - v4.4.5 |
|
||||
| [Nightwalker Theme (CallMeBruce fork)](https://github.com/CallMeBruce/nightwalker){:target="_blank" rel="noopener noreferrer"} | Dark | v4.5 |
|
||||
| [World of Quinoa](https://github.com/gl0ryus/woq){:target="_blank" rel="noopener noreferrer"} | Dark | v4.3.9, v4.4.5 |
|
||||
|
||||
--8<-- "includes/support.md"
|
||||
|
Before Width: | Height: | Size: 10 KiB After Width: | Height: | Size: 10 KiB |
|
After Width: | Height: | Size: 1.3 MiB |
|
After Width: | Height: | Size: 34 KiB |
|
After Width: | Height: | Size: 2.8 MiB |
|
Before Width: | Height: | Size: 86 KiB After Width: | Height: | Size: 127 KiB |
@ -1,4 +1,6 @@
|
||||
nav:
|
||||
- Home: index.md
|
||||
- Tips
|
||||
- Suggested Plex Media Server Settings: /Plex/Tips/Plex-media-server/
|
||||
- Optimal Plex Client Settings: /Plex/Tips/Optimal-plex-client-settings/
|
||||
- Stop 4k Video Transcoding: /Plex/Tips/4k-transcoding/
|
||||
- Profiles: /Plex/profiles/
|
||||
|
||||
@ -1,4 +0,0 @@
|
||||
nav:
|
||||
- Suggested Plex Media Server Settings: Plex-media-server.md
|
||||
- Optimal Plex Client Settings: Optimal-plex-client-settings.md
|
||||
- JBOPS 4K Transcode Stopping with Tautulli: 4k-transcoding.md
|
||||
File diff suppressed because it is too large
Load Diff
@ -1,39 +1,44 @@
|
||||
# How to rename your folders
|
||||
|
||||
If you want to rename your current folder names (for example to your new naming scheme), you can do that with this little magic trick.
|
||||
If you need to rename your current folder names (for example, to a new naming scheme), you can do so with a little "magic trick".
|
||||
|
||||
|
||||
|
||||
Go to you movie overview
|
||||
Simply go to the movie overview section.
|
||||
|
||||
`Movies`
|
||||
|
||||
On the top click on `Movie Editor`
|
||||
Click on `Edit Movies` (at the top)
|
||||
|
||||
|
||||
|
||||
After activating it you select the movie(s) from where you want to have the folder(s) to be renamed.
|
||||
Once you are in "edit" mode, you can select the movie(s) whose folders you want to be renamed.
|
||||
|
||||
|
||||
|
||||
1. If you want all your movie folders renamed to your new folder naming scheme you set earlier [HERE](/Radarr/Radarr-recommended-naming-scheme){:target="_blank" rel="noopener noreferrer"}.
|
||||
1. Select the movie(s) from where you want to have the folder(s) to be renamed.
|
||||
1. Choose the same `Root Folder`
|
||||
1. If you want all your movie's folders to be renamed with the new naming scheme you set [HERE](/Radarr/Radarr-recommended-naming-scheme){:target="_blank" rel="noopener noreferrer"}.
|
||||
1. Select the movie(s) that you want to have the folder(s) renamed.
|
||||
1. At the bottom select `Edit`
|
||||
|
||||
A new popup will be shown:
|
||||
|
||||
|
||||
|
||||
Choose the same (current) root folder for your selected movies, and choose `Apply Changes`.
|
||||
|
||||
|
||||
|
||||
Select `Yes, Move the files`
|
||||
You will get a warning popup where you will need to choose `Yes, Move the files`
|
||||
|
||||
!!! warning
|
||||
If you have a large library, remote storage, cloud storage, or your path structure isn't well planned or doesn't support instant moves, then this process could take a while. Make sure you don't interrupt this process. If it stops before it's complete, it could result in quite the mess.
|
||||
If you have a large library, use remote or cloud storage, or your path structure isn't well planned (or doesn't support instant moves) this could take a while.
|
||||
|
||||
**Make sure you don't interrupt this process.** If it stops before it has been completed, it could result in quite a mess.
|
||||
|
||||
Then Magic
|
||||
Then, Magic!
|
||||
|
||||
|
||||
|
||||
As you can see the folder has been renamed to the correct year following your naming scheme.
|
||||
As you can see, the folder has now been renamed to the new/updated naming scheme.
|
||||
|
||||
{! include-markdown "../../../includes/support.md" !}
|
||||
<!-- --8<-- "includes/support.md" -->
|
||||
--8<-- "includes/support.md"
|
||||
|
||||
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 16 KiB |
|
After Width: | Height: | Size: 1.2 MiB |
|
Before Width: | Height: | Size: 13 KiB After Width: | Height: | Size: 368 KiB |
|
Before Width: | Height: | Size: 464 KiB After Width: | Height: | Size: 362 KiB |
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 13 KiB |
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 170 KiB |
|
Before Width: | Height: | Size: 129 KiB After Width: | Height: | Size: 196 KiB |
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in new issue