Skip to content

Latest commit

 

History

History
360 lines (300 loc) · 49.1 KB

README.md

File metadata and controls

360 lines (300 loc) · 49.1 KB

Jellyseerr

Discord Docker pulls GitHub All Contributors

Jellyseerr is a free and open source software application for managing requests for your media library. It is a a fork of Overseerr built to bring support for Jellyfin & Emby media servers!

The original Overseerr team have been busy and Jellyfin/Emby support aren't on their roadmap, so we started this project as we wanted to bring the Overseerr experience to the Jellyfin/Emby Community!

Current Features

  • Full Jellyfin/Emby/Plex integration. Authenticate and manage user access with Jellyfin/Emby/Plex!

  • Supports Movies, Shows, Mixed Libraries!

  • Ability to change email addresses for smtp purposes

  • Ability to import all jellyfin/emby users

  • Easy integration with your existing services. Currently, Jellyseerr supports Sonarr and Radarr. More to come!

  • Jellyfin/Emby/Plex library scan, to keep track of the titles which are already available.

  • Customizable request system, which allows users to request individual seasons or movies in a friendly, easy-to-use interface.

  • Incredibly simple request management UI. Don't dig through the app to simply approve recent requests!

  • Granular permission system.

  • Support for various notification agents.

  • Mobile-friendly design, for when you need to approve requests on the go!

    (Upcoming Features include: Multiple Server Instances, and much more!)

With more features on the way! Check out our issue tracker to see the features which have already been requested.

Getting Started

Pre-requisite (Important)

On Jellyfin/Emby, ensure the settings > Home > Automatically group content from the following folders into views such as 'Movies', 'Music' and 'TV' is turned off

Launching Jellyseerr using Docker (Recommended)

Check out our dockerhub for instructions on how to install and run Jellyseerr: https://hub.docker.com/r/fallenbagel/jellyseerr

Building from source (ADVANCED):

Windows

Pre-requisites:

  • Nodejs v18
  • Yarn
  • Download/git clone the source code from the github (Either develop branch or main for stable)
npm i -g win-node-env
set CYPRESS_INSTALL_BINARY=0
yarn install --frozen-lockfile --network-timeout 1000000
yarn run build
yarn start

(you can use task scheduler to run a bat script with @echo off and yarn start to run jellyseerr in the background)

to set env variables such as JELLYFIN_TYPE=emby create a file called .env in the root directory of jellyseerr

Linux

Pre-requisites:

  • Nodejs v18
  • Yarn (on debian based distros, the package manager provided yarn is different and is a package called cmdlet. You can remove that using apt-remove cmdlet then install yarn using npm install -g yarn)
  • Git

Steps:

  1. Assuming you want the root folder for the jellyseerr source code to be cloned to /opt
cd /opt
  1. Then clone the follow commands to clone and checkout to the stable version
git clone https://github.com/Fallenbagel/jellyseerr.git && cd jellyseerr
git checkout main
  1. Then install the dependencies and build the dist
CYPRESS_INSTALL_BINARY=0 yarn install --frozen-lockfile --network-timeout 1000000
yarn run build
  1. Now you can start jellyseerr using yarn start and opening http://localhost:5055 in your browser.

  2. If you want to run jellyseerr as a Systemd-service:

  • assuming jellyseerr was cloned to /opt/
  • first create the environmentfile at /etc/jellyseerr/jellyseerr.conf

Environmentfile:

# Jellyseerr's default port is 5055, if you want to use both, change this.
# specify on which port to listen
PORT=5055

# specify on which interface to listen, by default jellyseerr listens on all interfaces
#HOST=127.0.0.1

