search

aleksilassila / reiverr

Reiverr is a clean combined interface for Jellyfin, TMDB, Radarr and Sonarr, as well as a replacement to Overseerr
GNU Affero General Public License v3.0
1.41k stars 43 forks source link
jellyfin movies radarr sonarr tmdb tv

readme

Reiverr

Stargazers GitHub issues Discord Version Size

Reiverr is a project that aims to create a single UI for interacting with TMDB, Jellyfin, Radarr and Sonarr, as well as be an alternative to Overseerr.

This project is still in early stages, and many features are still missing / being tested and changed. Contributions are welcome! See contributing for more information.

Demo Video

Reiverr 1.0

This is the page for Reiverr 2.0, which is a rewrite of the project with TVs in mind. It still lacks many features of the previous version. If you want a more stable experience, or only care about the web app, you might want to check out the 1.0 branch for now.

List of major features

TMDB Discovery:

Local Library & Playback

For a list of planned features & known bugs, see Reiverr Taskboard.

Installation

The easiest and the recommended way to install Reiverr is via Docker. Make sure to update the api keys and base URLs to match your setup.

Docker CLI

docker run -it --init \
  --name reiverr \
  --restart unless-stopped \
  -p 9494:9494 \
  -v /path/to/appdata/config:/config \
  ghcr.io/aleksilassila/reiverr:latest

Docker compose

version: '3.8'

name: reiverr

services:
  reiverr:
    image: ghcr.io/aleksilassila/reiverr:latest
    container_name: reiverr
    ports:
      - 9494:9494
    environment:
      - SECRET=your_secret_here # optional, used to sign JWT tokens for authentication. If not set, sessions will not persist between server restarts. Use a random string.
      - ADMIN_USERNAME=admin # optional
      - ADMIN_PASSWORD=admin # optional
    volumes:
      - /path/to/appdata/config:/config
    restart: unless-stopped

Building from Source

  1. Requirements(ish):
    • Node v18.14.0 or higher
    • NPM v9.3.1 or higher
  2. Clone from master or download the latest source
  3. Build the app:\ npm install\ npm install --prefix backend\ npm run build
  4. Start the app:\ node backend/dist/src/main

Reiverr will be accessible via port 9494 by default.

Tizen / Samsung Smart TVs

To be able to use Reiverr on TVs, you'll still need to host the backend server on a separate device. See the above methods for instructions on how to set up the backend / web app.

There are plans to attempt getting the app to the official store. In the meantime, you have to manually build and install the app using Tizen Studio or the CLI, following roughly these steps:

  1. Follow the manual installation steps above to install the dependencies (npm install)
  2. Download either Tizen Studio or the CLI tools from the official website
  3. Connect Tizen Studio to your TV
  4. Use the following command to build and install the app on your TV:\ \ npm run build:tizen;C:\tizen-studio\tools\ide\bin\tizen.bat build-web -- tizen;C:\tizen-studio\tools\ide\bin\tizen.bat package -t wgt -o .\tizen -- .\tizen\.buildResult\;C:\tizen-studio\tools\ide\bin\tizen.bat install -n .\tizen\Reiverr.wgt -t QE55Q64TAUXXC.\ \ You may need to replace the paths for Tizen Studio tools according to your installation location, as well as the device identifier, which was in my case the tv model number.\ \ Alternatively, you can open the project in Tizen Studio and install the project on a device from there. For more instructions on run a project on a device, see here.

If you have any questions or run into issues or bugs, you can start a discussion, open an issue or check out the Discord channel. If find a feature request that you'd like to see implemented, you can react to it with a thumbs up.

Other Platforms

The roadmap includes plans to support the following platforms in the future:

Post Installation

To create the first user account, you can log in with any credentials and an admin account will be created. Alternatively, you can define the admin username and password using environment variables, as seen in the Docker Compose example. A new admin account is only created if there are no previous accounts with the same name. To get most out of Reiverr, it is recommended to connect to TMDB, Jellyfin, Radarr and Sonarr.

Hint: Radarr & Sonarr API keys can be found under Settings > General in their respective web UIs. Jellyfin API key is located under Administration > Dashboard > Advanced > API Keys in the Jellyfin Web UI.

Contributing

Unlike the most Servarr projects, this one is built with Svelte and NestJS. If you haven't used Svelte before, don't worry, this was my first Svelte project too. I'd recommend reading the official Svelte tutorial to get started.

To see a list of missing features & known bugs that you can help with, see Reiverr Taskboard. Feel free to also create your own issues for bug reports or feature requests, as well as discussions for general questions. Issues with the community label are issues that I can't or won't work on myself, and are left for the community to pick up. Feel free to work on any issues though, even without the label.

Before you contribute:

I'm not a designer, so if you have any ideas for improving the UI, I'd love to learn about them. If you are a designer and would like to help, contributions are much appreciated! Also the project is still missing a logo :)

Development

To get started with development:

  1. Clone the repository
  2. Check out the dev branch
  3. Install dependencies\ npm install\ npm install --prefix backend
  4. To start the frontend: npm run dev or npx vite --host if you want to expose the server
  5. To start the backend: npm run --prefix backend start:dev

Notes

Useful resources

Additional Screenshots

Landing Page

Series Page

Library Page