jellyseerr/README.md

Jellyseerr is a free and open source software application for managing requests for your media library. It is 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 including authentication with user import & management

• Supports Movies, Shows and Mixed Libraries

• Ability to change email addresses for smtp purposes

• 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 docker hub 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

2. Then execute the following commands to clone and checkout to the stable version

git clone https://github.com/Fallenbagel/jellyseerr.git && cd jellyseerr
git checkout main

3. Then install the dependencies and build the dist

CYPRESS_INSTALL_BINARY=0 yarn install --frozen-lockfile --network-timeout 1000000
yarn run build

4. Now you can start jellyseerr using yarn start and opening http://localhost:5055 in your browser.

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

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

Environment file:

# 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

• You can get support on Discord.
• You can ask questions in the Help category of our GitHub Discussions.
• Bug reports and feature requests can be submitted via GitHub Issues.

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 💻 🚧	Sean 🌍 💻	notfakie 💻	Mohamed Jumail 👀	Shilong Jiang 💻	Boring Dragon 💻	Samuel Bartík 💻
Thegan Govender 💻	jab416171 📖	Nicolai Van der Storm 💻	Smexhy 🌍	dd060606 💻	Daniel 💻	undone37 🌍
Chechu García 🌍	Dimitri 🌍	andrey4korop 💻 🌍	Geoffrey Coulaud 🌍	Pikachu920 💻	Maxim Yalagin 💻	Jesse Boswell 💻
d-fendrich 🌍	David Fernández Alcoba 💻	Gauvino 🌍	EthanArmbrust 💻	Eduardo 📖	RickLuiken 💻	Br33ce 🌍
Athfan Khaleel 📖	Michael Dallinger 🌍	Janek 📖	Aleksa Siriški 🚇	Danish Humair 💻	Stephen Harris 📖	Joshua M. Boniface 💻
Gauthier 💻	Kara 🚇	Joaquin Olivero 💻	Julian Behr 🌍	ThowZzy 💻

Overseerr Contributors ✨

sct 💻 🎨 🤔	Alex Zoitos 💻	Brandon Cohen 💻 📖	Ahreluth 🌍	KovalevArtem 🌍	GiyomuWeb 🌍	Angry Cuban 📖
jvennik 🌍	darknessgp 💻	salty 🚇	Shutruk 🌍	Krystian Charubin 🎨	Kieron Boswell 💻	samwiseg0 💬 🚇
ecelebi29 💻 📖	Mārtiņš Možeiko 💻	mazzetta86 🌍	Paul Hagedorn 🌍	Shagon94 🌍	sebstrgg 🌍	Danshil Mungur 💻 📖
doob187 🚇	johnpyp 💻	Jakob Ankarhem 📖 💻 🌍	Jayesh 💻	flying-sausages 📖	hirenshah 📖	TheCatLady 💻 🌍 📖
Chris Pritchard 💻 📖	Tamberlox 🌍	David 💻	Douglas Parker 📖	Daniel Carter 💻	nuro 📖	ᗪєνιη ᗷυнʟ 🚇
JonnyWong16 📖	Roxedus 📖	WoisWoi 🌍	HubDuck 🌍 📖	costaht 📖 🌍	Shjosan 🌍	kobaubarr 🌍
Ricardo González 🌍	Torkil 🌍	Jagandeep Brar 📖	dtalens 🌍	Alex Cortelyou 💻	Jono Cairns 💻	DJScias 🌍
Dabu-dot 🌍	Jabster28 💻	littlerooster 🌍	Dustin Hildebrandt 💻	Bruno Guerreiro 🌍	Alexander Neuhäuser 🌍	Livio 🎨
tangentThought 💻	Nicolás Espinoza 💻	sootylunatic 🌍	JoKerIsCraZy 🌍	Daddie0 🌍	Simone 🌍	Seohyun Joo 🌍
Sergey 🌍	Shaaft 🌍	sr093906 🌍	Nackophilz 🌍	Sean Chambers 💻	deniscerri 🌍	tomgacz 🌍
Andersborrits 🌍	Maxent 🌍	Samuel Bartík 💻	Chun Yeung Wong 💻	TheMeanCanEHdian 💻	Gylesie 💻	Fhd-pro 🌍
PovilasID 🌍	byakurau 🌍	miknii 🌍	Mackenzie 💻	soup 📖	ceptonit 📖	aedelbro 💻
Pedro Nascimento 💻	Owen Voke 💻	Sebastian K 💻	jariz 💻	Alex 💻	Zeb Muller 💻	Shane Friedman 💻
Izaac Brånn 💻	Salman Tariq 💻	Andrew Kennedy 💻	Fallenbagel 🪼⌨️ 💻	Anton K. (ai Doge) 💻	Marco Faggian 💻	Eric Nemchik 💻
RemiRigal 💻	Joseph Risk 💻	Loetwiek 💻	Fuochi 📖