# Uncomment if your media server is emby instead of jellyfin.
# JELLYFIN_TYPE=emby
  • Then run the command which node to find your node path (assuming it's at /usr/bin/node)
  • Then create the service file using sudo systemctl edit jellyseerr.service or creating and editing a file at /etc/systemd/system/jellyseerr.service

Service file contents:

[Unit]
Description=Jellyseerr Service
Wants=network-online.target
After=network-online.target

[Service]
EnvironmentFile=/etc/jellyseerr/jellyseerr.conf
Environment=NODE_ENV=production
Type=exec
Restart=on-failure
WorkingDirectory=/opt/jellyseerr
ExecStart=/usr/bin/node dist/index.js

[Install]
WantedBy=multi-user.target

Packages:

Archlinux: AUR Nixpkg: Nixpkg Snap: Snap

Preview

Support

API Documentation

You can access the API documentation from your local Jellyseerr install at http://localhost:5055/api-docs

Community

You can ask questions, share ideas, and more in GitHub Discussions.

If you would like to chat with other members of our growing community, join the Jellyseerr Discord server!

Our Code of Conduct applies to all Jellyseerr community channels.

Contributing

You can help improve Jellyseerr too! Check out our Contribution Guide to get started.

Contributors ✨

Thanks goes to these wonderful people from Overseerr (emoji key) and all those that contributed directly to Jellyseerr:

Jellyseerr Contributors ✨

Fallenbagel
Fallenbagel

💻 🚧
Sean
Sean

🌍 💻
notfakie
notfakie

💻
Mohamed Jumail
Mohamed Jumail

👀
Shilong Jiang
Shilong Jiang

💻
Boring Dragon
Boring Dragon

💻
Samuel Bartík
Samuel Bartík

💻
Thegan Govender
Thegan Govender

💻
jab416171
jab416171

📖
Nicolai Van der Storm
Nicolai Van der Storm

💻
Smexhy
Smexhy

🌍
dd060606
dd060606

💻
Daniel
Daniel

💻
undone37
undone37

🌍
Chechu García
Chechu García

🌍
Dimitri
Dimitri

🌍
andrey4korop
andrey4korop

💻 🌍
Geoffrey Coulaud
Geoffrey Coulaud

🌍
Pikachu920
Pikachu920

💻
Maxim Yalagin
Maxim Yalagin

💻
Jesse Boswell
Jesse Boswell

💻
d-fendrich
d-fendrich

🌍
David Fernández Alcoba
David Fernández Alcoba

💻
Gauvino
Gauvino

🌍
EthanArmbrust
EthanArmbrust

💻
Eduardo
Eduardo

📖
RickLuiken
RickLuiken

💻
Br33ce
Br33ce

🌍

Overseerr Contributors ✨

sct
sct

💻 🎨 🤔
Alex Zoitos
Alex Zoitos

💻
Brandon Cohen
Brandon Cohen

💻 📖
Ahreluth
Ahreluth

🌍
KovalevArtem
KovalevArtem

🌍
GiyomuWeb
GiyomuWeb

🌍
Angry Cuban
Angry Cuban

📖
jvennik
jvennik

🌍
darknessgp
darknessgp

💻
salty
salty

🚇
Shutruk
Shutruk

🌍
Krystian Charubin
Krystian Charubin

🎨
Kieron Boswell
Kieron Boswell

💻
samwiseg0
samwiseg0

💬 🚇
ecelebi29
ecelebi29

💻 📖
Mārtiņš Možeiko
Mārtiņš Možeiko

💻
mazzetta86
mazzetta86

🌍
Paul Hagedorn
Paul Hagedorn

🌍
Shagon94
Shagon94

🌍
sebstrgg
sebstrgg

🌍
Danshil Mungur
Danshil Mungur

💻 📖
doob187
doob187

🚇
johnpyp
johnpyp

💻
Jakob Ankarhem
Jakob Ankarhem

📖 💻 🌍
Jayesh
Jayesh

💻
flying-sausages
flying-sausages

📖
hirenshah
hirenshah

📖
TheCatLady
TheCatLady

💻 🌍 📖
Chris Pritchard
Chris Pritchard

💻 📖
Tamberlox
Tamberlox

🌍
David
David

💻
Douglas Parker
Douglas Parker

📖
Daniel Carter
Daniel Carter

💻
nuro
nuro

📖
ᗪєνιη ᗷυнʟ
ᗪєνιη ᗷυнʟ

🚇
JonnyWong16
JonnyWong16

📖
Roxedus
Roxedus

📖
WoisWoi
WoisWoi

🌍
HubDuck
HubDuck

🌍 📖
costaht
costaht

📖 🌍
Shjosan
Shjosan

🌍
kobaubarr
kobaubarr

🌍
Ricardo González
Ricardo González

🌍
Torkil
Torkil

🌍
Jagandeep Brar
Jagandeep Brar

📖
dtalens
dtalens

🌍
Alex Cortelyou
Alex Cortelyou

💻
Jono Cairns
Jono Cairns

💻
DJScias
DJScias

🌍
Dabu-dot
Dabu-dot

🌍
Jabster28
Jabster28

💻
littlerooster
littlerooster

🌍
Dustin Hildebrandt
Dustin Hildebrandt

💻
Bruno Guerreiro
Bruno Guerreiro

🌍
Alexander Neuhäuser
Alexander Neuhäuser

🌍
Livio
Livio

🎨
tangentThought
tangentThought

💻
Nicolás Espinoza
Nicolás Espinoza

💻
sootylunatic
sootylunatic

🌍
JoKerIsCraZy
JoKerIsCraZy

🌍
Daddie0
Daddie0

🌍
Simone
Simone

🌍
Seohyun Joo
Seohyun Joo

🌍
Sergey
Sergey

🌍
Shaaft
Shaaft

🌍
sr093906
sr093906

🌍
Nackophilz
Nackophilz

🌍
Sean Chambers
Sean Chambers

💻
deniscerri
deniscerri

🌍
tomgacz
tomgacz

🌍
Andersborrits
Andersborrits

🌍
Maxent
Maxent

🌍
Samuel Bartík
Samuel Bartík

💻
Chun Yeung Wong
Chun Yeung Wong

💻
TheMeanCanEHdian
TheMeanCanEHdian

💻
Gylesie
Gylesie

💻
Fhd-pro
Fhd-pro

🌍
PovilasID
PovilasID

🌍
byakurau
byakurau

🌍
miknii
miknii

🌍
Mackenzie
Mackenzie

💻
soup
soup

📖
ceptonit
ceptonit

📖
aedelbro
aedelbro

💻
Pedro Nascimento
Pedro Nascimento

💻
Owen Voke
Owen Voke

💻
Sebastian K
Sebastian K

💻
jariz
jariz

💻
Alex
Alex

💻
Zeb Muller
Zeb Muller

💻
Shane Friedman
Shane Friedman

💻
Izaac Brånn
Izaac Brånn

💻
Salman Tariq
Salman Tariq

💻
Andrew Kennedy
Andrew Kennedy

💻
Fallenbagel
Fallenbagel

🪼⌨️ 💻
Anton K. (ai Doge)
Anton K. (ai Doge)

💻
Marco Faggian
Marco Faggian

💻
Eric Nemchik
Eric Nemchik

💻
RemiRigal
RemiRigal

💻