docs & code: fix all 43 findings from code review & align E2E test suite

Author: nordicnode

.env.example

@@ -6,10 +6,15 @@
 #   TORBOX_API_KEY="your-key" TORBOX_MEDIA_SERVER="plex" ./setup.sh --yes
 
 # ── Required ────────────────────────────────────────────────────
-
-
+# Paste your TorBox API key here (get it from https://torbox.app/settings)
+TORBOX_API_KEY=""
 
 # ── Optional ────────────────────────────────────────────────────
+# Docker Compose profiles: "plex" or "jellyfin" (matches your media server selection)
+# COMPOSE_PROFILES="plex"
+
+# Configurable Prowlarr default indexer URL (default: https://1337x.to)
+# TORBOX_INDEXER_URL="https://1337x.to"
 # Media server: "plex" (default) or "jellyfin"
 # TORBOX_MEDIA_SERVER="plex"
 

.github/workflows/lint.yml

@@ -57,12 +57,34 @@ jobs:
 
       - name: Extract and validate manage.sh
         run: |
-          # Extract the heredoc content that generates manage.sh from setup.sh
-          # Strip the first and last lines of each heredoc block (cat/EOF wrappers)
-          # so bash -n checks the actual script content, not the heredoc container.
-          sed -n '/^cat > "${INSTALL_DIR}\/manage.sh" << .MANAGE_EOF.$/,/^MANAGE_EOF$/p' setup.sh | sed '1d;$d' > /tmp/manage_extracted.sh
-          sed -n '/^cat >> "${INSTALL_DIR}\/manage.sh" << .MANAGE_INLINE.$/,/^MANAGE_INLINE$/p' setup.sh | sed '1d;$d' >> /tmp/manage_extracted.sh
-          bash -n /tmp/manage_extracted.sh && echo "manage.sh syntax OK" || { echo "manage.sh has syntax errors"; exit 1; }
+          # Extract the heredoc content that generates manage.sh from setup.sh.
+          # Track heredoc delimiters per opening `cat ... manage.sh <<'TAG'` line so
+          # that nested heredocs (or same-named delimiters in a single file) are
+          # captured correctly. Strip the cat/EOF wrapper lines from the output.
+          awk '
+            /^cat >+"\${INSTALL_DIR}\/manage.sh" <</ {
+              match($0, /<<'\''(MANAGE_[A-Z_]+)'\''$/, m)
+              tag = m[1]
+              print "### " NR ": " $0
+              capturing = 1
+              next
+            }
+            capturing && $0 == tag {
+              print "### " NR ": " $0
+              capturing = 0
+              tag = ""
+              next
+            }
+            capturing { print }
+          ' setup.sh > /tmp/manage_extracted.sh
+          if [[ ! -s /tmp/manage_extracted.sh ]]; then
+            echo "::error::manage.sh extraction failed: no content captured from setup.sh heredocs"
+            exit 1
+          fi
+          bash -n /tmp/manage_extracted.sh && echo "manage.sh syntax OK" || {
+            echo "::error::manage.sh has syntax errors"
+            exit 1
+          }
 
       - name: Validate uninstall.sh syntax
         run: bash -n uninstall.sh && echo "uninstall.sh syntax OK"

.gitignore

@@ -2,6 +2,9 @@
 .env
 .env.local
 .env.*
+!.env.example
+docker-compose.override.yml
+docker-compose.override.yaml
 
 # Logs and temp files
 *.log

README.md

@@ -336,6 +336,10 @@ cd torbox-media-server/
 ./manage.sh keys      # Show API keys (use with care)
 ./manage.sh enable    # Enable auto-start on boot
 ./manage.sh disable   # Disable auto-start on boot
+./manage.sh backup    # Backup configuration and credentials
+./manage.sh restore   # Restore configuration from a backup
+./manage.sh health    # Run health checks on all services
+./manage.sh shell svc # Open a shell inside a container (e.g. radarr)
 ```
 
 > **Auto-start on boot:** The setup script installs a systemd service (`torbox-media-server`) that automatically handles mount propagation and starts all containers when your computer boots. You don't need to do anything — just turn on your computer and everything will be running.
@@ -344,7 +348,7 @@ cd torbox-media-server/
 
 ```
 torbox-media-server/
