Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/rivenmedia/riven/llms.txt

Use this file to discover all available pages before exploring further.

Riven is a self-hosted media automation system that connects your watchlists to your media server — automatically. It discovers content via services like Overseerr, Trakt, and Plex Watchlist; finds torrents via scrapers like Torrentio, Comet, and Jackett; downloads them instantly through Real-Debrid or AllDebrid; and presents them to Plex, Jellyfin, or Emby via a FUSE-based virtual filesystem — all without storing a single file locally.

Quickstart

Get Riven running with Docker Compose in minutes

Installation

Full deployment guide with environment variables and bind mounts

Configuration

Configure debrid services, scrapers, content sources, and more

API Reference

REST API endpoints for managing your media library programmatically

​
How Riven Works

Riven runs a continuous pipeline that moves media from discovery to playback automatically.
1

Discover Content

Content services (Overseerr, Trakt, Plex Watchlist, MDBList, Listrr) feed requested media items into Riven’s queue.
2

Scrape Torrents

Riven queries multiple scraper backends simultaneously — Torrentio, Comet, Jackett, Prowlarr, Orionoid, Zilean, and more — to find the best available torrent for each item.
3

Download via Debrid

The highest-ranked torrent is sent to your debrid provider (Real-Debrid, AllDebrid, or Debrid-Link), which caches and hosts the file. No local storage required.
4

Mount & Stream

RivenVFS — a FUSE-based virtual filesystem — mounts the debrid files at your configured path. Plex, Jellyfin, or Emby scans the mount and streams directly. Files are never downloaded locally.

​
Supported Services

Debrid Services

Real-Debrid, AllDebrid, Debrid-Link

Content Sources

Overseerr, Plex Watchlist, Trakt, MDBList, Listrr

Scrapers

Torrentio, Comet, Jackett, Prowlarr, Orionoid, Zilean, Mediafusion, RARBG, AIOStreams

Media Servers

Plex, Jellyfin, Emby

​
Key Features

  • Zero local storage — media is streamed directly from debrid caches via RivenVFS
  • Intelligent ranking — RTN (Rank Torrent Name) scores each result by quality, resolution, codec, and your custom preferences
  • Library profiles — organize media into separate VFS paths filtered by genre, rating, anime flag, content rating, and more
  • Real-time notifications — get alerts via Discord, Slack, or any Apprise-compatible service
  • Full REST API — automate every operation or integrate with your own tooling
  • PostgreSQL persistence — robust state management with Alembic-managed migrations
Join the Riven Discord to get help, share configurations, and stay up to date with new releases.

Build docs developers (and LLMs) love

Get started for freeTalk to us