@simplehomelab/deployrr 6.0.0-rc3

package/apps/official/sabnzbd/compose.yml

@@ -0,0 +1,23 @@
+services:
+  # SABnzbd - Binary newsgrabber (NZB downloader)
+  # Disable SABNnzbd's built-in HTTPS support for traefik proxy to work
+  sabnzbd:
+    image: lscr.io/linuxserver/sabnzbd:latest
+    container_name: sabnzbd
+    security_opt:
+      - no-new-privileges:true
+    restart: unless-stopped
+    profiles: ["apps", "downloads", "all"]
+    networks:
+      - default
+    ports:
+      - "$SABNZBD_PORT:8080" 
+    volumes:
+      - $DOCKERDIR/appdata/sabnzbd:/config
+      - $DOWNLOADSDIR:/data/downloads
+    environment:
+      PUID: $PUID
+      PGID: $PGID
+      TZ: $TZ
+      UMASK_SET: 002
+    # DOCKER-LABELS-PLACEHOLDER

package/apps/official/sabnzbd/files/post-install.sh

@@ -0,0 +1,35 @@
+#!/bin/bash
+# SABnzbd Post-Install Script
+# Adds domain and container name to SABnzbd whitelist for Traefik access
+
+APP_SNAME="sabnzbd"
+APP_PNAME="SABnzbd"
+INI_FILE="$DOCKER_FOLDER/appdata/sabnzbd/sabnzbd.ini"
+
+f_print_step "1/3" "Waiting for $APP_PNAME config to be created..."
+f_print_substep "Waiting 5 seconds for $INI_FILE"
+sleep 5
+echo
+
+f_print_step "2/3" "Configuring $APP_PNAME whitelist..."
+f_print_substep "Stopping $APP_PNAME container"
+sudo docker stop "$APP_SNAME" >/dev/null 2>&1
+sleep 3
+
+# Get container ID for whitelist
+SABNZBD_CONTAINER_ID=$(sudo docker ps -aqf "name=^${APP_SNAME}$" 2>/dev/null || echo "")
+
+if [[ -n "$SABNZBD_CONTAINER_ID" && -f "$INI_FILE" ]]; then
+    f_print_substep "Adding to whitelist: ${FILE_PROVIDER_APP_SUBDOMAIN}.${DOMAINNAME_1}"
+    f_print_substep "Editing: $INI_FILE"
+    # Add domain and app name to the whitelist (host_whitelist line)
+    sudo sed -i "s/${SABNZBD_CONTAINER_ID},/${SABNZBD_CONTAINER_ID},${FILE_PROVIDER_APP_SUBDOMAIN}.${DOMAINNAME_1},${APP_SNAME}/g" "$INI_FILE"
+else
+    f_print_substep "Container ID or config file not found, skipping whitelist update"
+fi
+sleep 3
+echo
+
+f_print_step "3/3" "Restarting $APP_PNAME..."
+sudo docker start "$APP_SNAME" >/dev/null 2>&1
+f_print_success "$APP_PNAME whitelist configuration complete"

package/apps/official/sabnzbd/manifest.json

