Skip to content

Latest commit

 

History

History
357 lines (273 loc) · 13.3 KB

riven.md

File metadata and controls

357 lines (273 loc) · 13.3 KB
title description published date tags editor dateCreated
Riven
Riven Media
true
2024-08-13 19:10:07 UTC
markdown
2024-07-15 15:43:03 UTC

Plex torrent streaming through Real Debrid and 3rd party services like Overseerr, Mdblist, etc.

Rewrite of Plex Debrid project.

What is Riven?

Riven is an advanced media management and streaming solution designed to integrate with various media servers and third-party services. It automates the process of finding, downloading, and organizing media content, making it instantly available for streaming through your preferred media server.

Riven streamlines your media consumption experience by:

  1. Automatically discovering new content based on your preferences and watchlists.
  2. Efficiently searching for and downloading high-quality media files.
  3. Organizing your media library using a smart symlink system.
  4. Seamlessly integrating with your chosen media server for immediate streaming access.
  5. Providing a user-friendly web interface for easy management and configuration.

Whether you're a casual viewer or a media enthusiast, Riven offers a powerful, automated solution to keep your media library up-to-date and easily accessible.

Table of Contents

Supported Services

Service Supported
Download Services (Real-Debrid, AllDebrid, Torbox) ✅
Media Server (Plex, Jellyfin, Emby) ✅
Overseerr ✅
Mdblist ✅
Trakt ✅
Jackett ✅
Media Server Watchlist ✅
Torrentio ✅
Orionoid ✅
Zilean ✅
Listrr ✅

And more to come! Check out our Project Board to stay informed about upcoming features and integrations.

We welcome feature requests and bug reports. Please use our Issue Tracker or join our Discord to get involved with the community.

Key Features

🔍 Automated Content Discovery

  • Integrates with services like Overseerr, Mdblist, and Trakt
  • Finds new media based on your preferences and watchlists

⬇️ Efficient Downloads

  • Uses Real-Debrid for high-speed downloads
  • Supports multiple download services

🎬 Smart Media Management

  • Creates an organized media library using symlinks
  • Automatically updates your media server with new content

🔧 Flexible Configuration

  • Customizable quality preferences
  • Fine-tune your media organization structure

🌐 User-Friendly Web Interface

  • Easy-to-use dashboard for managing your media
  • Monitor downloads and library status

🔒 Privacy-Focused

  • No personal data stored or shared
  • Self-hosted option for complete control

Main Components and Their Roles

  1. Content Discovery:

    • Integrates with services like Overseerr, Mdblist, Trakt, etc.
    • Finds new media to download based on user preferences and watchlists

  2. Scraper:

    • Searches for torrent files across various sources
    • Filters results based on quality preferences

  3. Downloader:

    • Manages downloads through Real-Debrid
    • Handles torrent to direct download conversion

  4. Symlinker:

    • Creates symbolic links to organize downloaded files
    • Manages the structure of the Plex library

  5. Media Server Updater:

    • Keeps the media server library in sync with downloaded content
    • Manages metadata and organization within the media server

Flowchart: How Riven Components Work Together

alt This flowchart illustrates the main components of Riven and how they interact:

  1. Content Discovery starts the process by finding new media based on user preferences and external services.
  2. The Scraper then searches for appropriate torrent files for the discovered media.
  3. The Downloader, integrated with the chosen Download Service, manages the actual file downloads.
  4. Once downloaded, the Symlinker organizes the files using symbolic links.
  5. The Media Server Updater then ensures the media server library is updated with the new content.
  6. Finally, the organized and updated media is available in the media server for streaming.

User preferences influence both the Content Discovery and Scraper components, ensuring that the entire process aligns with the user's media preferences and quality settings. The Download Service (e.g., Real-Debrid) is explicitly shown as managing the Downloader component.

ElfHosted

ElfHosted is a geeky open-source PaaS which provides all the "plumbing" (hosting, security, updates, etc) for your self-hosted apps.

Riven is a top-tier app in the ElfHosted app catalogue. 30% of your subscription goes to Riven developers, and the remainder offsets infrastructure costs.

New accounts get $10 free credit, enough for a week's free trial of the Riven / Plex Infinite Streaming bundle!

(ElfHosted Discord) {.is-info}

Self Hosted

Docker Compose

Before you begin, ensure you have Docker and Docker Compose installed on your system. {.is-info}

