From 5ee33d2f8e5d38e6239bd3464e54aefab3535065 Mon Sep 17 00:00:00 2001 From: jrcorwin Date: Fri, 13 Sep 2024 10:32:47 -0400 Subject: [PATCH 1/9] Update riven.md --- docs/app/riven.md | 154 +++++++++++++++++++++++++++++++++++++++------- 1 file changed, 133 insertions(+), 21 deletions(-) diff --git a/docs/app/riven.md b/docs/app/riven.md index 591d568..a33fc91 100644 --- a/docs/app/riven.md +++ b/docs/app/riven.md @@ -28,6 +28,10 @@ Riven (*previously Iceberg*) is a re-imagining of original functions of [plex-de Unlike most ElfHosted apps, Riven is (currently) split into two - the frontend, and the backend: +### Meet the frontend UI + +A lot of progress has been made on the frontend UI! It can be used for the entire on-boarding process, with the exception of the quality/ranking settings. These settings are currently configuired in the `settings.json` file found in `config/riven via [FileBrowser][filebrowser]. All of the other settings can be directly modified with the frontend UI, in addition to a number of Riven functions. + ### Meet the backend The Riven backend is what's functionally complete. On the backend, you'll see the logs displayed as Riven searches for your content, adds it to your RealDebrid library, symlinks it to `/storage/symlinks`, and updates Plex accordingly @@ -36,14 +40,6 @@ The Riven backend is what's functionally complete. On the backend, you'll see th To restart the backend, hit `CTRL-C` once in the ttyd/browser UI to terminate the process, and then hit `Enter` to reconnect to the session and watch it restart. -### Meet the frontend - -The frontend UI is a work-in-progress, but there are enough pieces in place to enable a basic onboarding. The frontend is also critical for setting up Plex authentication. - -### Making configuration changes - -Until the frontend UI is completed, configuration changes are effected by updating `settings.json` in `config/riven`, via [FileBrowser][filebrowser]. - ### Minimum requirements At a minimum, Riven requires: @@ -56,43 +52,159 @@ And optionally, Riven will work with: * [ ] An [Overseerr][overseerr] instance, for managing media requests * [ ] A [Jackett][jackett] instance, to provide additional content scraping targets +* [ ] A [Prowlarr][prowlarr] instance, to provide additional content scraping targets ### Basic setup -#### Overseerr +#### Zurg -To integrate Overseerr with Riven, setup Overseerr to integrate with Plex, and then.. +First and formost, you **must** first setup Zurg before any setup can be completed with Riven itself. -* :one: Get your API key: +* :one: Retrive your Real-Debrid API token via (their website)[https://real-debrid.com/apitoken]. +* :two: Navigate to Zurg's `confiig.yml` file found in `config/riven` via [FileBrowser][filebrowser]. +* :three: Add your Real-Debrid token Zurg's `confiig.yml` file and save your changes. +* :four: Restart Zurg, either by using the Elfbot command `elfbot restart realdebird-zurg` or by deleting the pod for Zurg via [Kubernetes][kubernetes]. -![](/images/riven-overseerr-1.png) +#### Plex + +**Claim your Plex server:** + +* :one: Generate your token! Use this nifty (Plex Token Generator)[https://plex-token-generator.elfhosted.com] tool to generate a Plex token. Enter an any product name you'd like (it doesn't matter what it is), an any client ID you'd like (it doesn't matter what it is). Click on `Generate PIN` and then the link to https://www.plex.tv/link/. Input your PIN on the "Link Account" screen. Your token will now be displayed in the Plex Token Generator for you to use. +* :two: Navigate to [FileBrowser][filebrowser] from your Dashboard and issue the following command: + ```elfbot claim plex YourTokenGoesHere``` +* :three: Restart your Plex Server: + ```elfbot restart plex``` + +**Create your Plex libraries:** + +Using the Plex button on your Dashboard, go to your newly claimed Plex server. + +* :one: Create a library for you Movies and set the path to `/storage/symlinks/movies/`. +* :two: Create a library for you TV Shows and set the path to `/storage/symlinks/shows/`. +#### ***NOTE:*** *Make certain you are not enabling any of the features to generate thumbnails or intro/credit detection.* + +#### Overseerr + +#### ***NOTE:*** *Some of the Overseerr setup is already done by default for new installations or following a reset of the Overseerr app.* + +To integrate Overseerr with Riven, first setup Overseerr to integrate with Plex, and then... -* :two: Configure a webhook pointing to `http://riven:8080/webhook/overseerr`: +* :one: Configure a webhook pointing to `http://riven:8080/webhook/overseerr`: ![](/images/riven-overseerr-2.png) -* :three: Enable your webhook for `Request Automatically Approved` and `Request Approved`: +* :two: Enable your webhook for `Request Automatically Approved` and `Request Approved`: ![](/images/riven-overseerr-3.png) -#### Frontend +* :one: Retrieve your Overseerr API key, which will be used in Riven: + +![](/images/riven-overseerr-1.png) + +#### Riven Frontend UI To perform a basic Riven setup, use the frontend, and navigate to Settings: ![](/images/riven-settings-1.png) -Under **General**, ensure your RealDebrid API token is applied and correct (get it [here](https://real-debrid.com/apitoken)): - -![](/images/riven-settings-2.png) +* :one: General Settings + - Enable your chosen option in the `Downloaders` section. + - Input your API key for that downloader. + - Save your changes. + +![](/images/riven-settings-2.png) -Under **Media Server**, click `Authenticate with Plex` to retrieve the token necessary for Riven to interact with Plex: +* :two: Media Server Settings + - Enable `Plex Updater` in the `Updaters` section. + - Authenticate your Plex server within the `Plex Token` section. + - Save your changes. ![](/images/riven-settings-3.png) -Under **Content**, paste in your Overseerr API key, and enable `Overseerr Use Webhook`: +* :three: Content + - Enable your preferred options (you must choose at least one) in the `Content Providers` section. + - Please see the `Content Request Providers` sections found below. + - Apply the relevant settings. + - Save your changes. + +![](/images/riven-settings-4.png) +* :four: Scrapers + - Enable `Torrentio`, `Knightcrawler`, `Annatar`, `Mediafusion`, and `Zilean`. (up to you if you want use the others) + - Enable `Ratelimit` for all of them, except for `Zilean`. + - Save your changes. + ![](/images/riven-settings-4.png) +* :five: Ranking +***Note:*** *These settings are currently being reworked and dramatically improved. They will soon appear in the Riven frontend UI. Currently, these settings are configuired in the `settings.json` file found in `config/riven` via [FileBrowser][filebrowser].* + +Pick a quality profile. Riven, in it's current form, has some built-in quality profiles and these profiles have their own rankings for specific attributes: + +- `default` *(DefaultRanking): The default ranking model.* +- `remux` *(BestRemuxRanking): The ranking model for the best remux.* +- `web` *(BestWebRanking): The ranking model for the best web release.* +- `resolution` *(BestResolutionRanking): The ranking model for the best resolution.* +- `overall` *(BestOverallRanking): The ranking model for the best overall quality.* +- `anime` *(AnimeRanking): The ranking model for anime releases.* +- `all` *(AllRanking): The ranking model for all releases.* + +Most will pick `overall`, `resolution`, or `remux`. + +- Replace `"default"` with your chosen profile: +``` + "ranking": { + "profile": "overall", +``` +- For `"require"`, `"exclude"`, and `"preferred"` please refer to (#🗻┆elf-riven)[https://discord.com/channels/396055506072109067/1253110932062601276] and/or its pinned posts. +- The items below are the various attributes Riven will rank. If you are going to follow the rankings set by your chosen profile, ignore the `"enable"` and `"rank"` fields. +- The `"fetch"` settings are essentially your on/off switch for each of these attributes. Set the ones you want to `true` and set the ones you do not want to `false`. +- The `"enable"` and `"rank"` fields are **only** used if you wish to override the rankings established in the pre-configured quality profile you have chosen. + - The `"enable"` setting, with a `true` or `false` value, enables or disables your custom rank for any individual attribute. + - The `"rank"` setting, with a numerical value, establishes your custom rank for any individual attribute. + ***Note:*** *Rankings for individual attributes accumulate. If a file matches three attributes with individual rankings of `100`, the overall rank of that file will be `300`. Files are then ranked by their overall score. +- Save your changes. +- Restart Riven, either by using the Elfbot command `elfbot restart realdebird-zurg` or by deleting the pod for Zurg via [Kubernetes][kubernetes]. + +### Content Request Providers *(you must choose at least one)* + +#### Plex Watchlist + +* :one: Navigate to the Watchlist section of your Plex Media Server settings. + ``` + https://-plex.elfhosted.cc/web/index.html#!/settings/watchlist + ``` +* :two: Copy the appropriate washlist RSS feed link(s) +* :three: Enable `Plex Watchlist` within the Riven frontend UI `Content` section of its settings. +* :three: Add the RSS feed link(s) to the `Plex Watchlist Rss` setting. +* :four: Save your changes. + +#### Overseerr + +* :one: Retrieve your Overseerr API key: + +![](/images/riven-overseerr-1.png) + +* :two: Enable `Overseerr` within the Riven frontend UI `Content` section of its settings. +* :three: Apply the relevant settings: + - The Overseerr URL is `http://overseerr:5055` + - Add your Overseerr API key. + - Enable the `Use Webhook` setting. +* :four: Save your changes. + +#### Trakt + +* :one: Visit the (Create a Trakt API app)[https://trakt.tv/oauth/applications/new] page. +* :two: Name it whatever you like. +* :three: For `Redirect uri:` use the default value of `urn:ietf:wg:oauth:2.0:oob`. +* :four: `Description:`, `Javascript (cors) origins:`, and `Permissions:`can be left blank/default. +* :five: Click on `SAVE APP`. +* :six: Enable `Trakt` within the Riven frontend UI `Content` section of its settings. +* :seven: Apply the relevant settings: + - Use the `Client ID:` provided is your `Trakt Api Key`. + - The various Trakt functions are optional, but you should enable one or more of them if you wish to use Trakt with Riven. +* :eight: Save your changes. + That's it, a minimal configuration! :partying_face: Now load the backend, and watch the magic! :magic_wand: -{% include 'app_footer.md' %} \ No newline at end of file +{% include 'app_footer.md' %} From 21dfa7eb284e70116e3858c84b98036edd554285 Mon Sep 17 00:00:00 2001 From: jrcorwin Date: Fri, 13 Sep 2024 10:38:48 -0400 Subject: [PATCH 2/9] Update riven.md --- docs/app/riven.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/app/riven.md b/docs/app/riven.md index a33fc91..da35a05 100644 --- a/docs/app/riven.md +++ b/docs/app/riven.md @@ -166,6 +166,8 @@ Most will pick `overall`, `resolution`, or `remux`. - Save your changes. - Restart Riven, either by using the Elfbot command `elfbot restart realdebird-zurg` or by deleting the pod for Zurg via [Kubernetes][kubernetes]. +![](/images/riven-settings-4.png) + ### Content Request Providers *(you must choose at least one)* #### Plex Watchlist From 802f0cd999afcdc0b0e71c1f649c339e86362409 Mon Sep 17 00:00:00 2001 From: jrcorwin Date: Sun, 22 Sep 2024 17:19:33 -0400 Subject: [PATCH 3/9] Update riven.md Updated the section for quality rankings/settings --- docs/app/riven.md | 39 +++++++++------------------------------ 1 file changed, 9 insertions(+), 30 deletions(-) diff --git a/docs/app/riven.md b/docs/app/riven.md index da35a05..c13973f 100644 --- a/docs/app/riven.md +++ b/docs/app/riven.md @@ -137,36 +137,15 @@ To perform a basic Riven setup, use the frontend, and navigate to Settings: ![](/images/riven-settings-4.png) * :five: Ranking -***Note:*** *These settings are currently being reworked and dramatically improved. They will soon appear in the Riven frontend UI. Currently, these settings are configuired in the `settings.json` file found in `config/riven` via [FileBrowser][filebrowser].* - -Pick a quality profile. Riven, in it's current form, has some built-in quality profiles and these profiles have their own rankings for specific attributes: - -- `default` *(DefaultRanking): The default ranking model.* -- `remux` *(BestRemuxRanking): The ranking model for the best remux.* -- `web` *(BestWebRanking): The ranking model for the best web release.* -- `resolution` *(BestResolutionRanking): The ranking model for the best resolution.* -- `overall` *(BestOverallRanking): The ranking model for the best overall quality.* -- `anime` *(AnimeRanking): The ranking model for anime releases.* -- `all` *(AllRanking): The ranking model for all releases.* - -Most will pick `overall`, `resolution`, or `remux`. - -- Replace `"default"` with your chosen profile: -``` - "ranking": { - "profile": "overall", -``` -- For `"require"`, `"exclude"`, and `"preferred"` please refer to (#🗻┆elf-riven)[https://discord.com/channels/396055506072109067/1253110932062601276] and/or its pinned posts. -- The items below are the various attributes Riven will rank. If you are going to follow the rankings set by your chosen profile, ignore the `"enable"` and `"rank"` fields. -- The `"fetch"` settings are essentially your on/off switch for each of these attributes. Set the ones you want to `true` and set the ones you do not want to `false`. -- The `"enable"` and `"rank"` fields are **only** used if you wish to override the rankings established in the pre-configured quality profile you have chosen. - - The `"enable"` setting, with a `true` or `false` value, enables or disables your custom rank for any individual attribute. - - The `"rank"` setting, with a numerical value, establishes your custom rank for any individual attribute. - ***Note:*** *Rankings for individual attributes accumulate. If a file matches three attributes with individual rankings of `100`, the overall rank of that file will be `300`. Files are then ranked by their overall score. -- Save your changes. -- Restart Riven, either by using the Elfbot command `elfbot restart realdebird-zurg` or by deleting the pod for Zurg via [Kubernetes][kubernetes]. + * *These settings will soon appear in the Riven frontend UI. Currently, these settings are configuired in the `settings.json` file found in `config/riven` via [FileBrowser][filebrowser].* -![](/images/riven-settings-4.png) +### Quality Rankings and Settings + +Please refer to these guides: + +* [**Frequently Asked Questions**](https://dreulavelle.github.io/rank-torrent-name/users/faq/) +* [**Language Support**](https://dreulavelle.github.io/rank-torrent-name/users/languages/) +* [**Quality Profiles**](https://dreulavelle.github.io/rank-torrent-name/users/profiles/) ### Content Request Providers *(you must choose at least one)* @@ -196,7 +175,7 @@ Most will pick `overall`, `resolution`, or `remux`. #### Trakt -* :one: Visit the (Create a Trakt API app)[https://trakt.tv/oauth/applications/new] page. +* :one: Visit the [**Create a Trakt API app**](https://trakt.tv/oauth/applications/new) page. * :two: Name it whatever you like. * :three: For `Redirect uri:` use the default value of `urn:ietf:wg:oauth:2.0:oob`. * :four: `Description:`, `Javascript (cors) origins:`, and `Permissions:`can be left blank/default. From fc38b5eb4f1108b63505cc4e77ce161bb1b19ee1 Mon Sep 17 00:00:00 2001 From: jrcorwin Date: Sun, 22 Sep 2024 18:13:47 -0400 Subject: [PATCH 4/9] Update riven.md --- docs/app/riven.md | 74 ++++++++++++++++++++++------------------------- 1 file changed, 35 insertions(+), 39 deletions(-) diff --git a/docs/app/riven.md b/docs/app/riven.md index c13973f..b5e0a57 100644 --- a/docs/app/riven.md +++ b/docs/app/riven.md @@ -60,44 +60,40 @@ And optionally, Riven will work with: First and formost, you **must** first setup Zurg before any setup can be completed with Riven itself. -* :one: Retrive your Real-Debrid API token via (their website)[https://real-debrid.com/apitoken]. -* :two: Navigate to Zurg's `confiig.yml` file found in `config/riven` via [FileBrowser][filebrowser]. -* :three: Add your Real-Debrid token Zurg's `confiig.yml` file and save your changes. -* :four: Restart Zurg, either by using the Elfbot command `elfbot restart realdebird-zurg` or by deleting the pod for Zurg via [Kubernetes][kubernetes]. +1. Retrive your Real-Debrid API token via [their website](https://real-debrid.com/apitoken). +2. Navigate to Zurg's `config.yml` file found in `config/riven` via [FileBrowser][filebrowser]. +3. Add your Real-Debrid token Zurg's `confiig.yml` file and save your changes. +4. Restart Zurg, either by using the Elfbot command `elfbot restart realdebird-zurg` or by deleting the pod for Zurg via [Kubernetes][kubernetes]. #### Plex **Claim your Plex server:** -* :one: Generate your token! Use this nifty (Plex Token Generator)[https://plex-token-generator.elfhosted.com] tool to generate a Plex token. Enter an any product name you'd like (it doesn't matter what it is), an any client ID you'd like (it doesn't matter what it is). Click on `Generate PIN` and then the link to https://www.plex.tv/link/. Input your PIN on the "Link Account" screen. Your token will now be displayed in the Plex Token Generator for you to use. -* :two: Navigate to [FileBrowser][filebrowser] from your Dashboard and issue the following command: - ```elfbot claim plex YourTokenGoesHere``` -* :three: Restart your Plex Server: - ```elfbot restart plex``` +* See [this guide][plex-token] for instructions regarding claiming your Plex token. **Create your Plex libraries:** Using the Plex button on your Dashboard, go to your newly claimed Plex server. -* :one: Create a library for you Movies and set the path to `/storage/symlinks/movies/`. -* :two: Create a library for you TV Shows and set the path to `/storage/symlinks/shows/`. -#### ***NOTE:*** *Make certain you are not enabling any of the features to generate thumbnails or intro/credit detection.* +1. Create a library for you Movies and set the path to `/storage/symlinks/movies/`. +2. Create a library for you TV Shows and set the path to `/storage/symlinks/shows/`. + ***NOTE:*** *Make certain you are not enabling any of the features to generate thumbnails or intro/credit detection.* #### Overseerr -#### ***NOTE:*** *Some of the Overseerr setup is already done by default for new installations or following a reset of the Overseerr app.* + ***NOTE:*** *Some of the Overseerr setup is already done by default for new installations or following a reset of the Overseerr app.* To integrate Overseerr with Riven, first setup Overseerr to integrate with Plex, and then... -* :one: Configure a webhook pointing to `http://riven:8080/webhook/overseerr`: +1. Configure a webhook pointing to `http://riven:8080/webhook/overseerr`: ![](/images/riven-overseerr-2.png) -* :two: Enable your webhook for `Request Automatically Approved` and `Request Approved`: +2. Enable your webhook for `Request Automatically Approved` and `Request Approved`: ![](/images/riven-overseerr-3.png) -* :one: Retrieve your Overseerr API key, which will be used in Riven: +3. Retrieve your Overseerr API key, which will be used in Riven: ![](/images/riven-overseerr-1.png) @@ -107,21 +103,21 @@ To perform a basic Riven setup, use the frontend, and navigate to Settings: ![](/images/riven-settings-1.png) -* :one: General Settings +1. General Settings - Enable your chosen option in the `Downloaders` section. - Input your API key for that downloader. - Save your changes. ![](/images/riven-settings-2.png) -* :two: Media Server Settings +2. Media Server Settings - Enable `Plex Updater` in the `Updaters` section. - Authenticate your Plex server within the `Plex Token` section. - Save your changes. ![](/images/riven-settings-3.png) -* :three: Content +3. Content - Enable your preferred options (you must choose at least one) in the `Content Providers` section. - Please see the `Content Request Providers` sections found below. - Apply the relevant settings. @@ -129,14 +125,14 @@ To perform a basic Riven setup, use the frontend, and navigate to Settings: ![](/images/riven-settings-4.png) -* :four: Scrapers +4. Scrapers - Enable `Torrentio`, `Knightcrawler`, `Annatar`, `Mediafusion`, and `Zilean`. (up to you if you want use the others) - Enable `Ratelimit` for all of them, except for `Zilean`. - Save your changes. -![](/images/riven-settings-4.png) +![](/images/screenshots/riven-scrapers-3.png) -* :five: Ranking +5. Ranking * *These settings will soon appear in the Riven frontend UI. Currently, these settings are configuired in the `settings.json` file found in `config/riven` via [FileBrowser][filebrowser].* ### Quality Rankings and Settings @@ -151,40 +147,40 @@ Please refer to these guides: #### Plex Watchlist -* :one: Navigate to the Watchlist section of your Plex Media Server settings. +1. Navigate to the Watchlist section of your Plex Media Server settings. ``` https://-plex.elfhosted.cc/web/index.html#!/settings/watchlist ``` -* :two: Copy the appropriate washlist RSS feed link(s) -* :three: Enable `Plex Watchlist` within the Riven frontend UI `Content` section of its settings. -* :three: Add the RSS feed link(s) to the `Plex Watchlist Rss` setting. -* :four: Save your changes. +2. Copy the appropriate washlist RSS feed link(s) +3. Enable `Plex Watchlist` within the Riven frontend UI `Content` section of its settings. +4. Add the RSS feed link(s) to the `Plex Watchlist Rss` setting. +5. Save your changes. #### Overseerr -* :one: Retrieve your Overseerr API key: +1. Retrieve your Overseerr API key: ![](/images/riven-overseerr-1.png) -* :two: Enable `Overseerr` within the Riven frontend UI `Content` section of its settings. -* :three: Apply the relevant settings: +2. Enable `Overseerr` within the Riven frontend UI `Content` section of its settings. +3. Apply the relevant settings: - The Overseerr URL is `http://overseerr:5055` - Add your Overseerr API key. - Enable the `Use Webhook` setting. -* :four: Save your changes. +4. Save your changes. #### Trakt -* :one: Visit the [**Create a Trakt API app**](https://trakt.tv/oauth/applications/new) page. -* :two: Name it whatever you like. -* :three: For `Redirect uri:` use the default value of `urn:ietf:wg:oauth:2.0:oob`. -* :four: `Description:`, `Javascript (cors) origins:`, and `Permissions:`can be left blank/default. -* :five: Click on `SAVE APP`. -* :six: Enable `Trakt` within the Riven frontend UI `Content` section of its settings. -* :seven: Apply the relevant settings: +1. Visit the [**Create a Trakt API app**](https://trakt.tv/oauth/applications/new) page. +2. Name it whatever you like. +3. For `Redirect uri:` use the default value of `urn:ietf:wg:oauth:2.0:oob`. +4. `Description:`, `Javascript (cors) origins:`, and `Permissions:`can be left blank/default. +5. Click on `SAVE APP`. +6. Enable `Trakt` within the Riven frontend UI `Content` section of its settings. +7. Apply the relevant settings: - Use the `Client ID:` provided is your `Trakt Api Key`. - The various Trakt functions are optional, but you should enable one or more of them if you wish to use Trakt with Riven. -* :eight: Save your changes. +8. Save your changes. That's it, a minimal configuration! :partying_face: Now load the backend, and watch the magic! :magic_wand: From c102674c915277758d602c6ef3274540a7a3d442 Mon Sep 17 00:00:00 2001 From: jrcorwin Date: Sun, 22 Sep 2024 18:27:17 -0400 Subject: [PATCH 5/9] Update riven.md --- docs/app/riven.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/app/riven.md b/docs/app/riven.md index b5e0a57..76d9037 100644 --- a/docs/app/riven.md +++ b/docs/app/riven.md @@ -104,31 +104,31 @@ To perform a basic Riven setup, use the frontend, and navigate to Settings: ![](/images/riven-settings-1.png) 1. General Settings - - Enable your chosen option in the `Downloaders` section. - - Input your API key for that downloader. - - Save your changes. + * Enable your chosen option in the `Downloaders` section. + * Input your API key for that downloader. + * Save your changes. ![](/images/riven-settings-2.png) 2. Media Server Settings - - Enable `Plex Updater` in the `Updaters` section. - - Authenticate your Plex server within the `Plex Token` section. - - Save your changes. + * Enable `Plex Updater` in the `Updaters` section. + * Authenticate your Plex server within the `Plex Token` section. + * Save your changes. ![](/images/riven-settings-3.png) 3. Content - - Enable your preferred options (you must choose at least one) in the `Content Providers` section. - - Please see the `Content Request Providers` sections found below. - - Apply the relevant settings. - - Save your changes. + * Enable your preferred options (you must choose at least one) in the `Content Providers` section. + * Please see the `Content Request Providers` sections found below. + * Apply the relevant settings. + * Save your changes. ![](/images/riven-settings-4.png) 4. Scrapers - - Enable `Torrentio`, `Knightcrawler`, `Annatar`, `Mediafusion`, and `Zilean`. (up to you if you want use the others) - - Enable `Ratelimit` for all of them, except for `Zilean`. - - Save your changes. + * Enable `Torrentio`, `Knightcrawler`, `Annatar`, `Mediafusion`, and `Zilean`. (up to you if you want use the others) + * Enable `Ratelimit` for all of them, except for `Zilean`. + * Save your changes. ![](/images/screenshots/riven-scrapers-3.png) From 564babafb74a4865350740a4f416855c3143c0b5 Mon Sep 17 00:00:00 2001 From: jrcorwin Date: Sun, 22 Sep 2024 18:44:36 -0400 Subject: [PATCH 6/9] Update riven.md --- docs/app/riven.md | 38 +++++++++++++++++++------------------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/docs/app/riven.md b/docs/app/riven.md index 76d9037..27bdc23 100644 --- a/docs/app/riven.md +++ b/docs/app/riven.md @@ -103,37 +103,37 @@ To perform a basic Riven setup, use the frontend, and navigate to Settings: ![](/images/riven-settings-1.png) -1. General Settings - * Enable your chosen option in the `Downloaders` section. - * Input your API key for that downloader. - * Save your changes. +**General Settings** +1. Enable your chosen option in the `Downloaders` section. +2. Input your API key for that downloader. +3. Save your changes. ![](/images/riven-settings-2.png) -2. Media Server Settings - * Enable `Plex Updater` in the `Updaters` section. - * Authenticate your Plex server within the `Plex Token` section. - * Save your changes. +**Media Server Settings** +1. Enable `Plex Updater` in the `Updaters` section. +2. Authenticate your Plex server within the `Plex Token` section. +3. Save your changes. ![](/images/riven-settings-3.png) -3. Content - * Enable your preferred options (you must choose at least one) in the `Content Providers` section. - * Please see the `Content Request Providers` sections found below. - * Apply the relevant settings. - * Save your changes. +**Content** +1. Enable your preferred options (you must choose at least one) in the `Content Providers` section. + *Please see the `Content Request Providers` sections found below.* +2. Apply the relevant settings. +3. Save your changes. ![](/images/riven-settings-4.png) -4. Scrapers - * Enable `Torrentio`, `Knightcrawler`, `Annatar`, `Mediafusion`, and `Zilean`. (up to you if you want use the others) - * Enable `Ratelimit` for all of them, except for `Zilean`. - * Save your changes. +**Scrapers** +1. Enable `Torrentio`, `Knightcrawler`, `Annatar`, `Mediafusion`, and `Zilean`. (up to you if you want use others) +2. Enable `Ratelimit` for all of them, except for `Zilean`. +3. Save your changes. ![](/images/screenshots/riven-scrapers-3.png) -5. Ranking - * *These settings will soon appear in the Riven frontend UI. Currently, these settings are configuired in the `settings.json` file found in `config/riven` via [FileBrowser][filebrowser].* +**Ranking** +* *These settings will soon appear in the Riven frontend UI. Currently, these settings are configuired in the `settings.json` file found in `config/riven` via [FileBrowser][filebrowser].* ### Quality Rankings and Settings From 601b229559224f2d742825311f27e80fe1764af9 Mon Sep 17 00:00:00 2001 From: jrcorwin Date: Sun, 22 Sep 2024 18:56:26 -0400 Subject: [PATCH 7/9] Update riven.md --- docs/app/riven.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/app/riven.md b/docs/app/riven.md index 27bdc23..574875b 100644 --- a/docs/app/riven.md +++ b/docs/app/riven.md @@ -104,31 +104,31 @@ To perform a basic Riven setup, use the frontend, and navigate to Settings: ![](/images/riven-settings-1.png) **General Settings** -1. Enable your chosen option in the `Downloaders` section. -2. Input your API key for that downloader. -3. Save your changes. +1. Enable your chosen option in the `Downloaders` section. +2. Input your API key for that downloader. +3. Save your changes. ![](/images/riven-settings-2.png) **Media Server Settings** -1. Enable `Plex Updater` in the `Updaters` section. -2. Authenticate your Plex server within the `Plex Token` section. -3. Save your changes. +1. Enable `Plex Updater` in the `Updaters` section. +2. Authenticate your Plex server within the `Plex Token` section. +3. Save your changes. ![](/images/riven-settings-3.png) **Content** -1. Enable your preferred options (you must choose at least one) in the `Content Providers` section. - *Please see the `Content Request Providers` sections found below.* -2. Apply the relevant settings. -3. Save your changes. +1. Enable your preferred options (you must choose at least one) in the `Content Providers` section. + *Please see the `Content Request Providers` sections found below.* +2. Apply the relevant settings. +3. Save your changes. ![](/images/riven-settings-4.png) **Scrapers** -1. Enable `Torrentio`, `Knightcrawler`, `Annatar`, `Mediafusion`, and `Zilean`. (up to you if you want use others) -2. Enable `Ratelimit` for all of them, except for `Zilean`. -3. Save your changes. +1. Enable `Torrentio`, `Knightcrawler`, `Annatar`, `Mediafusion`, and `Zilean`. (up to you if you want use others) +2. Enable `Ratelimit` for all of them, except for `Zilean`. +3. Save your changes. ![](/images/screenshots/riven-scrapers-3.png) From ec799da2bf332cb70258fb92dd0ccbb113f7afad Mon Sep 17 00:00:00 2001 From: jrcorwin Date: Tue, 24 Sep 2024 20:07:03 -0400 Subject: [PATCH 8/9] Update riven.md --- docs/app/riven.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/app/riven.md b/docs/app/riven.md index 574875b..1fd26fa 100644 --- a/docs/app/riven.md +++ b/docs/app/riven.md @@ -17,7 +17,7 @@ links: # {{ page.meta.slug }} -Riven (*previously Iceberg*) is a re-imagining of original functions of [plex-debrid][plex-debrid], enabling Plex-based torrent streaming through Real Debrid and 3rd party services like Overseerr, Mdblist, etc. +Riven is a re-imagining of original functions of [plex-debrid][plex-debrid], enabling Plex-based torrent streaming through Real Debrid and 3rd party services like Overseerr, Mdblist, etc. !!! tip "Riven gets revenue! :heart:" Riven is an "Elf-illiated" app - the devs are actively supporting users in our [Discord][discord] community, the app itself is tuned to work perfectly with ElfHosted "out-of-the-box", and 100% of your subscriptions are contributed to the Riven devs to further development! From 108c29241ba10b6ada54a842d970fa91b2fd4165 Mon Sep 17 00:00:00 2001 From: jrcorwin Date: Tue, 24 Sep 2024 20:23:02 -0400 Subject: [PATCH 9/9] Update riven.md --- docs/app/riven.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/app/riven.md b/docs/app/riven.md index 1fd26fa..c5faea7 100644 --- a/docs/app/riven.md +++ b/docs/app/riven.md @@ -127,13 +127,13 @@ To perform a basic Riven setup, use the frontend, and navigate to Settings: **Scrapers** 1. Enable `Torrentio`, `Knightcrawler`, `Annatar`, `Mediafusion`, and `Zilean`. (up to you if you want use others) -2. Enable `Ratelimit` for all of them, except for `Zilean`. +2. Enable `Ratelimit` for all scrapers. 3. Save your changes. -![](/images/screenshots/riven-scrapers-3.png) +![](/images/riven-scrapers-3.png) **Ranking** -* *These settings will soon appear in the Riven frontend UI. Currently, these settings are configuired in the `settings.json` file found in `config/riven` via [FileBrowser][filebrowser].* +##### **Note:** *These settings will soon appear in the Riven frontend UI. Currently, these settings are configuired in the `settings.json` file found in `config/riven` via [FileBrowser][filebrowser].* ### Quality Rankings and Settings