-├── docker-compose.yml          # Auto-generated Docker Compose
+├── docker-compose.yml          # Version-controlled Docker Compose
 ├── .env                        # API keys, user IDs, timezone, mount paths
 ├── manage.sh                   # Management script (start/stop/logs/etc.)
 ├── configs/
@@ -436,8 +440,8 @@ chmod +x uninstall.sh
 The script will:
 1. Stop and remove all Docker containers and the network
 2. Remove the systemd auto-start service
-3. Remove the installation directory (configs, data, docker-compose, .env)
-4. Unmount and remove the mount point
+3. Unmount and remove the mount point
+4. Remove the installation directory (configs, data, docker-compose, .env)
 5. Optionally remove Docker images to free ~5–8 GB of disk space
 
 You'll be asked to confirm before anything is removed. Your TorBox account and cloud-stored media are not affected.

docker-compose.yml

@@ -40,7 +40,7 @@ services:
     cap_add:
       - SYS_ADMIN
     healthcheck:
-      test: ["CMD", "curl", "-sf", "http://localhost:8282"]
+      test: ["CMD-SHELL", "curl -sf http://localhost:8282 || wget -qO- http://localhost:8282 || exit 1"]
       interval: 30s
       timeout: 10s
       retries: 3
@@ -53,6 +53,10 @@ services:
     security_opt:
       # Harmless on systems without AppArmor (e.g. CachyOS)
       - apparmor:unconfined
+    deploy:
+      resources:
+        limits:
+          memory: 1g
 
   # ── Prowlarr ───────────────────────────────────────────────────
   # Indexer manager - feeds search results to Radarr & Sonarr.
@@ -84,6 +88,10 @@ services:
       start_period: 30s
     volumes:
       - "${CONFIG_DIR}/prowlarr:/config"
+    deploy:
+      resources:
+        limits:
+          memory: 512m
 
   # ── Byparr ────────────────────────────────────────────────────
   # Cloudflare bypass proxy (Byparr - drop-in FlareSolverr replacement).
@@ -110,6 +118,10 @@ services:
       timeout: 10s
       retries: 3
       start_period: 30s
+    deploy:
+      resources:
+        limits:
+          memory: 1g
 
   # ── Radarr ─────────────────────────────────────────────────────
   # Movie management - searches, grabs, and organizes movies.
@@ -144,6 +156,10 @@ services:
       - "${CONFIG_DIR}/radarr:/config"
       - "${DATA_DIR}:/data"
       - "${MOUNT_DIR}:/mnt/remote:rslave"
+    deploy:
+      resources:
+        limits:
+          memory: 1g
 
   # ── Sonarr ─────────────────────────────────────────────────────
   # TV show management - searches, grabs, and organizes series.
@@ -178,6 +194,10 @@ services:
       - "${CONFIG_DIR}/sonarr:/config"
       - "${DATA_DIR}:/data"
       - "${MOUNT_DIR}:/mnt/remote:rslave"
+    deploy:
+      resources:
+        limits:
+          memory: 1g
 
   # ── Seerr ───────────────────────────────────────────────────────
   # Media request & discovery frontend.
@@ -210,6 +230,10 @@ services:
       start_period: 60s
     volumes:
       - "${CONFIG_DIR}/seerr:/app/config"
+    deploy:
+      resources:
+        limits:
+          memory: 1g
 
   # ── Plex ───────────────────────────────────────────────────────
   # Media server option 1 - streams your library to any device.
@@ -244,6 +268,10 @@ services:
       options:
         max-size: "10m"
         max-file: "3"
+    deploy:
+      resources:
+        limits:
+          memory: 4g
 
   # ── Jellyfin ───────────────────────────────────────────────────
   # Media server option 2 (open-source) - streams your library.
@@ -281,3 +309,7 @@ services:
       options:
         max-size: "10m"
         max-file: "3"
+    deploy:
+      resources:
+        limits:
+          memory: 4g