Create a docker-compose.yml file with the following contents:

services:
  riven-frontend:
    image: spoked/riven-frontend:latest
    container_name: riven-frontend
    restart: unless-stopped
    ports:
      - "3000:3000"
    tty: true
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=America/New_York
      - ORIGIN=http://localhost:3000 # set to the url or ip where the frontend is hosted
      - BACKEND_URL=http://riven:8080
      - DIALECT=postgres 
      - DATABASE_URL=postgres://postgres:postgres@riven-db:5432/riven 
    depends_on:
      riven:
        condition: service_healthy

  riven:
    image: spoked/riven:latest
    container_name: riven
    restart: unless-stopped
    ports:
      - "8080:8080"
    tty: true
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=America/New_York
      - RIVEN_FORCE_ENV=true
      - RIVEN_DATABASE_HOST=postgresql://postgres:postgres@riven-db/riven
    healthcheck:
      test: curl -s http://localhost:8080 >/dev/null || exit 1
      interval: 30s
      timeout: 10s
      retries: 10
    volumes:
      - ./data:/riven/data
      - /mnt:/mnt
    depends_on:
      riven_postgres:
        condition: service_healthy

  riven_postgres:
    image: postgres:16.3-alpine3.20
    container_name: riven-db
    environment:
      PGDATA: /var/lib/postgresql/data/pgdata
      POSTGRES_USER: postgres
      POSTGRES_PASSWORD: postgres
      POSTGRES_DB: riven
    volumes:
      - ./riven-db:/var/lib/postgresql/data/pgdata
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U postgres"]
      interval: 10s
      timeout: 5s
      retries: 5

Then run docker compose up -d to start the container in the background. You can then access the web interface at http://localhost:3000 or whatever port and origin you set in the docker-compose.yml file.

On first run, Riven creates a settings.json file in the data directory. You can edit the settings from frontend, or manually edit the file and restart the container. {.is-info}

What is ORIGIN?

Setting the correct ORIGIN is crucial to avoid CORS issues and ensure proper functionality. {.is-warning}

ORIGIN is the URL of the frontend on which you will access it from anywhere. If you are hosting Riven on a vps with IP address 123.45.67.890 then you will need to set the ORIGIN to http://123.45.67.890:3000 (no trailing slash). Similarly, if using a domain name, you will need to set the ORIGIN to http://riven.example.com:3000 (no trailing slash). If you change the port in the docker-compose.yml file, you will need to change it in the ORIGIN as well.

Hard Reset

Warning: A hard reset will delete all your current database. This action cannot be undone. Only perform a hard reset if you are sure you want to reset the database or if instructed by support. {.is-warning}

To perform a hard reset of the database:

  1. Via Docker Exec:

    • Run the following command: 
      docker exec -it riven python /riven/src/main.py --hard_reset_db
    • This command will reset the database and reinitialize the settings.

  2. Via Environment Variable:

    • Set the environment variable HARD_RESET=true in your Docker Compose file: 
      environment:
  - HARD_RESET=true
    • Then, restart the Docker containers: 
      docker-compose up -d
    • After restart set the environment variable HARD_RESET=false in your Docker Compose file:
    environment:
  - HARD_RESET=false

Running outside of Docker

Running outside of Docker can be useful for development or if you prefer more control over the environment.

To run outside of docker you will need to have node (v18.13+) and python (3.10+) installed. Then clone the repository

git clone https://github.com/rivenmedia/riven.git && cd riven

and open two terminals in the root of the project and run the following commands in each.

First terminal:

cd frontend
npm install
npm run build
ORIGIN=http://localhost:3000 BACKEND_URL=http://127.0.0.1 node build

Read above for more info on ORIGIN.

Second terminal:

pip install poetry
poetry install --without dev
poetry run python backend/main.py

Riven Settings.json

For detailed information on how Riven uses settings.json file, please see the Settings.json page.

Symlinks and Permissions

For detailed information on how Riven uses symlinks and manages permissions, please see the Symlinks and Permissions page.

Subtitles

For detailed information on how Riven uses subtitles, please see the Subtitles page.

Troubleshooting

Please see the Troubleshooting page.

Development

For details on setting up the development environment and contributing to Riven, please see the Development page.

Contributing

For information on how to contribute to the Riven project, please see the Contributing page.

License

This project is licensed under the GNU GPLv3 License - see the LICENSE file for details.