@simplehomelab/deployrr 6.0.0-rc3

package/apps/official/dashy/files/starter-conf.yml

@@ -0,0 +1,45 @@
+# Page meta info, like heading, footer text and nav links
+pageInfo:
+  title: Dashy
+  description: Welcome to your new dashboard!
+  navLinks:
+  - title: GitHub
+    path: https://github.com/Lissy93/dashy
+  - title: Documentation
+    path: https://dashy.to/docs
+
+# Optional app settings and configuration
+appConfig:
+  theme: colorful
+
+# Main content - An array of sections, each containing an array of items
+sections:
+- name: Getting Started
+  icon: fas fa-rocket
+  items:
+  - title: Dashy Live
+    description: Development a project management links for Dashy
+    icon: https://i.ibb.co/qWWpD0v/astro-dab-128.png
+    url: https://live.dashy.to/
+    target: newtab
+  - title: GitHub
+    description: Source Code, Issues and Pull Requests
+    url: https://github.com/lissy93/dashy
+    icon: favicon
+  - title: Docs
+    description: Configuring & Usage Documentation
+    provider: Dashy.to
+    icon: far fa-book
+    url: https://dashy.to/docs
+  - title: Showcase
+    description: See how others are using Dashy
+    url: https://github.com/Lissy93/dashy/blob/master/docs/showcase.md
+    icon: far fa-grin-hearts
+  - title: Config Guide
+    description: See full list of configuration options
+    url: https://github.com/Lissy93/dashy/blob/master/docs/configuring.md
+    icon: fas fa-wrench
+  - title: Support
+    description: Get help with Dashy, raise a bug, or get in contact
+    url: https://github.com/Lissy93/dashy/blob/master/.github/SUPPORT.md
+    icon: far fa-hands-helping

package/apps/official/dashy/manifest.json

@@ -0,0 +1,72 @@
+{
+  "$schema": "../../../apps/manifest-schema.json",
+  "version": "1.2",
+
+  "app": {
+    "sname": "dashy",
+    "pname": "Dashy",
+    "description": "Dashy is a self-hostable personal dashboard with widgets, status checking, and a built-in editor. It provides a central place to monitor and access your homelab services.",
+    "descriptionShort": "Homelab dashboard",
+    "icon": "sh-dashy",
+    "category": "official",
+    "menuNumber": "06",
+    "tags": ["dashboard", "monitoring", "widgets"]
+  },
+
+  "deployment": {
+    "type": "single",
+    "compose": "compose.yml",
+    "profiles": ["apps", "all"],
+    "networks": ["default"],
+    "webui": true,
+    "port": 8081,
+    "protocol": "http"
+  },
+
+  "requirements": {
+    "prerequisites": ["prerequisites"],
+    "apps": ["socket-proxy"]
+  },
+
+  "files": [
+    {
+      "source": "files/starter-conf.yml",
+      "dest": "$DOCKER_FOLDER/appdata/dashy/conf.yml"
+    }
+  ],
+
+  "traefik": {
+    "supported": true
+  },
+
+  "dashboard": {
+    "enabled": true,
+    "location": "local",
+    "showStats": true,
+    "portVariable": "DASHY_PORT"
+  },
+
+  "env": {
+    "variables": [
+      {
+        "name": "DASHY_PORT",
+        "description": "Web interface port",
+        "type": "port",
+        "default": 8081,
+        "prompt": true,
+        "required": true,
+        "validation": {
+          "type": "port",
+          "min": 1,
+          "max": 65535
+        }
+      }
+    ]
+  },
+
+  "status": {
+    "file": "06_dashy_status",
+    "successMessage": "Dashy Setup Completed",
+    "telemetryAction": "dashy"
+  }
+}

package/apps/official/ddns-updater/compose.yml

@@ -0,0 +1,28 @@
+services:
+  # Cloudflare DDNS - Dynamic DNS Updater
+  ddns-updater:
+    image: qmcgaw/ddns-updater
+    container_name: ddns-updater
+    security_opt:
+      - no-new-privileges:true
+    restart: unless-stopped
+    profiles: ["core", "all"]
+    networks:
+      - default
+    ports:
+      - "$DDNSUPDATER_PORT:8000"
+    volumes:
+      - $DOCKERDIR/appdata/ddns-updater:/updater/data
+    environment:
+      TZ: $TZ
+      PUID: $PUID
+      PGID: $PGID
+      PERIOD: 12h
+      UPDATE_COOLDOWN_PERIOD: 5m
+      PUBLICIP_DNS_TIMEOUT: 3s
+      HTTP_TIMEOUT: 10s
+      LISTENING_PORT: 8000
+      BACKUP_PERIOD: 96h
+      BACKUP_DIRECTORY: /updater/data/backups
+      LOG_LEVEL: info
+    # DOCKER-LABELS-PLACEHOLDER