@@ -0,0 +1,75 @@
+{
+  "$schema": "../../../apps/manifest-schema.json",
+  "version": "1.2",
+
+  "app": {
+    "sname": "sabnzbd",
+    "pname": "SABnzbd",
+    "description": "SABnzbd is a free and easy binary newsreader. It simplifies the process of downloading from Usenet with automation and a clean web interface.",
+    "descriptionShort": "Usenet downloader",
+    "icon": "sh-sabnzbd",
+    "category": "official",
+    "menuNumber": "06",
+    "tags": ["downloads", "usenet", "automation"]
+  },
+
+  "deployment": {
+    "type": "single",
+    "compose": "compose.yml",
+    "profiles": ["apps", "downloads", "all"],
+    "networks": ["default"],
+    "webui": true,
+    "port": 8080,
+    "protocol": "http"
+  },
+
+  "requirements": {
+    "prerequisites": ["prerequisites", "downloads_folder"],
+    "apps": []
+  },
+
+  "folders": {
+    "permissions": {
+      "appdata": "$PUID:$PGID"
+    }
+  },
+
+  "hooks": {
+    "postInstall": "files/post-install.sh"
+  },
+
+  "traefik": {
+    "supported": true
+  },
+
+  "dashboard": {
+    "enabled": true,
+    "location": "local",
+    "showStats": true,
+    "portVariable": "SABNZBD_PORT"
+  },
+
+  "env": {
+    "variables": [
+      {
+        "name": "SABNZBD_PORT",
+        "description": "Web interface port",
+        "type": "port",
+        "default": 8080,
+        "prompt": true,
+        "required": true,
+        "validation": {
+          "type": "port",
+          "min": 1,
+          "max": 65535
+        }
+      }
+    ]
+  },
+
+  "status": {
+    "file": "06_sabnzbd_status",
+    "successMessage": "SABnzbd Setup Completed",
+    "telemetryAction": "sabnzbd"
+  }
+}

package/apps/official/scrutiny/compose.yml

@@ -0,0 +1,25 @@
+services:
+  # Scrutiny - WebUI for smartd S.M.A.R.T monitoring
+  scrutiny:
+    image: ghcr.io/analogj/scrutiny:${SCRUTINY_VERSION_PIN}
+    container_name: scrutiny
+    security_opt:
+      - no-new-privileges:true
+    restart: unless-stopped
+    profiles: ["apps", "monitoring", "all"]
+    networks:
+      - default
+    depends_on:
+      scrutiny-influxdb:
+        condition: service_healthy
+    ports:
+      - $SCRUTINY_PORT:8080
+    volumes:
+      - $DOCKERDIR/appdata/scrutiny:/opt/scrutiny/config
+    environment:
+      - SCRUTINY_WEB_INFLUXDB_HOST=scrutiny-influxdb
+      - SCRUTINY_WEB_INFLUXDB_PORT=8086
+      - SCRUTINY_WEB_INFLUXDB_TOKEN=$SCRUTINY_INFLUXDB_TOKEN
+      - SCRUTINY_WEB_INFLUXDB_ORG=scrutiny
+      - SCRUTINY_WEB_INFLUXDB_BUCKET=scrutiny
+    # DOCKER-LABELS-PLACEHOLDER

package/apps/official/scrutiny/manifest.json

@@ -0,0 +1,113 @@
+{
+  "$schema": "../../../apps/manifest-schema.json",
+  "version": "1.2",
+
+  "app": {
+    "sname": "scrutiny",
+    "pname": "Scrutiny",
+    "description": "Scrutiny is a WebUI for smartd S.M.A.R.T monitoring with a dedicated InfluxDB backend for historical data storage and analysis of disk health metrics.",
+    "descriptionShort": "SMART disk monitoring",
+    "icon": "sh-scrutiny",
+    "category": "official",
+    "menuNumber": "06",
+    "tags": ["monitoring", "disk", "smart", "health", "influxdb"]
+  },
+
+  "deployment": {
+    "type": "multicontainer",
+    "compose": "compose.yml",
+    "profiles": ["apps", "monitoring", "all"],
+    "networks": ["default"],
+    "webui": true,
+    "port": 8081,
+    "protocol": "http"
+  },
+
+  "dependencies": [
+    {
+      "sname": "scrutiny-influxdb",
+      "pname": "Scrutiny InfluxDB",
+      "compose": "scrutiny-influxdb.yml",
+      "installOrder": 1,
+      "waitForHealthy": true,
+      "required": true,
+      "description": "Dedicated InfluxDB database for Scrutiny"
+    }
+  ],
+
+  "requirements": {
+    "prerequisites": ["prerequisites"],
+    "apps": []
+  },
+
+  "database": {
+    "type": "influxdb",
+    "containerSname": "scrutiny-influxdb",
+    "name": "scrutiny",
+    "user": "scrutiny_admin",
+    "host": "scrutiny-influxdb",
+    "port": 8086
+  },
+
+  "traefik": {
+    "supported": true
+  },
+
+  "dashboard": {
+    "enabled": true,
+    "location": "local",
+    "showStats": true,
+    "portVariable": "SCRUTINY_PORT"
+  },
+
+  "env": {
+    "variables": [
+      {
+        "name": "SCRUTINY_PORT",
+        "description": "Web interface port",
+        "type": "port",
+        "default": 8081,
+        "prompt": true,
+        "required": true,
+        "validation": {
+          "type": "port",
+          "min": 1,
+          "max": 65535
+        }
+      },
+      {
+        "name": "SCRUTINY_INFLUXDB_TOKEN",
+        "description": "InfluxDB admin token (auto-generated)",
+        "type": "password",
+        "generate": "random",
+        "length": 32,
+        "prompt": false,
+        "required": true
+      },
+      {
+        "name": "SCRUTINY_INFLUXDB_PASSWORD",
+        "description": "InfluxDB admin password (auto-generated)",
+        "type": "password",
+        "generate": "random",
+        "length": 24,
+        "prompt": false,
+        "required": true
+      }
+    ]
+  },
+
+  "postInstall": {
+    "messages": [
+      {
+        "type": "note",
+        "text": "Scrutiny uses a dedicated InfluxDB (\\Z5scrutiny-influxdb\\Zn). Credentials stored in \\Z4$DOCKER_FOLDER/.env\\Zn."
+      }
+    ]
+  },
+
+  "status": {
+    "file": "06_scrutiny_status",
+    "successMessage": "Scrutiny Setup Completed",
+    "telemetryAction": "scrutiny"
+  }
+}

