{"id":13522157,"url":"https://github.com/aleksilassila/reiverr","last_synced_at":"2025-05-16T03:05:03.314Z","repository":{"id":187583071,"uuid":"656912696","full_name":"aleksilassila/reiverr","owner":"aleksilassila","description":"Reiverr is a clean combined interface for Jellyfin, TMDB, Radarr and Sonarr, as well as a replacement to Overseerr","archived":false,"fork":false,"pushed_at":"2025-04-15T10:04:21.000Z","size":65576,"stargazers_count":1641,"open_issues_count":55,"forks_count":49,"subscribers_count":32,"default_branch":"master","last_synced_at":"2025-04-15T11:23:02.493Z","etag":null,"topics":["jellyfin","movies","radarr","sonarr","tmdb","tv"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aleksilassila.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-06-21T22:56:25.000Z","updated_at":"2025-04-14T23:41:49.000Z","dependencies_parsed_at":"2024-01-06T13:23:13.924Z","dependency_job_id":"4328a7ce-2efe-480b-bdab-9e30649e4c64","html_url":"https://github.com/aleksilassila/reiverr","commit_stats":null,"previous_names":["aleksilassila/reiverr"],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aleksilassila%2Freiverr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aleksilassila%2Freiverr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aleksilassila%2Freiverr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aleksilassila%2Freiverr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aleksilassila","download_url":"https://codeload.github.com/aleksilassila/reiverr/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254459087,"owners_count":22074605,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["jellyfin","movies","radarr","sonarr","tmdb","tv"],"created_at":"2024-08-01T06:00:43.101Z","updated_at":"2025-05-16T03:04:58.306Z","avatar_url":"https://github.com/aleksilassila.png","language":"TypeScript","funding_links":[],"categories":["TypeScript","others","Software","Complimenting Apps","👾 Companion Apps \u0026 Tools"],"sub_categories":["Media Management","🔍 Media Requests \u0026 Discovery"],"readme":"# Reiverr\n\n![Stargazers](https://img.shields.io/github/stars/aleksilassila/reiverr)\n![GitHub issues](https://img.shields.io/github/issues/aleksilassila/reiverr)\n![Discord](https://img.shields.io/discord/923259625145524354)\n![Version](https://ghcr-badge.egpl.dev/aleksilassila/reiverr/latest_tag?color=%2344cc11\u0026ignore=latest\u0026label=version\u0026trim=)\n![Size](https://ghcr-badge.egpl.dev/aleksilassila/reiverr/size?color=%2344cc11\u0026tag=latest\u0026label=image+size\u0026trim=)\n\nReiverr is a project that aims to create a single UI for interacting with TMDB, streaming content from various sources and be an alternative to Overseerr.\n\nThis project is still in early stages, and many features are still missing / being tested and changed. Contributions are welcome! See [contributing](#Contributing) for more information.\n\n![Demo Video](images/reiverr-demo.gif)\n\n## Reiverr 1.0\n\nThis 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](https://github.com/aleksilassila/reiverr/tree/reiverr-1.0) for now.\n\n# List of major features\n\nTMDB Discovery:\n\n- Discover trending movies and TV shows\n- Get personalized recommendations based on your TMDB ratings\n- View details about movies and TV shows, such as cast, crew, ratings \u0026 a trailer.\n- Movie \u0026 TV show search\n\nContent Playback Plugins\n\n- Offers a plugin API that allows users to access media from various external sources\n- Currently built-in plugins for streaming content are:\n  - [Jellyfin plugin](backend/packages/jellyfin.plugin/README.md)\n  - [Torrent-Stream plugin](backend/packages/torrent-stream.plugin/README.md) (requires Jackett)\n\nFor a list of planned features \u0026 known bugs, see [Reiverr Taskboard](https://github.com/users/aleksilassila/projects/5).\n\n# Installation\n\nThe 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.\n\n### Docker CLI\n\n```sh\ndocker run -it --init \\\n  --name reiverr \\\n  --restart unless-stopped \\\n  -p 9494:9494 \\\n  -v /path/to/appdata/config:/config \\\n  -v /path/to/appdata/plugins:/plugins \\\n  ghcr.io/aleksilassila/reiverr:latest\n```\n\n### Docker compose\n\n```yaml\nversion: '3.8'\n\nname: reiverr\n\nservices:\n  reiverr:\n    image: ghcr.io/aleksilassila/reiverr:latest\n    container_name: reiverr\n    ports:\n      - 9494:9494\n    environment:\n      - 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.\n      - ADMIN_USERNAME=admin # optional\n      - ADMIN_PASSWORD=admin # optional\n    volumes:\n      - /path/to/appdata/config:/config\n      - /path/to/appdata/plugins:/plugins\n    restart: unless-stopped\n```\n\n### Building from Source\n\n1. Requirements(ish):\n   - Node v18.14.0 or higher\n   - NPM v9.3.1 or higher\n2. Clone from **master** or download the [latest source](https://github.com/aleksilassila/reiverr/releases)\n3. Build \u0026 run the app:\\\n   `npm install`\\\n   `npm install --prefix backend`\\\n   `npm run preview`\n\n#### Reiverr will be accessible via port 9494 by default.\n\n### Tizen / Samsung Smart TVs\n\nTo 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.\n\nThere 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:\n\n1. Follow the manual installation steps above to install the dependencies (npm install)\n2. Download either Tizen Studio or the CLI tools from the [official website](https://developer.tizen.org/development/tizen-studio/download)\n3. [Connect Tizen Studio to your TV](https://developer.samsung.com/smarttv/develop/getting-started/using-sdk/tv-device.html)\n4. Use the following command to build and install the app on your TV:\\\n   \\\n   `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`.\\\n   \\\n   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.\\\n   \\\n   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](https://docs.tizen.org/application/web/get-started/tv/first-samsung-tv-app/#run-on-a-target-device).\n\nIf you have any questions or run into issues or bugs, you can start a [discussion](https://github.com/aleksilassila/reiverr/discussions), open an [issue](https://github.com/aleksilassila/reiverr/issues) or check out the [Discord channel](https://discord.gg/enypPQh6pz). If find a feature request that you'd like to see implemented, you can react to it with a thumbs up.\n\n## Other Platforms\n\nThe roadmap includes plans to support the following platforms in the future:\n\n- Android TV / WebOS\n- Windows Desktop App\n- MacOS Desktop App\n\n# Post Installation\n\nTo 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.\n\nTo get access to media playback, connect to plugins by adding media sources in the settings. Additional plugins can be installed by dropping them in the `/plugins` folder. To get most out of Reiverr, it is recommended to also connect to TMDB.\n\n\u003e Hint: Jellyfin API key is located under Administration \u003e Dashboard \u003e Advanced \u003e API Keys in the Jellyfin Web UI.\n\n# Contributing\n\nUnlike 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](https://learn.svelte.dev/tutorial/welcome-to-svelte) to get started.\n\nTo see a list of missing features \u0026 known bugs that you can help with, see [Reiverr Taskboard](https://github.com/users/aleksilassila/projects/7). 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.\n\nBefore you contribute:\n\n- If you are taking on an existing bug or feature ticket, it is encouraged to comment on the issue or mark yourself as an assignee at some point to avoid multiple people working on the same thing.\n- If the ticket is vague or missing information, please ask for clarification in the comments.\n- UI style should match the rest of the project, and it is a good idea to discuss the design beforehand, especially for larger design choices (issues labelled with `design`).\n- [Conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) are encouraged.\n- When creating a pull request, please make sure to target the `dev` branch and mark the PR as a draft if it is a work in progress.\n\nI'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 :)\n\n# Development\n\nTo get started with development:\n\n1. Clone the repository\n2. Check out the `dev` branch\n3. Install dependencies\\\n   `npm install`\\\n   `npm install --prefix backend`\n4. To start the frontend: `npm run dev` or `npx vite --host` if you want to expose the server\n5. To start the backend: `npm run --prefix backend start:dev`\n\n## Notes\n\n- 2.0 will primarily target TVs, so the UI must be optimized with TVs in mind. This means larger text, buttons, etc. [Design Guide for Android TV](https://developer.android.com/design/ui/tv/guides/styles/layouts) is a good resource for how to design for TVs.\n- The app should support old browsers all the way to Chromium 69, as that's what used in Tizen 5.5. This means that you might not be able to use the latest browser features, or that you'll have to use a polyfill. [caniuse.com](https://caniuse.com/) is a great resource if you need to check compatibility.\n  - Most of the time you don't need to worry about this, but one big feature that's not available in older browsers is css `gap` property. You can use the `space-x` and `space-y` classes from Tailwind CSS to achieve the same effect.\n\n## Plugins\n\nIf you'd like to develop your own plugin, easiest way to get started is by getting your hands dirty and checking how things are done in the built-in plugins. Couple of things to note:\n\n- Plugins are npm packages, that contain a `package.json` in a folder with `.plugin` extension.\n- Plugins have to implement (and default export) the `PluginProvider` class that can be imported from the [](backend/packages/reiverr-plugin) package.\n  - To install the [reiverr-plugin package](https://github.com/aleksilassila/reiverr/pkgs/npm/reiverr-plugin) from Github's npm registry, follow the steps outlined here: [Working with the Github npm registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#installing-a-package) (you'll need a .npmrc file and an access token to a Github account)\n  - The built-in packages use npm workspaces, which doesn't work if you're developing outisde of the repository\n- For a better understanding of the anatomy of a plugin, see the documentation in the following file: [reiverr-plugin/src/plugin.ts](backend/packages/reiverr-plugin/src/plugin.ts)\n\n## Useful resources\n\n- https://developer.themoviedb.org/reference\n- https://api.jellyfin.org/\n- https://github.com/jellyfin/jellyfin-web\n- Network tab in the browser in Jellyfin, Radarr \u0026 Sonarr web UIs\n\n# Additional Screenshots\n\n![Landing Page](images/screenshot-1.png)\n\n![Series Page](images/screenshot-2.png)\n\n![Library Page](images/screenshot-3.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faleksilassila%2Freiverr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faleksilassila%2Freiverr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faleksilassila%2Freiverr/lists"}