package/apps/official/ddns-updater/files/config.json

@@ -0,0 +1,14 @@
+{
+    "settings": [
+        {
+            "provider": "cloudflare",
+            "zone_identifier": "CLOUDFLARE-ZONE-IDENTIFIER-PLACEHOLDER",
+            "domain": "CLOUDFLARE-DOMAIN-PLACEHOLDER",
+            "proxied": true,
+            "host": "@",
+            "ttl": 600,
+            "token": "CLOUDFLARE-API-TOKEN-PLACEHOLDER",
+            "ip_version": "ipv4"
+        }
+    ]
+}

package/apps/official/ddns-updater/files/pre-install.sh

@@ -0,0 +1,18 @@
+#!/bin/bash
+# Pre-install script for DDNS-Updater
+# Copies config.json and replaces placeholders with actual values from secrets
+
+APP_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
+
+mkdir -p "$DOCKER_FOLDER/appdata/ddns-updater/backups"
+
+# Copy config template
+sudo cp "$APP_DIR/files/config.json" "$DOCKER_FOLDER/appdata/ddns-updater/config.json"
+
+# Replace placeholders with actual values
+CF_ZONE_ID=$(sudo cat "$DOCKER_FOLDER/secrets/cf_zone_identifier")
+CF_API_TOKEN=$(sudo cat "$DOCKER_FOLDER/secrets/cf_dns_api_token")
+
+sudo sed -i "s|CLOUDFLARE-ZONE-IDENTIFIER-PLACEHOLDER|${CF_ZONE_ID}|g" "$DOCKER_FOLDER/appdata/ddns-updater/config.json"
+sudo sed -i "s|CLOUDFLARE-DOMAIN-PLACEHOLDER|${DOMAINNAME_1}|g" "$DOCKER_FOLDER/appdata/ddns-updater/config.json"
+sudo sed -i "s|CLOUDFLARE-API-TOKEN-PLACEHOLDER|${CF_API_TOKEN}|g" "$DOCKER_FOLDER/appdata/ddns-updater/config.json"

package/apps/official/ddns-updater/manifest.json

@@ -0,0 +1,71 @@
+{
+  "$schema": "../../../apps/manifest-schema.json",
+  "version": "1.2",
+
+  "app": {
+    "sname": "ddns-updater",
+    "pname": "DDNS Updater",
+    "description": "DDNS Updater automatically updates DNS records for dynamic IP addresses, supporting multiple providers including Cloudflare.",
+    "descriptionShort": "Dynamic DNS updater",
+    "icon": "sh-ddns-updater",
+    "category": "official",
+    "menuNumber": "06",
+    "tags": ["dns", "networking", "cloudflare"]
+  },
+
+  "deployment": {
+    "type": "single",
+    "compose": "compose.yml",
+    "profiles": ["core", "all"],
+    "networks": ["default"],
+    "webui": true,
+    "port": 8000,
+    "protocol": "http"
+  },
+
+  "requirements": {
+    "prerequisites": ["prerequisites"],
+    "apps": []
+  },
+
+  "env": {
+    "variables": [
+      {
+        "name": "DDNSUPDATER_PORT",
+        "description": "Web interface port",
+        "type": "port",
+        "default": 8000,
+        "prompt": true,
+        "required": true,
+        "validation": { "type": "port", "min": 1, "max": 65535 }
+      }
+    ],
+    "secrets": [
+      {
+        "name": "cf_zone_identifier",
+        "description": "Cloudflare Domain Zone ID (get it from the Cloudflare Domain Overview tab)",
+        "type": "prompt",
+        "addToCompose": false
+      }
+    ]
+  },
+
+  "hooks": {
+    "preInstall": "files/pre-install.sh"
+  },
+
+  "traefik": { "supported": true },
+
+  "dashboard": {
+    "enabled": true,
+    "location": "local",
+    "showStats": true,
+    "portVariable": "DDNSUPDATER_PORT"
+  },
+
+  "status": {
+    "file": "06_ddns-updater_status",
+    "successMessage": "DDNS Updater Setup Completed",
+    "telemetryAction": "ddns-updater"
+  }
+}

package/apps/official/deunhealth/compose.yml

@@ -0,0 +1,17 @@
+services:
+  # DeUnhealth - Restart your unhealthy containers safely (e.g. containers depending on VPN and VPN reconnects)
+  deunhealth:
+    image: qmcgaw/deunhealth
+    container_name: deunhealth
+    security_opt:
+      - no-new-privileges:true
+    restart: unless-stopped
+    profiles: ["apps", "all"]
+    networks:
+      - socket_proxy
+    environment:
+      - LOG_LEVEL=info
+      - HEALTH_SERVER_ADDRESS=127.0.0.1:9999
+      - TZ=$TZ
+      - DOCKER_HOST
+    # DOCKER-LABELS-PLACEHOLDER

package/apps/official/deunhealth/manifest.json

@@ -0,0 +1,46 @@
+{
+  "$schema": "../../../apps/manifest-schema.json",
+  "version": "1.2",
+
+  "app": {
+    "sname": "deunhealth",
+    "pname": "DeUnhealth",
+    "description": "DeUnhealth monitors Docker containers and automatically restarts unhealthy ones. Useful for containers depending on VPN connections that may reconnect.",
+    "descriptionShort": "Restart unhealthy containers",
+    "icon": "sh-docker",
+    "category": "official",
+    "menuNumber": "06",
+    "tags": ["docker", "monitoring", "automation", "health"]
+  },
+
+  "deployment": {
+    "type": "single",
+    "compose": "compose.yml",
+    "profiles": ["apps", "all"],
+    "networks": ["socket_proxy"],
+    "webui": false
+  },
+
+  "requirements": {
+    "prerequisites": ["prerequisites"],
+    "apps": ["socket-proxy"]
+  },
+
+  "traefik": {
+    "supported": false
+  },
+
+  "dashboard": {
+    "enabled": false
+  },
+
+  "env": {
+    "variables": []
+  },
+
+  "status": {
+    "file": "06_deunhealth_status",
+    "successMessage": "DeUnhealth Setup Completed",
+    "telemetryAction": "deunhealth"
+  }
+}

package/apps/official/digikam/compose.yml

@@ -0,0 +1,23 @@
+services:
+  # Digikam - Photo Management
+  digikam:
+    image: ghcr.io/linuxserver/digikam
+    container_name: digikam
+    security_opt:
+      - no-new-privileges:true
+    restart: "unless-stopped"
+    profiles: ["apps", "all"]
+    # DEVICES-GPU-PLACEHOLDER-DO-NOT-DELETE
+    networks:
+      - default
+    ports:
+      - "$DIGIKAM_PORT:3000" # HTTP
+      # - 3001:3001 # HTTPS
+    volumes:
+      - $DOCKERDIR/appdata/digikam:/config
+      - $PHOTOSDIR:/data/photos
+    environment:
+      TZ: $TZ
+      PUID: $PUID
+      PGID: $PGID
+    # DOCKER-LABELS-PLACEHOLDER

package/apps/official/digikam/manifest.json

@@ -0,0 +1,85 @@
+{
+  "$schema": "../../../apps/manifest-schema.json",
+  "version": "1.2",
+  "app": {
+    "sname": "digikam",
+    "pname": "DigiKam",
+    "description": "DigiKam is an advanced open-source digital photo management application. It provides comprehensive tools for organizing, editing, and sharing photos.",
+    "descriptionShort": "Open-source photo manager",
+    "icon": "sh-digikam",
+    "category": "official",
+    "menuNumber": "06",
+    "tags": [
+      "photos",
+      "images",
+      "media",
+      "management"
+    ]
+  },
+  "deployment": {
+    "type": "single",
+    "compose": "compose.yml",
+    "profiles": [
+      "apps",
+      "all"
+    ],
+    "networks": [
+      "default"
+    ],
+    "webui": true,
+    "port": 3005,
+    "protocol": "http"
+  },
+  "requirements": {
+    "prerequisites": [
+      "prerequisites",
+      "photos_folder",
+      "add_gpu",
+      "appfolder_permission"
+    ],
+    "apps": []
+  },
+  "gpu": {
+    "required": false,
+    "usage": "Hardware-accelerated rendering",
+    "vendors": {
+      "intel": {
+        "pattern": "dri"
+      },
+      "amd": {
+        "pattern": "dri"
+      }
+    }
+  },
+  "traefik": {
+    "supported": true
+  },
+  "dashboard": {
+    "enabled": true,
+    "location": "local",
+    "showStats": true,
+    "portVariable": "DIGIKAM_PORT"
+  },
+  "env": {
+    "variables": [
+      {
+        "name": "DIGIKAM_PORT",
+        "description": "Web interface port",
+        "type": "port",
+        "default": 3005,
+        "prompt": true,
+        "required": true,
+        "validation": {
+          "type": "port",
+          "min": 1,
+          "max": 65535
+        }
+      }
+    ]
+  },
+  "status": {
+    "file": "06_digikam_status",
+    "successMessage": "DigiKam Setup Completed",
+    "telemetryAction": "digikam"
+  }
+}

