basic structure
This commit is contained in:
@@ -0,0 +1,95 @@
|
||||
# Installation
|
||||
|
||||
[Jellyseerr](https://github.com/Fallenbagel/jellyseerr) is a free and open-source request management and media discovery tool for Jellyfin. It allows users to search for and request media directly from your Jellyfin library or through external indexers.
|
||||
|
||||
---
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Docker and Docker Compose installed
|
||||
- A running Jellyfin instance (optional but recommended)
|
||||
- Optional: Sonarr, Radarr, and download clients for full automation
|
||||
|
||||
---
|
||||
|
||||
## 1. Create Project Directory
|
||||
|
||||
```bash
|
||||
mkdir jellyseerr
|
||||
cd jellyseerr
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 2. Create `docker-compose.yml`
|
||||
|
||||
```yaml
|
||||
version: "3"
|
||||
services:
|
||||
jellyseerr:
|
||||
image: fallenbagel/jellyseerr:latest
|
||||
container_name: jellyseerr
|
||||
restart: unless-stopped
|
||||
ports:
|
||||
- "5055:5055"
|
||||
environment:
|
||||
- LOG_LEVEL=info
|
||||
volumes:
|
||||
- ./config:/app/config
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 3. Start Jellyseerr
|
||||
|
||||
```bash
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 4. Access Web UI
|
||||
|
||||
Open your browser and go to:
|
||||
|
||||
```
|
||||
http://<your-server-ip>:5055
|
||||
```
|
||||
|
||||
You'll be guided through the setup process:
|
||||
- Create admin account
|
||||
- Connect Jellyfin server
|
||||
- (Optional) Connect Sonarr, Radarr, etc.
|
||||
|
||||
---
|
||||
|
||||
## 5. Update Instructions
|
||||
|
||||
To update Jellyseerr:
|
||||
|
||||
```bash
|
||||
docker compose pull
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 6. Optional: Enable Reverse Proxy
|
||||
|
||||
To expose Jellyseerr via a domain name (e.g. `requests.example.com`), set up a reverse proxy using [Traefik](https://doc.traefik.io/traefik/), Nginx, or Caddy. A basic Traefik label example:
|
||||
|
||||
```yaml
|
||||
labels:
|
||||
- "traefik.enable=true"
|
||||
- "traefik.http.routers.jellyseerr.rule=Host(`requests.example.com`)"
|
||||
- "traefik.http.routers.jellyseerr.entrypoints=websecure"
|
||||
- "traefik.http.routers.jellyseerr.tls.certresolver=myresolver"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## References
|
||||
|
||||
- Jellyseerr GitHub: https://github.com/Fallenbagel/jellyseerr
|
||||
- Docker Hub: https://hub.docker.com/r/fallenbagel/jellyseerr
|
||||
- Official Documentation: https://docs.jellyseerr.com
|
@@ -0,0 +1,61 @@
|
||||
# Introduction
|
||||
|
||||
[**Jellyseerr**](https://docs.jellyseerr.dev/) is a free and open-source media request and discovery platform designed specifically for [**Jellyfin**](https://jellyfin.org). It provides a user-friendly interface for browsing, searching, and requesting movies and TV shows, bridging the gap between your users and your media automation stack (e.g., Jellyfin + Sonarr/Radarr).
|
||||
|
||||
---
|
||||
|
||||
## Key Features
|
||||
|
||||
- 🔎 **Search & Discover**: Browse and search for movies and series from TMDB.
|
||||
- 🎯 **Direct Requests**: Request content directly from the UI, linked to Sonarr and Radarr.
|
||||
- 🔐 **User Management**: Role-based permissions and Jellyfin authentication.
|
||||
- 📅 **Release Tracking**: View upcoming or recently added media.
|
||||
- 💬 **Request Comments**: Users can comment and track the status of their requests.
|
||||
- 🌍 **Multi-language** support with a responsive web UI.
|
||||
|
||||
---
|
||||
|
||||
## Target Audience
|
||||
|
||||
- Jellyfin server admins who want to delegate content requests to users
|
||||
- Home media server users looking to streamline their request workflow
|
||||
- Those looking for a self-hosted alternative to Overseerr (Plex-only)
|
||||
|
||||
---
|
||||
|
||||
## Jellyseerr vs Overseerr
|
||||
|
||||
| Feature | Jellyseerr | Overseerr |
|
||||
|-----------------------------|------------------|---------------|
|
||||
| Media Server Integration | ✅ Jellyfin only | ❌ Plex only |
|
||||
| Open Source | ✅ Yes | ✅ Yes |
|
||||
| Actively Maintained | ✅ Yes | ✅ Yes |
|
||||
| UI and Features | ⭐ Comparable | ⭐ Comparable |
|
||||
| Login with Media Server | ✅ Jellyfin SSO | ✅ Plex OAuth |
|
||||
|
||||
---
|
||||
|
||||
## How It Works
|
||||
|
||||
1. **User logs in** (via Jellyfin)
|
||||
2. **Searches for media** via TMDB integration
|
||||
3. **Requests are submitted** through the UI
|
||||
4. **Sonarr/Radarr handle automation** (optional)
|
||||
5. **Jellyfin picks up downloaded content automatically**
|
||||
|
||||
---
|
||||
|
||||
## Requirements
|
||||
|
||||
- Jellyfin server
|
||||
- Docker or Node.js environment
|
||||
- (Optional) Sonarr, Radarr, and download clients (e.g., qBittorrent, NZBGet)
|
||||
|
||||
---
|
||||
|
||||
## Links
|
||||
|
||||
- 🌐 Project: https://github.com/Fallenbagel/jellyseerr
|
||||
- 📘 Docs: https://docs.jellyseerr.com
|
||||
- 🐳 Docker Hub: https://hub.docker.com/r/fallenbagel/jellyseerr
|
||||
- 💬 Community: https://discord.gg/mVJcS4tq3q
|
Reference in New Issue
Block a user