diff --git a/jellyseerr_dev/README.md b/jellyseerr_dev/README.md index 97f3919..86c0f51 100644 --- a/jellyseerr_dev/README.md +++ b/jellyseerr_dev/README.md @@ -1,7 +1,71 @@ # Jellyseerr -Official Site: https://docs.jellyseerr.dev/ -Proxy port: 5055 -composer sample: https://hotio.dev/containers/jellyseerr/#__tabbed_1_2 +## Overview -Jellyseerr is a free and open-source software application for managing requests for your media library. As a fork of Overseerr, it's been adapted to work seamlessly with Jellyfin and Emby media servers. It provides a simple and user-friendly interface that allows your users to browse, discover, and request new movies and TV shows. Once a request is made and approved, Jellyseerr integrates with your existing *arr stack (Sonarr, Radarr) to automatically handle the searching and downloading of the requested content, streamlining the entire process of adding new media to your server. \ No newline at end of file +Jellyseerr is a free and open-source request management system for your Jellyfin/Emby media library, forked from Overseerr. It lets users browse, discover, and request movies and TV shows. Approved requests are sent to Sonarr/Radarr for automatic downloading. + +## Project Details + +- **Project Repository:** [https://docs.jellyseerr.dev/](https://docs.jellyseerr.dev/) +- **Container Image:** [ghcr.io/hotio/jellyseerr](https://hotio.dev/containers/jellyseerr/) +- **Reverse Proxy Port:** `5055` + +## Getting Started + +Open http://localhost:5055 in your browser and complete the initial setup: + +1. **Create your admin account** +2. **Connect your media server** — select Jellyfin or Emby, enter server URL and API key +3. **Connect Sonarr and Radarr** — Jellyseerr needs these to handle requests +4. Users can now browse your library and submit requests via the Jellyseerr UI + +### Request flow + +User submits a request → approved (auto or manual) → Jellyseerr sends it to Sonarr/Radarr → download client grabs it → media appears in Jellyfin + +## Environment Variable Notes + +| Variable | Description | +|---|---| +| `JELLYSEERR_IMAGE` | Container image (default: `ghcr.io/hotio/jellyseerr:release`) | +| `JELLYSEERR_RESTART` | Restart policy (default: `unless-stopped`) | +| `JELLYSEERR_PORT` | Published port for the web UI (default: `5055`) | +| `VOL_PATH` | Base path for persistent data volumes (default: `/data`) | + +## Volume Notes + +| Volume | Purpose | +|---|---| +| `${VOL_PATH:-/data}/jellyseerr/config` | Application configuration and database | + +## Network Notes + +Requires an external `proxy` network. Create it once with: + +```bash +docker network create proxy +``` + +## Docker Run + +```bash +docker run -d \ + --name=jellyseerr \ + -e PUID=1000 \ + -e PGID=1000 \ + -e UMASK=002 \ + -p 5055:5055 \ + -v ${VOL_PATH:-/data}/jellyseerr/config:/config \ + --network proxy \ + --restart unless-stopped \ + ghcr.io/hotio/jellyseerr:release +``` + +## Dockhand Stack, Deploy from Git + +- **Cookbooks Repository** +- **stackname:** jellyseerr_dev +- **Compose file path:** jellyseerr_dev/compose.yaml +- **Additional env file (optional):** jellyseerr_dev/sample.env + +Load `jellyseerr_dev/sample.env` into the Environment variables in Dockhand, then create the Stack. diff --git a/jellyseerr_dev/compose.yaml b/jellyseerr_dev/compose.yaml new file mode 100644 index 0000000..b995591 --- /dev/null +++ b/jellyseerr_dev/compose.yaml @@ -0,0 +1,18 @@ +services: + jellyseerr: + image: ${JELLYSEERR_IMAGE:-ghcr.io/hotio/jellyseerr:release} + restart: ${JELLYSEERR_RESTART:-unless-stopped} + volumes: + - ${VOL_PATH:-/data}/jellyseerr/config:/config + environment: + - PUID=1000 + - PGID=1000 + - UMASK=002 + ports: + - "${JELLYSEERR_PORT:-5055}:5055" + networks: + - proxy + +networks: + proxy: + external: true diff --git a/jellyseerr_dev/docker-compose.yml b/jellyseerr_dev/docker-compose.yml deleted file mode 100644 index 1cf5727..0000000 --- a/jellyseerr_dev/docker-compose.yml +++ /dev/null @@ -1,13 +0,0 @@ -services: - jellyseerr: - container_name: jellyseerr - image: ${JELLYSEERR_IMAGE} - ports: - - "5055:5055" - environment: - - PUID=1000 - - PGID=1000 - - UMASK=002 - - TZ=${TZ} - volumes: - - ${VOL_PATH}:/config \ No newline at end of file diff --git a/jellyseerr_dev/sample.env b/jellyseerr_dev/sample.env index 4a39fa6..cec3eca 100644 --- a/jellyseerr_dev/sample.env +++ b/jellyseerr_dev/sample.env @@ -1,4 +1,3 @@ # Jellyseerr -VOL_PATH=./data/jellyseerr/config +VOL_PATH=/data JELLYSEERR_IMAGE=ghcr.io/hotio/jellyseerr:release -TZ="America/Vancouver"