package/apps/official/dispatcharr/compose.yml

@@ -0,0 +1,39 @@
+services:
+  # Dispatcharr - IPTV and Stream Companion
+  dispatcharr:
+    image: ghcr.io/dispatcharr/dispatcharr:latest
+    container_name: dispatcharr
+    security_opt:
+      - no-new-privileges:true
+    restart: "no"
+    profiles: ["media", "all"]
+    networks:
+      - default
+    # DEVICES-GPU-PLACEHOLDER-DO-NOT-DELETE
+    # Uncomment the following lines for NVIDIA GPU support
+    # NVidia GPU support (requires NVIDIA Container Toolkit)
+    #deploy:
+    #  resources:
+    #      reservations:
+    #          devices:
+    #              - driver: nvidia
+    #                count: all
+    #                capabilities: [gpu]
+    ports:
+      - "$DISPATCHARR_PORT:9191"
+    # Uncomment to enable high priority for streaming (required if UWSGI_NICE_LEVEL < 0)
+    #cap_add:
+    #  - SYS_NICE
+    environment:
+      - DISPATCHARR_ENV=aio
+      - REDIS_HOST=localhost
+      - CELERY_BROKER_URL=redis://localhost:6379/0
+      - DISPATCHARR_LOG_LEVEL=info
+      # Process Priority Configuration (Optional)
+      # Lower values = higher priority. Range: -20 (highest) to 19 (lowest)
+      # Negative values require cap_add: SYS_NICE (uncomment below)
+      #- UWSGI_NICE_LEVEL=-5   # uWSGI/FFmpeg/Streaming (default: 0, recommended: -5 for high priority)
+      #- CELERY_NICE_LEVEL=5   # Celery/EPG/Background tasks (default: 5, low priority)
+    volumes:
+      - $DOCKERDIR/appdata/dispatcharr:/data
+    # DOCKER-LABELS-PLACEHOLDER

package/apps/official/dispatcharr/manifest.json

@@ -0,0 +1,86 @@
+{
+  "$schema": "../../../apps/manifest-schema.json",
+  "version": "1.2",
+  "app": {
+    "sname": "dispatcharr",
+    "pname": "Dispatcharr",
+    "description": "Dispatcharr is an IPTV and stream companion that provides live TV streaming capabilities with EPG support and hardware acceleration.",
+    "descriptionShort": "IPTV and stream companion",
+    "icon": "sh-dispatcharr",
+    "category": "official",
+    "menuNumber": "06",
+    "tags": [
+      "media",
+      "iptv",
+      "streaming",
+      "tv"
+    ]
+  },
+  "deployment": {
+    "type": "single",
+    "compose": "compose.yml",
+    "profiles": [
+      "media",
+      "all"
+    ],
+    "networks": [
+      "default"
+    ],
+    "webui": true,
+    "port": 9191,
+    "protocol": "http"
+  },
+  "requirements": {
+    "prerequisites": [
+      "prerequisites",
+      "add_gpu"
+    ],
+    "apps": []
+  },
+  "gpu": {
+    "required": false,
+    "usage": "Hardware-accelerated transcoding",
+    "vendors": {
+      "intel": {
+        "pattern": "dri"
+      },
+      "amd": {
+        "pattern": "dri"
+      },
+      "nvidia": {
+        "pattern": "deploy"
+      }
+    }
+  },
+  "traefik": {
+    "supported": true
+  },
+  "dashboard": {
+    "enabled": true,
+    "location": "local",
+    "showStats": true,
+    "portVariable": "DISPATCHARR_PORT"
+  },
+  "env": {
+    "variables": [
+      {
+        "name": "DISPATCHARR_PORT",
+        "description": "Web interface port",
+        "type": "port",
+        "default": 9191,
+        "prompt": true,
+        "required": true,
+        "validation": {
+          "type": "port",
+          "min": 1,
+          "max": 65535
+        }
+      }
+    ]
+  },
+  "status": {
+    "file": "06_dispatcharr_status",
+    "successMessage": "Dispatcharr Setup Completed",
+    "telemetryAction": "dispatcharr"
+  }
+}

package/apps/official/docker-gc/compose.yml

@@ -0,0 +1,25 @@
+services:
+  # Docker-GC - Automatic Docker Garbage Collection
+  # Create docker-gc-exclude file
+  docker-gc:
+    image: clockworksoul/docker-gc-cron:latest
+    container_name: docker-gc
+    security_opt:
+      - no-new-privileges:true
+    restart: unless-stopped
+    profiles: ["apps", "all"]
+    networks:
+      - socket_proxy
+    volumes:
+      # - /var/run/docker.sock:/var/run/docker.sock # Use Docker Socket Proxy instead for improved security
+      - $DOCKERDIR/appdata/docker-gc/docker-gc-exclude:/etc/docker-gc-exclude
+    environment:
+      - CRON=0 0 0 * * ? # Everyday at midnight. Previously 0 0 * * *
+      - FORCE_IMAGE_REMOVAL=1
+      - FORCE_CONTAINER_REMOVAL=0
+      - GRACE_PERIOD_SECONDS=604800
+      - DRY_RUN=0
+      - CLEAN_UP_VOLUMES=1
+      - TZ=$TZ
+      - DOCKER_HOST
+    # DOCKER-LABELS-PLACEHOLDER

package/apps/official/docker-gc/files/docker-gc-exclude

@@ -0,0 +1,9 @@
+# If there is a dependent image it seems that the docker-gc can only identify them
+# using the image id
+# If you pull them specifically it will use the tag otherwise it uses the imageid
+#
+# The file consists of the name of the image followed by the image id (can be either the short version or the long version)
+#
+####################################################################################################
+
+clockworksoul/docker-gc-cron:latest

package/apps/official/docker-gc/files/pre-install.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+# Docker-GC pre-install hook
+# Creates docker-gc-exclude file before container starts to prevent Docker from creating a directory
+
+# Get the directory where this script is located (app/files/)
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+SOURCE_FILE="$SCRIPT_DIR/docker-gc-exclude"
+
+# Create parent directory if it doesn't exist
+sudo mkdir -p "$DOCKER_FOLDER/appdata/docker-gc"
+
+# Copy docker-gc-exclude file to destination
+# This must happen BEFORE the container starts, otherwise Docker creates a directory at this path
+if [[ -f "$SOURCE_FILE" ]]; then
+    sudo cp "$SOURCE_FILE" "$DOCKER_FOLDER/appdata/docker-gc/docker-gc-exclude"
+    sudo chown "$USERNAME:$USERNAME" "$DOCKER_FOLDER/appdata/docker-gc/docker-gc-exclude"
+    sudo chmod 644 "$DOCKER_FOLDER/appdata/docker-gc/docker-gc-exclude"
+    dev_echo "Created docker-gc-exclude file at $DOCKER_FOLDER/appdata/docker-gc/docker-gc-exclude"
+else
+    dev_echo "ERROR: Source file not found: $SOURCE_FILE"
+    return 1
+fi

package/apps/official/docker-gc/manifest.json

@@ -0,0 +1,54 @@
+{
+  "$schema": "../../../apps/manifest-schema.json",
+  "version": "1.2",
+
+  "app": {
+    "sname": "docker-gc",
+    "pname": "Docker Garbage Collection",
+    "description": "Docker GC automatically cleans up unused Docker images, containers, and volumes on a scheduled basis. It helps keep your Docker host clean and reclaim disk space.",
+    "descriptionShort": "Docker garbage collection",
+    "icon": "sh-docker",
+    "category": "official",
+    "menuNumber": "06",
+    "tags": ["docker", "cleanup", "maintenance"]
+  },
+
+  "deployment": {
+    "type": "single",
+    "compose": "compose.yml",
+    "profiles": ["apps", "all"],
+    "networks": ["socket_proxy"],
+    "webui": false,
+    "port": 0,
+    "protocol": "http"
+  },
+
+  "requirements": {
+    "prerequisites": ["prerequisites"],
+    "apps": ["socket-proxy"]
+  },
+
+  "hooks": {
+    "preInstall": "files/pre-install.sh"
+  },
+
+  "traefik": {
+    "supported": false
+  },
+
+  "dashboard": {
+    "enabled": true,
+    "location": "other",
+    "showStats": true
+  },
+
+  "env": {
+    "variables": []
+  },
+
+  "status": {
+    "file": "06_dockergc_status",
+    "successMessage": "Docker Garbage Collection Setup Completed",
+    "telemetryAction": "docker-gc"
+  }
+}