package/apps/official/scrutiny/scrutiny-influxdb.yml

@@ -0,0 +1,28 @@
+services:
+  # Scrutiny InfluxDB - Dedicated Database for Scrutiny
+  scrutiny-influxdb:
+    container_name: scrutiny-influxdb
+    image: influxdb:${SCRUTINYINFLUXDB_VERSION_PIN}
+    security_opt:
+      - no-new-privileges:true
+    restart: unless-stopped
+    profiles: ["apps", "monitoring", "all"]
+    healthcheck:
+      test: ["CMD", "influx", "ping"]
+      start_period: 30s
+      interval: 30s
+      retries: 5
+      timeout: 10s
+    networks:
+      - default
+    volumes:
+      - $DOCKERDIR/appdata/scrutiny-influxdb/config:/etc/influxdb2
+      - $DOCKERDIR/appdata/scrutiny-influxdb/db:/var/lib/influxdb2
+    environment:
+      - DOCKER_INFLUXDB_INIT_MODE=setup
+      - DOCKER_INFLUXDB_INIT_USERNAME=scrutiny_admin
+      - DOCKER_INFLUXDB_INIT_PASSWORD=$SCRUTINY_INFLUXDB_PASSWORD
+      - DOCKER_INFLUXDB_INIT_ORG=scrutiny
+      - DOCKER_INFLUXDB_INIT_BUCKET=scrutiny
+      - DOCKER_INFLUXDB_INIT_ADMIN_TOKEN=$SCRUTINY_INFLUXDB_TOKEN
+    # DOCKER-LABELS-PLACEHOLDER

package/apps/official/searxng/compose.yml

@@ -0,0 +1,28 @@
+services:
+  # SearXNG - Privacy-respecting Metasearch Engine
+  searxng:
+    container_name: searxng
+    image: docker.io/searxng/searxng:latest
+    security_opt:
+      - no-new-privileges:true
+    restart: unless-stopped
+    profiles: ["apps", "all"]
+    networks:
+      - default
+    ports:
+      - "$SEARXNG_PORT:8080"
+    volumes:
+      - $DOCKERDIR/appdata/searxng/settings:/etc/searxng:rw
+      - $DOCKERDIR/appdata/searxng/cache:/var/cache/searxng:rw
+    environment:
+      - SEARXNG_BASE_URL=https://${SEARXNG_HOSTNAME:-localhost}/
+      - UWSGI_WORKERS=${SEARXNG_UWSGI_WORKERS:-4}
+      - UWSGI_THREADS=${SEARXNG_UWSGI_THREADS:-4}
+      - SEARXNG_SECRET=${SEARXNG_SECRET}
+    cap_drop:
+      - ALL
+    cap_add:
+      - CHOWN
+      - SETGID
+      - SETUID
+    # DOCKER-LABELS-PLACEHOLDER

package/apps/official/searxng/files/limiter.toml

@@ -0,0 +1,6 @@
+# This configuration file updates the default configuration file
+# See https://github.com/searxng/searxng/blob/master/searx/limiter.toml
+
+[botdetection.ip_limit]
+# activate link_token method in the ip_limit method
+link_token = true

package/apps/official/searxng/files/pre-install.sh

@@ -0,0 +1,25 @@
+#!/bin/bash
+# SearXNG pre-install hook
+# Generates secret key and deploys preconfigured settings before containers start
+
+APP_SNAME="searxng"
+APP_PNAME="SearXNG"
+APP_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
+
+# Generate secret key
+f_print_substep "Generating $APP_PNAME secret key..."
+SEARXNG_SECRET_VALUE=$(openssl rand -hex 16)
+f_set_env "SEARXNG_SECRET" "$SEARXNG_SECRET_VALUE"
+
+# Create appdata directories
+f_print_substep "Creating $APP_PNAME configuration directories..."
+sudo mkdir -p "$DOCKER_FOLDER/appdata/searxng/settings"
+sudo mkdir -p "$DOCKER_FOLDER/appdata/searxng/cache"
+
+# Copy preconfigured settings.yml and substitute secret key placeholder
+f_print_substep "Deploying $APP_PNAME configuration files..."
+sudo cp "$APP_DIR/files/settings.yml" "$DOCKER_FOLDER/appdata/searxng/settings/settings.yml"
+sudo sed -i "s|SEARXNG-SECRET-KEY-PLACEHOLDER|$SEARXNG_SECRET_VALUE|g" "$DOCKER_FOLDER/appdata/searxng/settings/settings.yml"
+
+# Copy limiter.toml for bot detection
+sudo cp "$APP_DIR/files/limiter.toml" "$DOCKER_FOLDER/appdata/searxng/settings/limiter.toml"

package/apps/official/searxng/files/settings.yml

@@ -0,0 +1,8 @@
+# see https://docs.searxng.org/admin/settings/settings.html#settings-use-default-settings
+use_default_settings: true
+server:
+  secret_key: "SEARXNG-SECRET-KEY-PLACEHOLDER"  # change this!
+  limiter: false  # enable this when running the instance for a public usage on the internet
+  image_proxy: true
+valkey:
+  url: redis://searxng-valkey:6379/0

package/apps/official/searxng/manifest.json

@@ -0,0 +1,88 @@
+{
+  "$schema": "../../../apps/manifest-schema.json",
+  "version": "1.2",
+
+  "app": {
+    "sname": "searxng",
+    "pname": "SearXNG",
+    "description": "SearXNG is a free internet metasearch engine which aggregates results from various search services and databases. Users are neither tracked nor profiled.",
+    "descriptionShort": "Privacy-respecting metasearch engine",
+    "icon": "sh-searxng",
+    "category": "official",
+    "menuNumber": "06",
+    "tags": ["search", "privacy", "metasearch"]
+  },
+
+  "deployment": {
+    "type": "multicontainer",
+    "compose": "compose.yml",
+    "profiles": ["apps", "all"],
+    "networks": ["default"],
+    "webui": true,
+    "port": 8081,
+    "protocol": "http"
+  },
+
+  "dependencies": [
+    {
+      "sname": "searxng-valkey",
+      "pname": "SearXNG Valkey",
+      "compose": "searxng-valkey.yml",
+      "installOrder": 1,
+      "waitForHealthy": true,
+      "required": true,
+      "description": "Dedicated Valkey cache for SearXNG"
+    }
+  ],
+
+  "requirements": {
+    "prerequisites": ["prerequisites"],
+    "apps": []
+  },
+
+  "env": {
+    "variables": [
+      {
+        "name": "SEARXNG_PORT",
+        "description": "Web interface port",
+        "type": "port",
+        "default": 8081,
+        "prompt": true,
+        "required": true,
+        "validation": {
+          "type": "port",
+          "min": 1,
+          "max": 65535
+        }
+      },
+      {
+        "name": "SEARXNG_SECRET",
+        "description": "SearXNG secret key (auto-generated via pre-install hook)",
+        "type": "password",
+        "prompt": false,
+        "required": true
+      }
+    ]
+  },
+
+  "hooks": {
+    "preInstall": "files/pre-install.sh"
+  },
+
+  "traefik": {
+    "supported": true
+  },
+
+  "dashboard": {
+    "enabled": true,
+    "location": "local",
+    "showStats": true,
+    "portVariable": "SEARXNG_PORT"
+  },
+
+  "status": {
+    "file": "06_searxng_status",
+    "successMessage": "SearXNG Setup Completed",
+    "telemetryAction": "searxng"
+  }
+}

package/apps/official/searxng/searxng-valkey.yml

@@ -0,0 +1,26 @@
+services:
+  # SearXNG Valkey - Dedicated Cache for SearXNG
+  searxng-valkey:
+    container_name: searxng-valkey
+    image: docker.io/valkey/valkey:8-alpine
+    security_opt:
+      - no-new-privileges:true
+    restart: unless-stopped
+    profiles: ["apps", "all"]
+    command: valkey-server --save 30 1 --loglevel warning
+    healthcheck:
+      test: ["CMD-SHELL", "valkey-cli ping | grep PONG"]
+      start_period: 20s
+      interval: 30s
+      retries: 5
+      timeout: 3s
+    volumes:
+      - $DOCKERDIR/appdata/searxng-valkey:/data
+    networks:
+      - default
+    logging:
+      driver: "json-file"
+      options:
+        max-size: "1m"
+        max-file: "1"
+    # DOCKER-LABELS-PLACEHOLDER

package/apps/official/shellinabox/manifest.json

@@ -0,0 +1,68 @@
+{
+  "$schema": "../../../apps/manifest-schema.json",
+  "version": "1.2",
+
+  "app": {
+    "sname": "shellinabox",
+    "pname": "ShellInABox",
+    "description": "ShellInABox is a web-based SSH terminal for Linux, allowing secure terminal access through your browser. It provides a convenient way to access your server remotely without needing a native SSH client.",
+    "descriptionShort": "Web-based SSH terminal (non-Docker)",
+    "icon": "sh-shell",
+    "category": "Remote Access",
+    "menuNumber": "06",
+    "tags": ["ssh", "terminal", "remote-access", "system-app"]
+  },
+
+  "deployment": {
+    "type": "system",
+    "compose": null,
+    "profiles": [],
+    "networks": [],
+    "webui": true,
+    "port": 4200,
+    "protocol": "http"
+  },
+
+  "system": {
+    "package": "shellinabox",
+    "service": "shellinabox",
+    "configFile": "/etc/default/shellinabox",
+    "installCommand": "apt install -y shellinabox",
+    "removeCommand": "apt remove -y shellinabox",
+    "enableCommand": "systemctl enable shellinabox",
+    "disableCommand": "systemctl disable shellinabox",
+    "startCommand": "systemctl start shellinabox",
+    "stopCommand": "systemctl stop shellinabox"
+  },
+
+  "requirements": {
+    "prerequisites": ["prerequisites", "traefik_production", "advanced_auth"],
+    "apps": [],
+    "license": "basicpluspro"
+  },
+
+  "traefik": {
+    "supported": true,
+    "useFileProvider": true,
+    "hostIp": "DOCKER0_IP",
+    "note": "SSL is disabled in ShellInABox; Traefik handles SSL termination"
+  },
+
+  "dashboard": {
+    "enabled": true,
+    "location": "both",
+    "showStats": false,
+    "localUrl": "http://DOCKER0_IP:4200",
+    "remoteUrl": "https://shellinabox.DOMAINNAME_1"
+  },
+
+  "status": {
+    "file": "06_shellinabox_status",
+    "successMessage": "ShellInABox Setup Completed",
+    "telemetryAction": "shellinabox"
+  },
+
+  "warnings": [
+    "Do not expose to the internet without strong authentication"
+  ]
+}

package/apps/official/smokeping/compose.yml

@@ -0,0 +1,21 @@
+services:
+  # SmokePing - Network latency Monitoring
+  smokeping:
+    image: lscr.io/linuxserver/smokeping:latest
+    container_name: smokeping
+    security_opt:
+      - no-new-privileges:true
+    restart: unless-stopped
+    profiles: ["apps", "monitoring", "all"]
+    networks:
+      - default
+    ports:
+      - "$SMOKEPING_PORT:80"
+    volumes:
+      - $DOCKERDIR/appdata/smokeping/config:/config
+      - $DOCKERDIR/appdata/smokeping/data:/data
+    environment:
+      PUID: $PUID
+      PGID: $PGID
+      TZ: $TZ
+    # DOCKER-LABELS-PLACEHOLDER

package/apps/official/smokeping/manifest.json

@@ -0,0 +1,65 @@
+{
+  "$schema": "../../../apps/manifest-schema.json",
+  "version": "1.2",
+
+  "app": {
+    "sname": "smokeping",
+    "pname": "SmokePing",
+    "description": "SmokePing is a deluxe latency measurement tool that can measure, store, and display latency, latency distribution, and packet loss. It uses RRDtool to maintain a long-term data store.",
+    "descriptionShort": "Latency logging, graphing, and alerting",
+    "icon": "sh-smokeping",
+    "category": "official",
+    "menuNumber": "06",
+    "tags": ["monitoring", "network", "latency"]
+  },
+
+  "deployment": {
+    "type": "single",
+    "compose": "compose.yml",
+    "profiles": ["apps", "monitoring", "all"],
+    "networks": ["default"],
+    "webui": true,
+    "port": 8081,
+    "protocol": "http"
+  },
+
+  "requirements": {
+    "prerequisites": ["prerequisites"],
+    "apps": []
+  },
+
+  "traefik": {
+    "supported": true
+  },
+
+  "dashboard": {
+    "enabled": true,
+    "location": "local",
+    "showStats": true,
+    "portVariable": "SMOKEPING_PORT"
+  },
+
+  "env": {
+    "variables": [
+      {
+        "name": "SMOKEPING_PORT",
+        "description": "Web interface port",
+        "type": "port",
+        "default": 8081,
+        "prompt": true,
+        "required": true,
+        "validation": {
+          "type": "port",
+          "min": 1,
+          "max": 65535
+        }
+      }
+    ]
+  },
+
+  "status": {
+    "file": "06_smokeping_status",
+    "successMessage": "SmokePing Setup Completed",
+    "telemetryAction": "smokeping"
+  }
+}

package/apps/official/sonarr/compose.yml

@@ -0,0 +1,25 @@
+services:
+  # Sonarr - TV Shows Management
+  sonarr:
+    image: lscr.io/linuxserver/sonarr:develop
+    container_name: sonarr
+    security_opt:
+      - no-new-privileges:true
+    restart: "no"
+    profiles: ["media", "starr", "all"]
+    networks:
+      - default
+    ports:
+      - "$SONARR_PORT:8989"
+    volumes:
+      - $DOCKERDIR/appdata/sonarr:/config
+      # - $MEDIADIR1:/data/media1
+      # - $MEDIADIR2:/data/media2
+      # - $MEDIADIR3:/data/media3
+      - $DOWNLOADSDIR:/data/downloads 
+      - "/etc/localtime:/etc/localtime:ro"
+    environment:
+      TZ: $TZ
+      PUID: $PUID
+      PGID: $PGID
+    # DOCKER-LABELS-PLACEHOLDER