Merge pull request 'Add healthcheck, backup support, and update documentation' (#5) from yaup/jellyfin:pr/healthcheck-backup-improvements-v2 into main

Reviewed-on: #5
Reviewed-by: ammaratef45 <ammaratef45@proton.me>

.drone.yml

@@ -0,0 +1,39 @@
+---
+kind: pipeline
+name: deploy to swarm-test.autonomic.zone
+steps:
+  - name: deployment
+    image: git.coopcloud.tech/coop-cloud/stack-ssh-deploy:latest
+    settings:
+      host: swarm-test.autonomic.zone
+      stack: jellyfin
+      generate_secrets: true
+      purge: true
+      deploy_key:
+        from_secret: drone_ssh_swarm_test
+      networks:
+        - proxy
+    environment:
+      DOMAIN: jellyfin.swarm-test.autonomic.zone
+      STACK_NAME: jellyfin
+      LETS_ENCRYPT_ENV: production
+      EXTRA_VOLUME: "/dev/null:/tmp/.dummy"
+trigger:
+  branch:
+    - main
+---
+kind: pipeline
+name: generate recipe catalogue
+steps:
+  - name: release a new version
+    image: plugins/downstream
+    settings:
+      server: https://build.coopcloud.tech
+      token:
+        from_secret: drone_abra-bot_token
+      fork: true
+      repositories:
+        - toolshed/auto-recipes-catalogue-json
+
+trigger:
+  event: tag

.env.sample

@@ -1,11 +1,32 @@
-TYPE=jellyfin
+# Jellyfin Co-op Cloud Recipe Configuration
+# ==========================================
 
+# Required Settings
+TYPE=jellyfin
 DOMAIN=jellyfin.example.com
 
-## Domain aliases
-#EXTRA_DOMAINS=', `www.jellyfin.example.com`'
+# Compose Files
+# Add compose.media_volumes.yml for Sonarr/Radarr integration
+COMPOSE_FILE="compose.yml"
 
+# Optional: Additional domains (uncomment to enable)
+# EXTRA_DOMAINS=|| Host(`www.jellyfin.example.com`)
+
+# Let's Encrypt environment (staging or production)
 LETS_ENCRYPT_ENV=production
 
-# Set to an existing path on the host, and define a path inside the container
+# Media Volume Configuration
+# ==========================
+# Mount a local folder containing your media files
+# Example: /mnt/media/movies:/media
 EXTRA_VOLUME=/dev/null:/tmp/.dummy
+
+# Sonarr/Radarr Integration (use with compose.media_volumes.yml)
+# Uncomment these when using the media volumes overlay
+# movies_volume=radarr_media
+# shows_volume=sonarr_media
+
+# Backup Configuration
+# ====================
+# Enable/disable backups (uses backup-bot-two or abra)
+# ENABLE_BACKUPS=true

.gitignore

@@ -1 +1,5 @@
-.envrc
+.env
+.abra/
+*.swp
+*.swo
+*~

README.md

@@ -1,24 +1,129 @@
-# jellyfin
+# Jellyfin
 
-> One line description of the recipe
+> The Free Software Media System
 
 <!-- metadata -->
 
 * **Category**: Apps
-* **Status**: 1, alpha
-* **Image**: [`jellyfin//jellyfin`](https://hub.docker.com/r/jellyfin/jellyfin), 4, upstream
-* **Healthcheck**: No
-* **Backups**: No
-* **Email**: No
-* **Tests**: No
-* **SSO**: No
+* **Status**: 3, Beta
+* **Image**: [`jellyfin/jellyfin`](https://hub.docker.com/r/jellyfin/jellyfin), 4, upstream
+* **Healthcheck**: Yes
+* **Backups**: Yes
 
 <!-- endmetadata -->
 
-## Quick start
+Jellyfin is a free and open-source media server that lets you collect, manage, and stream your media. This recipe deploys Jellyfin with Traefik integration, health monitoring, and optional automated backups.
 
-* `abra app new jellyfin --secrets`
-* `abra app config <app-name>`
-* `abra app deploy <app-name>`
+## Quick Start
 
-For more, see [`docs.coopcloud.tech`](https://docs.coopcloud.tech).
+```bash
+# Create a new Jellyfin instance
+abra app new jellyfin --secrets
+
+# Configure your instance
+abra app config <app-name>
+
+# Deploy
+abra app deploy <app-name>
+```
+
+## Configuration
+
+### Media Volumes
+
+Configure media access by editing `EXTRA_VOLUME` in your app configuration:
+
+```bash
+# Single media folder
+EXTRA_VOLUME=/mnt/media:/media
+
+# Multiple folders (use docker-compose syntax)
+EXTRA_VOLUME=/mnt/movies:/movies
+```
+
+During Jellyfin's initial setup wizard, add your mounted paths as media libraries.
+
+### Backup Configuration
+
+This recipe supports automated backups using [backup-bot-two](https://git.coopcloud.tech/coop-cloud/backup-bot-two) or `abra` backup commands.
+
+#### Enabling Backups
+
+Backups are enabled by default. To disable them, set:
+
+```bash
+ENABLE_BACKUPS=false
+```
+
+#### What Gets Backed Up
+
+* **Config volume** (`/config`): Jellyfin configuration, databases, metadata, and plugins
+* **Cache volume**: Excluded (transcoding cache, not needed in backups)
+
+#### What's Not Backed Up
+
+Media files are not included in backups. Back up your media library separately or ensure you can re-download content if needed.
+
+## Integration with Media Stack
+
+Jellyfin works well with the *arr stack for automated media management:
+
+| Service | Purpose |
+| --- | --- |
+| [qBittorrent](https://git.coopcloud.tech/coop-cloud/qbittorrent) | Torrent client for downloads |
+| [Prowlarr](https://git.coopcloud.tech/coop-cloud/prowlarr) | Indexer manager for all *arr apps |
+| [Sonarr](https://git.coopcloud.tech/coop-cloud/sonarr) | TV show monitoring and download |
+| [Radarr](https://git.coopcloud.tech/coop-cloud/radarr) | Movie monitoring and download |
+| [Jellyseerr](https://git.coopcloud.tech/coop-cloud/jellyseerr) | Request management and discovery UI |
+
+### Shared Media Volumes
+
+When integrating with Sonarr/Radarr, use `compose.media_volumes.yml` to share their media volumes:
+
+```bash
+COMPOSE_FILE="compose.yml:compose.media_volumes.yml"
+movies_volume=radarr_media
+shows_volume=sonarr_media
+```
+
+This mounts Radarr's movies and Sonarr's shows directly into Jellyfin at `/movies` and `/shows`.
+
+## Hardware Transcoding
+
+For hardware-accelerated transcoding, you may need to pass through GPU devices. Create a custom compose overlay:
+
+```yaml
+# compose.gpu.yml
+services:
+  app:
+    devices:
+      - /dev/dri:/dev/dri  # Intel QSV / VAAPI
+```
+
+Then add it to your configuration:
+
+```bash
+COMPOSE_FILE="compose.yml:compose.gpu.yml"
+```
+
+## Troubleshooting
+
+### Health Check Failures
+
+The health check uses Jellyfin's `/health` endpoint. If it fails:
+
+1. Check logs: `abra app logs <app-name>`
+2. Verify the container is running: `abra app ps <app-name>`
+3. Ensure port 8096 isn't blocked internally
+
+### Permission Issues
+
+If Jellyfin can't access media files:
+
+1. Check volume mount permissions
+2. Ensure the container user has read access to media directories
+3. Verify SELinux/AppArmor policies if applicable
+
+## License
+
+Jellyfin is licensed under [GPL-2.0](https://github.com/jellyfin/jellyfin/blob/master/LICENSE).

compose.media_volumes.yml

@@ -0,0 +1,14 @@
+---
+services:
+  app:
+    volumes:
+      - media_movies:/movies
+      - media_shows:/shows
+
+volumes:
+  media_movies:
+    name: ${movies_volume}
+    external: true
+  media_shows:
+    name: ${shows_volume}
+    external: true

compose.yml

@@ -1,41 +1,38 @@
 ---
-version: "3.8"
-
 services:
   app:
-    image: jellyfin/jellyfin:10.8.0
+    image: jellyfin/jellyfin:10.11.1
+    ports:
+      - "8096:8096"
     environment:
       - JELLYFIN_PublishedServerUrl=https://${DOMAIN}
+    volumes:
+      - config:/config
+      - cache:/cache
+      - ${EXTRA_VOLUME:-/dev/null:/tmp/.dummy}
     networks:
       - proxy
-    volumes:
-      - jellyfin_config:/config
-      - jellyfin_cache:/cache
-      - ${EXTRA_VOLUME}
     deploy:
       restart_policy:
         condition: on-failure
       labels:
         - "traefik.enable=true"
-        - "traefik.http.services.${STACK_NAME}.loadbalancer.server.port=8096"
-        - "traefik.http.routers.${STACK_NAME}.rule=Host(`${DOMAIN}`${EXTRA_DOMAINS})"
+        - "traefik.http.routers.${STACK_NAME}.rule=Host(`${DOMAIN}`)${EXTRA_DOMAINS}"
         - "traefik.http.routers.${STACK_NAME}.entrypoints=web-secure"
-        - "traefik.http.routers.${STACK_NAME}.tls.certresolver=${LETS_ENCRYPT_ENV}"
-        ## Redirect from EXTRA_DOMAINS to DOMAIN
-        #- "traefik.http.routers.${STACK_NAME}.middlewares=${STACK_NAME}-redirect"
-        #- "traefik.http.middlewares.${STACK_NAME}-redirect.headers.SSLForceHost=true"
-        #- "traefik.http.middlewares.${STACK_NAME}-redirect.headers.SSLHost=${DOMAIN}"
-        - "coop-cloud.${STACK_NAME}.version=0.1.0+10.8.0"
-    # healthcheck:
-    #   test: ["CMD", "curl", "-f", "http://localhost:8096"]
-    #   interval: 30s
-    #   timeout: 10s
-    #   retries: 10
-    #   start_period: 1m
+        - "traefik.http.routers.${STACK_NAME}.tls.certresolver=${LETS_ENCRYPT_ENV:-production}"
+        - "traefik.http.services.${STACK_NAME}.loadbalancer.server.port=8096"
+        - "backupbot.backup=${ENABLE_BACKUPS:-true}"
+        - "backupbot.backup.volumes.cache=false"
+    healthcheck:
+      test: ["CMD", "curl", "-f", "http://localhost:8096/health"]
+      interval: 30s
+      timeout: 10s
+      retries: 3
+      start_period: 60s
 
 volumes:
-  jellyfin_config:
-  jellyfin_cache:
+  config:
+  cache:
 
 networks:
   proxy: