Riven

Overview

Available plugins for Riven TS and how to configure them.

Riven uses a plugin architecture. Every integration is a plugin that can be enabled by providing its required environment variables after adding it to the RIVEN_SETTING__enabledPlugins config. If the required settings aren't provided, the plugin is simply skipped.

To enable a plugin, you must first add it to the RIVEN_SETTING__enabledPlugins config. For example:

RIVEN_SETTING__enabledPlugins=["seerr"]

Plugin Categories

Content Sources

These plugins tell Riven what media you want:

Metadata

These plugins fetch information about your media:

Scraping & Downloads

These plugins find and cache torrents:

Media Servers

Other

Configuration Pattern

All plugin settings use environment variables with this pattern:

RIVEN_PLUGIN_SETTING__REPO_PLUGIN_<NAME>__<settingName>="value"

The plugin name is uppercase with underscores. For example, plugin-mdblist becomes REPO_PLUGIN_MDBLIST.

Examples

# TMDB
RIVEN_PLUGIN_SETTING__REPO_PLUGIN_TMDB__apiKey="your-tmdb-key"

# MDBList with lists
RIVEN_PLUGIN_SETTING__REPO_PLUGIN_MDBLIST__apiKey="your-key"
RIVEN_PLUGIN_SETTING__REPO_PLUGIN_MDBLIST__lists=["username/list-name"]

# StremThru with Real-Debrid
RIVEN_PLUGIN_SETTING__REPO_PLUGIN_STREMTHRU__realdebridApiKey="your-rd-key"

# Seerr
RIVEN_PLUGIN_SETTING__REPO_PLUGIN_SEERR__url="http://seerr:5055"
RIVEN_PLUGIN_SETTING__REPO_PLUGIN_SEERR__apiKey="your-seerr-key"

Minimum Plugin Setup

At minimum, you need:

  1. TMDB - For metadata lookup (required)
  2. One content source - Seerr, MDBList, or Listrr
  3. One scraper/downloader - StremThru (recommended), Torrentio, or Comet

On this page