Merge pull request #905 from TRaSH-/Prowlarr-tips-section

[Prowlarr] tips for Prowlarr

docs/.pages

@@ -2,6 +2,7 @@ nav:
     - Home: index.md
     - Radarr
     - Sonarr
+    - Prowlarr
     - Bazarr
     - Downloaders
     - Plex

docs/Prowlarr/.pages

@@ -0,0 +1,4 @@
+nav:
+    - Home: index.md
+    - How to setup proxy for certain indexers: prowlarr-setup-proxy.md
+    - How to setup FlareSolverr: prowlarr-setup-flaresolverr.md

docs/Prowlarr/index.md

@@ -0,0 +1,47 @@
+# Prowlarr
+
+Here you will find a collection of tips for Prowlarr.
+
+*Prowlarr is an indexer manager/proxy built on the popular arr .net/reactjs base stack to integrate with your various PVR apps. Prowlarr supports management of both Torrent Trackers and Usenet Indexers. It integrates seamlessly with Lidarr, Mylar3, Radarr, Readarr, and Sonarr offering complete management of your indexers with no per app Indexer setup required (we do it all).*
+
+For Installation and Quick Start Guide please check the official [WikiArr](https://wiki.servarr.com/en/prowlarr){:target="_blank" rel="noopener noreferrer"}
+
+## Master
+
+Prowlarr does not yet have a stable release.
+
+## Develop
+
+![develop](https://img.shields.io/badge/dynamic/json?query=%24.version&url=https://raw.githubusercontent.com/hotio/prowlarr/testing/VERSION.json&label=Current%20Develop/Beta%20Version&style=for-the-badge&color=4051B5){ .off-glb }
+
+(Beta): This is the testing edge. Released after being tested in nightly to ensure no immediate issues. New features and bug fixes released here first after nightly. It can be considered semi-stable, but is still `beta`.
+
+This version will receive updates either weekly or biweekly depending on development.
+
+!!! warning
+
+    **You may not be able to go back to `master` after switching to this branch.**
+
+On GitHub, this is a snapshot of the `develop` branch at a specific point in time.
+
+## Nightly
+
+![nightly](https://img.shields.io/badge/dynamic/json?query=%24.version&url=https://raw.githubusercontent.com/hotio/prowlarr/nightly/VERSION.json&label=Current%20Nightly/Unstable%20Version&style=for-the-badge&color=4051B5){ .off-glb }
+
+(Alpha/Unstable) : This is the bleeding edge. It is released as soon as code is committed and passes all automated tests. This build may not have 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.
+
+!!! danger
+
+    ***Use this branch only if you know what you are doing and are willing to get your hands dirty to recover a failed update.***
+
+This version is updated immediately.
+
+!!! warning
+
+    **You may not be able to go back to `master` after switching to this branch.**
+
+On GitHub, this is the `develop` branch.
+
+### How do I update Prowlarr
+
+External link to the official [WikiArr](https://wiki.servarr.com/en/prowlarr/faq#how-do-i-update-prowlarr){:target="_blank" rel="noopener noreferrer"}.

docs/Prowlarr/prowlarr-setup-flaresolverr.md

@@ -0,0 +1,48 @@
+# How to setup FlareSolverr
+
+[FlareSolverr](https://github.com/FlareSolverr/FlareSolverr){:target="_blank" rel="noopener noreferrer"} is a proxy server to bypass Cloudflare and DDoS-GUARD protection.
+
+!!! info
+
+    - A FlareSolverr Proxy will only be used for requests if and only if Cloudflare is detected by Prowlarr
+    - A FlareSolverr Proxy will only be used for requests if and only if the Proxy and the Indexer have matching tags
+    - A Flaresolverr Proxy configured without any tags or has no indexers with matching tags it will be disabled.
+
+## Install FlareSolverr
+
+Please follow the installation instruction from [FlareSolverr](https://github.com/FlareSolverr/FlareSolverr#installation){:target="_blank" rel="noopener noreferrer"}
+
+## Add FlareSolverr to Prowlarr
+
+`Settings` => `indexers`
+
+![Settings => images](images/settings-indexers.png)
+
+Click on the + sign and select `FlareSolverr`
+
+![Add Indexers](images/add-indexer-proxy-flaresolverr.png)
+
+Add the following info
+
+![Add Proxy FlareSolverr](images/add-proxy-flaresolverr.png)
+
+1. Name of the Proxy in Prowlarr.
+1. The tags for this proxy.
+1. The full host path (include http and the port) to your FlareSolverr instance.
+1. The [FlareSolver Request maxTimeout value](https://github.com/FlareSolverr/FlareSolverr#-requestget){:target="_blank" rel="noopener noreferrer"} Prowlarr should use for FlareSolverr requests. Must be between `1` second and `180` seconds (Default: `60` seconds).
+1. Test if your connection works.
+1. If it works click on `Save`.
+
+## Add FlareSolverr to your indexer
+
+Select the indexer that you want to use with FlareSolverr
+
+![Select Indexer](images/select-indexer.png)
+
+Scroll down to the bottom and add the tag you've set up earlier at step 2.
+
+![Add tag to indexer](images/add-tag-to-indexer-flaresolverr.png)
+
+Click `Test` and `Save`.
+
+Now the indexer should be using FlareSolverr.

docs/Prowlarr/prowlarr-setup-proxy.md

@@ -0,0 +1,55 @@
+# Setup proxy for certain indexers
+
+It's not recommended to run the Starr apps through a VPN,  what can happen is that the Starr apps doesn't update the posters or metadata or you can't add new movies/tv shows, it doesn't need to happen right away. but sooner or later it can and probably will happen.
+
+Just run VPN on the apps that actually need it, like your torrent client, and perhaps in some cases certain indexers because of region/ISP restriction.
+
+!!! warning
+    Please check the indexers rules if you're allowed to use a VPN/Proxy to access their site, being that VPN services often use shared IP it could be recognized as account sharing.
+
+    This isn't the same as the tracker, the API/Website scraping happens on the actual site and some indexers don't allow VPN usage on their site.
+
+In this guide i will try to explain how to setup Prowlarr to use your VPN from your torrent client.
+
+## Enable privoxy
+
+If you use docker you need to enable enable privoxy in you torrent client so you can use it to passthrough traffic.
+
+Please check your used docker image how to enable privoxy.
+
+## Add privoxy to Prowlarr
+
+`Settings` => `indexers`
+
+![Settings => images](images/settings-indexers.png)
+
+Click on the + sign and select `http`
+
+![Add Indexers](images/add-indexer-proxy-http.png)
+
+Add the following info
+
+![Add Proxy http](images/add-proxy-http.png)
+
+1. Name of the Proxy in Prowlarr.
+1. The tags for this proxy. Proxies apply to all matching (same tag) indexers. If blank this proxy applies to all indexers.
+1. Host name to your torrent client.
+1. Used port for privoxy (default for privoxy: 8118).
+1. User name for your torrent client.
+1. Password for your torrent client.
+1. Test if your connection works.
+1. If it works click on `Save`.
+
+## Add privoxy to your indexer
+
+Select the indexer that you want to use with Privoxy
+
+![Select Indexer](images/select-indexer.png)
+
+Scroll down to the bottom and add the tag you've set up earlier at step 2.
+
+![Add tag to indexer](images/add-tag-to-indexer-privoxy.png)
+
+Click `Test` and `Save`.
+
+Now the indexer should be using the VPN of your torrent client.

docs/updates.txt

@@ -1,3 +1,8 @@
+# 2022-10-18 21:20
+**[Prowlarr] Tips for Prowlarr**
+- NEW: How to Setup proxy for certain indexers. #905
+- NEW: How to Setup FlareSolverr. #905
+
 # 2022-10-12 19:25
 **[Guide - Starr Custom Formats]**
 - Added: Audio Flowchart (Hopefully to make the logic/choices more clear). #898

mkdocs.yml

@@ -54,7 +54,16 @@ plugins:
       locale: en
   #    fallback_to_build_date: false
   - awesome-pages
-  - glightbox
+  - glightbox:
+      touchNavigation: true
+      loop: false
+      effect: zoom
+      width: 100%
+      height: auto
+      zoomable: true
+      draggable: true
+      auto_caption: false
+      caption_position: bottom
   - macros:
       j2_block_start_string: "[[%"
       j2_block_end_string: "%]]"