feat(guide): Add categories index descriptions (#2050)
* feat(guide): Added categories index * Added: Categories index for Misc * Added: Categories index for Downloaders * Added: link to official upstream page * Removed: un-existing link * Replaced: include-markdown for Snippets Notation * Moved: images to tips section because guide was moved * Moved: Radarr remote path mapping guide to tips and setup redirect * Added: Categories/Description index for Radarr * Trying to improve the readability of the guide * moved remote path mapping to tips section * Categories/Description index + Trying to improve the readability of the guide * Add: Sonarr rename your folder re-direct to Radarr * Categories/Index description for Prowlarr * Grammarly correction * Categories/Index description for Lidarr * Fixed: Wrong amount of left-padding spaces(want multiple of 4) * Corrected: Inconsistency * Categories/Index description for Bazarr + added external links * Added: Warning that the scripts are scripts are community-provided and maintained * Rename: TRaSH Sync to Guide sync tool * Grammarly correction and `I` to `We` * Added: Warning that the scripts are are community-provided and maintained * Sorted ASC and added TrueNAS scale info * Added: info to enable advanced view and click on the EDIT button * Fix: MD012/no-multiple-blanks Multiple consecutive blank linespull/2062/head
TRaSH
3 months ago
committed by
GitHub
@ -1,6 +1,7 @@
|
|||||||
nav:
|
nav:
|
||||||
- Home: index.md
|
- Home: index.md
|
||||||
- Basic-Guide: Setup-Guide.md
|
- Basic-Guide (ext.link): https://wiki.bazarr.media/Getting-Started/Setup-Guide/
|
||||||
- After Install Configuration: After-install-configuration.md
|
- After Install Configuration (ext.link): https://wiki.bazarr.media/Getting-Started/First-time-installation-configuration/
|
||||||
|
- Suggested Scoring: Bazarr-suggested-scoring.md
|
||||||
- Scripts: /Bazarr/scripts/
|
- Scripts: /Bazarr/scripts/
|
||||||
- Tips
|
|
||||||
|
|||||||
|
Before Width: | Height: | Size: 23 KiB After Width: | Height: | Size: 23 KiB |
|
Before Width: | Height: | Size: 21 KiB After Width: | Height: | Size: 21 KiB |
|
Before Width: | Height: | Size: 34 KiB After Width: | Height: | Size: 34 KiB |
@ -1,29 +1,20 @@
|
|||||||
# Bazarr
|
# Bazarr
|
||||||
|
|
||||||
Here you will find several scripts you can use with Bazarr
|
## Basic guides
|
||||||
|
|
||||||
## Stable - Bazarr Branch: master
|
For Installation and the basics of Bazarr, please check the official [Bazarr Wiki](https://wiki.bazarr.media/){:target="\_blank" rel="noopener noreferrer"}.
|
||||||
|
|
||||||
{ .off-glb }
|
For Support specific related to Bazarr we suggest you join their official [Discord Support](https://wiki.bazarr.media/discord){:target="\_blank" rel="noopener noreferrer"} server.
|
||||||
|
|
||||||
- (stable)
|
### Current Versions
|
||||||
- Builds Pushed after a testing period in development
|
|
||||||
- Github Branch: master
|
|
||||||
- Docker: [hotio/bazarr:latest](https://hotio.dev/containers/bazarr/){:target="\_blank" rel="noopener noreferrer"}
|
|
||||||
|
|
||||||
```bash
|
{ .off-glb } { .off-glb }
|
||||||
hotio/bazarr:latest
|
|
||||||
```
|
|
||||||
|
|
||||||
## Dev - Bazarr Branch: development
|
## Available guides
|
||||||
|
|
||||||
{ .off-glb }
|
Some of these guides were started by us and are now maintained by the Bazarr team.
|
||||||
|
|
||||||
- (development)
|
- [Basic-Guide](https://wiki.bazarr.media/Getting-Started/Setup-Guide/){:target="\_blank" rel="noopener noreferrer"} - The basic set up needed to get started with Bazarr (*external link to the official most up-to-date Bazarr guide*).
|
||||||
- Builds pushed when complete
|
- [After Install Configuration](https://wiki.bazarr.media/Getting-Started/First-time-installation-configuration/){:target="\_blank" rel="noopener noreferrer"} - Bazarr only searches for subtitles for Episodes and Movies that are added after the install, So you will need to set the preferred languages for your existing Shows and Movies. (*external link to the official most up-to-date Bazarr guide*).
|
||||||
- Github Branch: development
|
- [Suggested Scoring](/Bazarr/Bazarr-suggested-scoring/) - Suggested scores that would work with the most common languages, with this scoring 99% of your downloaded subtitles should be the correct ones for your release.
|
||||||
- Docker: [hotio/bazarr:nightly](https://hotio.dev/containers/bazarr/){:target="\_blank" rel="noopener noreferrer"}
|
- [Scripts](/Bazarr/scripts/) - The start of a collection of community-provided and maintained scripts for Bazarr, that only should be used if you have a specific need for it.
|
||||||
|
|
||||||
```bash
|
|
||||||
hotio/bazarr:nightly
|
|
||||||
```
|
|
||||||
|
|||||||
@ -0,0 +1,51 @@
|
|||||||
|
# Installing
|
||||||
|
|
||||||
|
## 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, we 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)
|
||||||
|
|
||||||
|
--8<-- "includes/support.md"
|
||||||
@ -1,51 +1,12 @@
|
|||||||
# Installing
|
# Deluge
|
||||||
|
|
||||||
## Introduction
|
[{ .off-glb }](https://deluge-torrent.org/){:target="\_blank" rel="noopener noreferrer"}
|
||||||
|
|
||||||
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.
|
- [Installing](/Downloaders/Deluge/Installing/) - Installation instructions.
|
||||||
|
- [Basic-Setup](/Downloaders/Deluge/Basic-Setup/) - Basic set up of the most common settings.
|
||||||
---
|
- [Using Labels](/Downloaders/Deluge/Using-Labels/) - 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.
|
||||||
|
- [Port forwarding](/Downloaders/Deluge/Port-Forwarding/) - Where in your download client you should add the port you've port forwarded with your VPN Service.
|
||||||
## Installation
|
- Tips - Several tips/tweaks for Deluge.
|
||||||
|
- [Plugins](/Downloaders/Deluge/Tips/Plugins/) - Here you will find a list of included and available plugins that may be useful.
|
||||||
Information sourced mostly from [Deluge's Downloads Page](https://dev.deluge-torrent.org/wiki/Download)
|
- [Thin Client](/Downloaders/Deluge/Tips/Thin-Client/) - How to set up the Thin-Client to manage Deluge.
|
||||||
|
- [unRAID Mover and Deluge](/Downloaders/Deluge/Tips/Unraid-Mover/) - How to move your files from your cache drive to your array when torrents are still seeding.
|
||||||
### 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, we 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)
|
|
||||||
|
|
||||||
--8<-- "includes/support.md"
|
|
||||||
|
|||||||
@ -1,5 +1,7 @@
|
|||||||
# NZBGet
|
# NZBGet
|
||||||
|
|
||||||
!!! note "NZBGet development has been picked up again by new developers over at [github](https://github.com/nzbgetcom/nzbget){:target="\_blank" rel="noopener noreferrer"}!"
|
[{ .off-glb }](https://github.com/nzbgetcom/nzbget){:target="\_blank" rel="noopener noreferrer"}
|
||||||
|
|
||||||
{ .off-glb }
|
- [Basic-Setup](/Downloaders/NZBGet/Basic-Setup/) - Basic set up of the most common settings.
|
||||||
|
- [Path and Categories](/Downloaders/NZBGet/Paths-and-Categories/) - How to set up the categories for NZBGet, and how you can manage and organize your downloads in groups. Starr apps can use the categories in NZBGet to keep track of downloads to monitor, rather than watching every download in your client.
|
||||||
|
- [Scripts](/Downloaders/NZBGet/scripts/) - A collection of scripts, that only should be used if you have a specific need for it.
|
||||||
|
|||||||
@ -1,3 +1,7 @@
|
|||||||
# SABnzbd
|
# SABnzbd
|
||||||
|
|
||||||
{ .off-glb }
|
[{ .off-glb }](https://sabnzbd.org/){:target="\_blank" rel="noopener noreferrer"}
|
||||||
|
|
||||||
|
- [Basic-Setup](/Downloaders/SABnzbd/Basic-Setup/) - Basic set up of the most common settings.
|
||||||
|
- [Path and Categories](/Downloaders/SABnzbd/Paths-and-Categories/) - How to set up the categories for SABnzbd, and how you can manage and organize your downloads in groups. Starr apps can use the categories in SABnzbd to keep track of downloads to monitor, rather than watching every download in your client.
|
||||||
|
- [Scripts](/Downloaders/SABnzbd/scripts/) - A collection of scripts, that only should be used if you have a specific need for it.
|
||||||
|
|||||||
@ -1,3 +1,12 @@
|
|||||||
# qBittorrent
|
# qBittorrent
|
||||||
|
|
||||||
{ .off-glb }
|
[{ .off-glb }](https://www.qbittorrent.org/){:target="\_blank" rel="noopener noreferrer"}
|
||||||
|
|
||||||
|
- [Basic-Setup](/Downloaders/qBittorrent/Basic-Setup/) - Basic set up of the most common settings.
|
||||||
|
- [Paths](/Downloaders/qBittorrent/Paths) - Where to set your root download location.
|
||||||
|
- [How to add Categories](/Downloaders/qBittorrent/How-to-add-categories/) - How to set up the categories for qBittorrent, and how you can manage and organize your torrents in groups. Starr apps can use the categories in qBittorrent to keep track of downloads to monitor, rather than watching every torrent in your client.
|
||||||
|
- [Port forwarding](/Downloaders/qBittorrent/Port-forwarding/) - Where in your download client you should add the port you've port forwarded with your VPN Service.
|
||||||
|
- [3rd Party tools](/Downloaders/qBittorrent/3rd-party-tools/) - A collection of 3rd party tools and other related links for qBittorrent.
|
||||||
|
- Tips - Several tips/tweaks for qBittorrent.
|
||||||
|
- [unRAID Mover and qBittorrent](/Downloaders/qBittorrent/Tips/How-to-run-the-unRaid-mover-for-qBittorrent/) - How to move your files from your cache drive to your array when torrents are still seeding.
|
||||||
|
- [Themes](/Downloaders/qBittorrent/Tips/Themes/) - Themes you can use with qBittorrent.
|
||||||
|
|||||||
@ -1,3 +1,7 @@
|
|||||||
# Misc
|
# Misc
|
||||||
|
|
||||||
Here you will find a collection of random guides we've made.
|
## Miscellaneous guides and info
|
||||||
|
|
||||||
|
- [How to provide a docker compose](/Misc/how-to-provide-a-docker-compose/) - When requested this will show you how to create and provide a docker-compose of your running docker containers.
|
||||||
|
- [Setup TorGuard for port forwarding](/Misc/How-to-setup-Torguard-for-port-forwarding/) - Guide on how to set up port forwarding when you use Torguard as a VPN Service.
|
||||||
|
- [x265-4k and Golden Rule](/Misc/x265-4k/) - Explanation of how 1080p x265 should be used correctly and how it's used often wrongly, and why the guide in general doesn't prefer 1080p x265 releases.
|
||||||
|
|||||||
@ -1,5 +1,10 @@
|
|||||||
# Plex
|
# Plex
|
||||||
|
|
||||||
Here we will start adding Tips and Info for Plex
|
|
||||||
|
|
||||||
{ .off-glb }
|
{ .off-glb }
|
||||||
|
|
||||||
|
## The Following guides are available
|
||||||
|
|
||||||
|
- [Suggested Plex Media Server Settings](/Plex/Tips/Plex-media-server/) - So, what are the best Plex Media Server settings? Here you find recommendations on how to set up your Plex Media Server
|
||||||
|
- [Optimal Plex Client Settings](/Plex/Tips/Optimal-plex-client-settings/) - So, what are the best Plex Client settings? Here you will find a link to a 3rd party site that will provide Optimal settings for all the possible clients that can be used to stream content. While these settings won't be optimal for everyone's setup, they will be for the majority of you.
|
||||||
|
- [What does my media player support](/Plex/what-does-my-media-player-support/) - We've created an Excel sheet with several tested Media Player devices with info that our community has provided. We hope this Excel sheet will be helpful for everyone looking for a reliable Media Player device.
|
||||||
|
- [Stop 4k Video Transcoding](/Plex/Tips/4k-transcoding/) - This guide will walk you through getting started with Tautulli and JBOPS. By the end of this guide you'll be able to stop all 4K video transcodes on your server. Note that this does require a Plex Pass to work.
|
||||||
|
|||||||
@ -0,0 +1,7 @@
|
|||||||
|
nav:
|
||||||
|
- How to Merge Quality: Merge-quality.md
|
||||||
|
- How to rename your folders: Radarr-rename-your-folders.md
|
||||||
|
- How to set up Language Custom Formats: How-to-setup-language-custom-formats.md
|
||||||
|
- How to Sync 2 Radarr or Sonarr with each other: Sync-2-radarr-sonarr.md
|
||||||
|
- Remote Path Mappings: Radarr-remote-path-mapping.md
|
||||||
|
- Show Unknown Movie Items: Radarr-show-unknown-movie-items.md
|
||||||
|
Before Width: | Height: | Size: 23 KiB After Width: | Height: | Size: 23 KiB |
|
Before Width: | Height: | Size: 6.1 KiB After Width: | Height: | Size: 6.1 KiB |
|
Before Width: | Height: | Size: 5.6 KiB After Width: | Height: | Size: 5.6 KiB |
|
Before Width: | Height: | Size: 8.3 KiB After Width: | Height: | Size: 8.3 KiB |
|
Before Width: | Height: | Size: 19 KiB After Width: | Height: | Size: 19 KiB |
|
Before Width: | Height: | Size: 20 KiB After Width: | Height: | Size: 20 KiB |
|
Before Width: | Height: | Size: 9.1 KiB After Width: | Height: | Size: 9.1 KiB |
|
Before Width: | Height: | Size: 19 KiB After Width: | Height: | Size: 19 KiB |
|
Before Width: | Height: | Size: 5.3 KiB After Width: | Height: | Size: 5.3 KiB |
|
Before Width: | Height: | Size: 61 KiB After Width: | Height: | Size: 61 KiB |
|
Before Width: | Height: | Size: 77 KiB After Width: | Height: | Size: 77 KiB |
@ -0,0 +1,7 @@
|
|||||||
|
nav:
|
||||||
|
- How to Merge Quality: Merge-quality.md
|
||||||
|
- How to rename your folders: Sonarr-rename-your-folders.md
|
||||||
|
- How to set up Language Custom Formats: How-to-setup-language-custom-formats.md
|
||||||
|
- How to Sync 2 Radarr or Sonarr with each other: Sync-2-radarr-sonarr.md
|
||||||
|
- Remote Path Mappings: Sonarr-remote-path-mapping.md
|
||||||
|
|
||||||
@ -0,0 +1,3 @@
|
|||||||
|
<!-- markdownlint-disable MD041-->
|
||||||
|
{! include-markdown '../../Radarr/Tips/Radarr-rename-your-folders.md' !}
|
||||||
|
<!-- markdownlint-enable MD041-->
|
||||||
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 48 KiB After Width: | Height: | Size: 48 KiB |
|
Before Width: | Height: | Size: 17 KiB After Width: | Height: | Size: 17 KiB |
|
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 11 KiB |
|
Before Width: | Height: | Size: 7.4 KiB After Width: | Height: | Size: 7.4 KiB |
|
Before Width: | Height: | Size: 20 KiB After Width: | Height: | Size: 20 KiB |
|
Before Width: | Height: | Size: 62 KiB After Width: | Height: | Size: 62 KiB |
@ -1,25 +1,34 @@
|
|||||||
# Sonarr
|
# Sonarr
|
||||||
|
|
||||||
Here you will find a collection of Sonarr guides we've made.
|
## Basic guides
|
||||||
|
|
||||||
!!! info "Sonarr is a PVR for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new episodes of your favorite shows and will grab, sort and rename them. It can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available."
|
For Installation, Quick Start Guide, and the basics of Sonarr, please check the official [WikiArr](https://wiki.servarr.com/en/sonarr){:target="\_blank" rel="noopener noreferrer"}.
|
||||||
|
|
||||||
For Installation and Quick Start Guide please check the official [WikiArr](https://wiki.servarr.com/en/sonarr){:target="\_blank" rel="noopener noreferrer"}
|
### Current Versions
|
||||||
|
|
||||||
## Master
|
{ .off-glb } { .off-glb }
|
||||||
|
|
||||||
{ .off-glb }
|
## Available guides
|
||||||
|
|
||||||
(Default/Stable): This has been tested by users on nightly (`develop`) branch and it's not known to have any major issues. This branch should be used by the majority of users. On GitHub, this is the `main` branch.
|
After setting up your optimal volume/paths found [HERE](/Hardlinks/Hardlinks-and-Instant-Moves/), follow the steps below to improve your setup.
|
||||||
|
|
||||||
## Develop
|
1. [Quality Settings (File Size)](/Sonarr/Sonarr-Quality-Settings-File-Size/) - Some recommendations to prevent low-quality or fake releases. These quality file size settings have been created and tested with information gathered from release comparisons from various sources and information provided by the community.
|
||||||
|
1. [Recommended naming scheme](/Sonarr/Sonarr-recommended-naming-scheme/) - Recommended naming scheme provided with the help of the Sonarr/Radarr (Support) Team and information provided by the community to prevent download loops.
|
||||||
|
1. [How to set up Quality Profiles](/Sonarr/sonarr-setup-quality-profiles/) - How to make the most use of the Custom Formats and shows some specifics of our recommended configuration. You can use these examples to understand how to set up your preferences.
|
||||||
|
- [How to setup Quality Profiles Anime](/Sonarr/sonarr-setup-quality-profiles-anime/) - Same as above but specific for anime.
|
||||||
|
- [How to set up Quality Profiles (French)](/Sonarr/sonarr-setup-quality-profiles-french-en/) - Same as above but specific for French and English Audio.
|
||||||
|
|
||||||
{ .off-glb }
|
---
|
||||||
|
|
||||||
(Alpha/Unstable) : This is the bleeding edge for Sonarr v4 Beta. It is released as soon as code is committed and passes all automated tests. This build may have not been used by us or other users yet. There is no guarantee that it will even run in some cases. This branch is only recommended for advanced users. Issues and self investigation are expected in this branch. On GitHub, this is the develop branch.
|
- [How to import Custom Formats](/Sonarr/sonarr-import-custom-formats/) - How to manually import the Custom Formats from the Guide.
|
||||||
|
- [How to update Custom Formats](/Sonarr/sonarr-how-to-update-custom-formats/) - How to manually upgrade your existing Custom Formats.
|
||||||
|
- [Collection of Custom Formats](/Sonarr/sonarr-collection-of-custom-formats/) - A collection of the most needed and commonly used Custom Formats. These Custom Formats have been collected from discussions on Discord or created with help from others.
|
||||||
|
|
||||||
!!! danger "**Warning: You may not be able to go back to `main` after switching to this branch.** On GitHub, this is the `develop` branch."
|
---
|
||||||
|
|
||||||
### How do I update Sonarr
|
- Tips - Several other guides for Sonarr.
|
||||||
|
- [How to set up Language Custom Formats](/Sonarr/Tips/How-to-setup-language-custom-formats/) - A few examples of how to set up your preferred language Custom Format.
|
||||||
External link to the official [WikiArr](https://wiki.servarr.com/en/sonarr/faq#how-do-i-update-sonarr){:target="\_blank" rel="noopener noreferrer"}.
|
- [How to Merge Quality](/Sonarr/Tips/Merge-quality/) - How to merge quality sources if you prefer to not have Quality Trump All, and let it be handled via Custom Formats.
|
||||||
|
- [Remote Path Mappings](/Sonarr/Sonarr-remote-path-mapping/) - How to set up remote path mapping.
|
||||||
|
- [How to rename your folders](/Sonarr/Tips/Sonarr-rename-your-folders/) - How to rename or change your root folder.
|
||||||
|
- [How to Sync 2 Radarr or Sonarr with each other](/Sonarr/Tips/Sync-2-radarr-sonarr/) - How you can sync two (or more) Radarr/Sonarr instances with each other.
|
||||||
|
|||||||