@simplehomelab/deployrr 6.0.0-rc3

package/apps/official/organizr/manifest.json

@@ -0,0 +1,78 @@
+{
+  "$schema": "../../../apps/manifest-schema.json",
+  "version": "1.2",
+
+  "app": {
+    "sname": "organizr",
+    "pname": "Organizr",
+    "description": "Organizr is a homelab dashboard that allows you to organize and access all your services in one place. It provides a unified interface for managing your homelab apps.",
+    "descriptionShort": "Homelab dashboard",
+    "icon": "sh-organizr",
+    "category": "official",
+    "menuNumber": "06",
+    "tags": ["dashboard", "web", "homelab", "organization"]
+  },
+
+  "deployment": {
+    "type": "single",
+    "compose": "compose.yml",
+    "profiles": ["apps", "all"],
+    "networks": ["default"],
+    "webui": true,
+    "port": 82,
+    "protocol": "http"
+  },
+
+  "requirements": {
+    "prerequisites": ["prerequisites"],
+    "apps": []
+  },
+
+  "postInstall": {
+    "messages": [
+      {
+        "type": "note",
+        "text": "First, go through the installation wizard at: http://$SERVER_LAN_IP:$ORGANIZR_PORT"
+      },
+      {
+        "type": "note",
+        "text": "Organizr will not be accessible via reverse proxy until the wizard is completed."
+      }
+    ]
+  },
+
+  "traefik": {
+    "supported": true
+  },
+
+  "dashboard": {
+    "enabled": true,
+    "location": "local",
+    "showStats": true,
+    "portVariable": "ORGANIZR_PORT"
+  },
+
+  "env": {
+    "variables": [
+      {
+        "name": "ORGANIZR_PORT",
+        "description": "Web interface port",
+        "type": "port",
+        "default": 82,
+        "prompt": true,
+        "required": true,
+        "validation": {
+          "type": "port",
+          "min": 1,
+          "max": 65535
+        }
+      }
+    ]
+  },
+
+  "status": {
+    "file": "06_organizr_status",
+    "successMessage": "Organizr Setup Completed",
+    "telemetryAction": "organizr"
+  }
+}

package/apps/official/overseerr/compose.yml

@@ -0,0 +1,20 @@
+services:
+  # Overseerr - Media Requests and Discovery for Plex
+  overseerr:
+    image: lscr.io/linuxserver/overseerr:latest
+    container_name: overseerr
+    security_opt:
+      - no-new-privileges:true
+    restart: unless-stopped
+    profiles: ["apps", "all"]
+    networks:
+      - default
+    ports:
+      - "$OVERSEERR_PORT:5055"
+    volumes:
+      - $DOCKERDIR/appdata/overseerr:/config
+    environment:
+      PUID: $PUID
+      PGID: $PGID
+      TZ: $TZ
+    # DOCKER-LABELS-PLACEHOLDER

package/apps/official/overseerr/manifest.json

@@ -0,0 +1,65 @@
+{
+  "$schema": "../../../apps/manifest-schema.json",
+  "version": "1.2",
+
+  "app": {
+    "sname": "overseerr",
+    "pname": "Overseerr",
+    "description": "Overseerr is a request management and media discovery tool for your Plex ecosystem. It integrates with Radarr and Sonarr to automatically fulfill user requests.",
+    "descriptionShort": "Media requests and discovery for Plex",
+    "icon": "sh-overseerr",
+    "category": "official",
+    "menuNumber": "06",
+    "tags": ["media", "requests", "plex"]
+  },
+
+  "deployment": {
+    "type": "single",
+    "compose": "compose.yml",
+    "profiles": ["apps", "all"],
+    "networks": ["default"],
+    "webui": true,
+    "port": 5055,
+    "protocol": "http"
+  },
+
+  "requirements": {
+    "prerequisites": ["prerequisites"],
+    "apps": []
+  },
+
+  "traefik": {
+    "supported": true
+  },
+
+  "dashboard": {
+    "enabled": true,
+    "location": "local",
+    "showStats": true,
+    "portVariable": "OVERSEERR_PORT"
+  },
+
+  "env": {
+    "variables": [
+      {
+        "name": "OVERSEERR_PORT",
+        "description": "Web interface port",
+        "type": "port",
+        "default": 5055,
+        "prompt": true,
+        "required": true,
+        "validation": {
+          "type": "port",
+          "min": 1,
+          "max": 65535
+        }
+      }
+    ]
+  },
+
+  "status": {
+    "file": "06_overseerr_status",
+    "successMessage": "Overseerr Setup Completed",
+    "telemetryAction": "overseerr"
+  }
+}

package/apps/official/paperless-ai/compose.yml

@@ -0,0 +1,16 @@
+services:
+ # Paperless AI - Doc Analyzer for Paperless-NGX
+  paperless-ai:
+    image: clusterzx/paperless-ai
+    container_name: paperless-ai
+    security_opt:
+      - no-new-privileges:true
+    restart: unless-stopped
+    profiles: ["apps", "all"]
+    networks:
+      - default
+    ports:
+      - "$PAPERLESSAI_PORT:3000"
+    volumes:
+      - $DOCKERDIR/appdata/paperless-ai:/app/data
+    # DOCKER-LABELS-PLACEHOLDER

package/apps/official/paperless-ai/manifest.json

@@ -0,0 +1,74 @@
+{
+  "$schema": "../../../apps/manifest-schema.json",
+  "version": "1.2",
+
+  "app": {
+    "sname": "paperless-ai",
+    "pname": "Paperless-AI",
+    "description": "Paperless-AI is a document analyzer that integrates with Paperless-NGX to automatically analyze and tag documents using AI. It enhances your document management workflow with intelligent classification.",
+    "descriptionShort": "Doc Analyzer for management system",
+    "icon": "sh-paperless-ai",
+    "category": "official",
+    "menuNumber": "06",
+    "tags": ["ai", "documents", "automation", "paperless"]
+  },
+
+  "deployment": {
+    "type": "single",
+    "compose": "compose.yml",
+    "profiles": ["apps", "all"],
+    "networks": ["default"],
+    "webui": true,
+    "port": 3001,
+    "protocol": "http"
+  },
+
+  "requirements": {
+    "prerequisites": ["prerequisites"],
+    "apps": []
+  },
+
+  "preInstall": {
+    "dialog": {
+      "type": "warning",
+      "title": "Paperless-AI Warning",
+      "message": "\\n\\Z1WARNING!\\Zn\\n\\nPaperless-AI makes changes to the documents in your production Paperless-NGX instance that cannot be easily undone. Do the configuration carefully and think twice. Please test the results beforehand in a separate development environment and be sure to back up your documents and metadata beforehand.\\n\\n\\Z4Source:\\Zn https://github.com/clusterzx/paperless-ai\\n\\nDo you wish to proceed with installing Paperless-AI?",
+      "cancelable": true
+    }
+  },
+
+  "traefik": {
+    "supported": true
+  },
+
+  "dashboard": {
+    "enabled": true,
+    "location": "local",
+    "showStats": true,
+    "portVariable": "PAPERLESSAI_PORT"
+  },
+
+  "env": {
+    "variables": [
+      {
+        "name": "PAPERLESSAI_PORT",
+        "description": "Web interface port",
+        "type": "port",
+        "default": 3001,
+        "prompt": true,
+        "required": true,
+        "validation": {
+          "type": "port",
+          "min": 1,
+          "max": 65535
+        }
+      }
+    ]
+  },
+
+  "status": {
+    "file": "06_paperlessai_status",
+    "successMessage": "Paperless-AI Setup Completed",
+    "telemetryAction": "paperlessai"
+  }
+}

package/apps/official/paperless-ngx/compose.yml

@@ -0,0 +1,51 @@
+services:
+  # Paperless-NGX - Document Management System
+  paperless-ngx:
+    image: ghcr.io/paperless-ngx/paperless-ngx:${PAPERLESSNGX_VERSION_PIN}
+    container_name: paperless-ngx
+    security_opt:
+      - no-new-privileges:true
+    restart: unless-stopped
+    profiles: ["apps", "all"]
+    depends_on:
+      paperless-ngx-mariadb:
+        condition: service_healthy
+      paperless-ngx-redis:
+        condition: service_healthy
+      gotenberg:
+        condition: service_started
+      tika:
+        condition: service_started
+    networks:
+      - default
+    ports:
+      - "$PAPERLESSNGX_PORT:8000"
+    healthcheck:
+      test: ["CMD", "curl", "-f", "http://localhost:8000"]
+      interval: 30s
+      timeout: 10s
+      retries: 5
+    volumes:
+      - $DOCKERDIR/appdata/paperless-ngx/data:/usr/src/paperless/data
+      - $DOCKERDIR/appdata/paperless-ngx/media:/usr/src/paperless/media
+      - $DOCKERDIR/appdata/paperless-ngx/export:/usr/src/paperless/export
+      - $DOCKERDIR/appdata/paperless-ngx/trash:/usr/src/paperless/trash
+      - $DOCKERDIR/appdata/paperless-ngx/consume:/usr/src/paperless/consume
+    environment:
+      - PAPERLESS_REDIS=redis://paperless-ngx-redis:6379
+      - PAPERLESS_DBENGINE=mariadb
+      - PAPERLESS_DBNAME=paperless
+      - PAPERLESS_DBHOST=paperless-ngx-mariadb
+      - PAPERLESS_DBUSER=paperlessngx_db_user
+      - PAPERLESS_DBPASS=$PAPERLESSNGX_MARIADB_PASSWORD
+      - PAPERLESS_DBPORT=3306
+      - PAPERLESS_SECRET_KEY=$PAPERLESSNGX_SECRET_KEY
+      - PAPERLESS_TIKA_ENABLED=1
+      - PAPERLESS_TIKA_GOTENBERG_ENDPOINT=http://gotenberg:3000
+      - PAPERLESS_TIKA_ENDPOINT=http://tika:9998
+      - PAPERLESS_FILENAME_FORMAT={{created_year}}/{{created_month}}/{{correspondent}}/{{title}} {{asn}}
+      - PAPERLESS_URL=https://$PAPERLESSNGX_SUBDOMAIN.$DOMAINNAME_1
+      - PAPERLESS_TRUSTED_PROXIES=$SERVER_LAN_IP
+      - PAPERLESS_ADMIN_USER=$PAPERLESSNGX_ADMIN_USER
+      - PAPERLESS_ADMIN_PASSWORD=$PAPERLESSNGX_ADMIN_PASSWORD
+    # DOCKER-LABELS-PLACEHOLDER

package/apps/official/paperless-ngx/gotenberg.yml

@@ -0,0 +1,18 @@
+services:
+  # Gotenberg - Document Conversion Server for Paperless-NGX
+  gotenberg:
+    image: docker.io/gotenberg/gotenberg:${GOTENBERG_VERSION_PIN}
+    container_name: gotenberg
+    security_opt:
+      - no-new-privileges:true
+    restart: unless-stopped
+    profiles: ["apps", "all"]
+    networks:
+      - default
+    # The gotenberg chromium route is used to convert .eml files. We do not
+    # want to allow external content like tracking pixels or even javascript.
+    command:
+      - "gotenberg"
+      - "--chromium-disable-javascript=true"
+      - "--chromium-allow-list=file:///tmp/.*"
+    # DOCKER-LABELS-PLACEHOLDER

package/apps/official/paperless-ngx/manifest.json

@@ -0,0 +1,179 @@
+{
+  "$schema": "../../../apps/manifest-schema.json",
+  "version": "1.2",
+
+  "app": {
+    "sname": "paperless-ngx",
+    "pname": "Paperless-NGX",
+    "description": "Paperless-NGX is a document management system that transforms your physical documents into a searchable online archive. It features OCR, automatic tagging, full-text search, and supports multiple file formats including PDF, images, and office documents.",
+    "descriptionShort": "Document management system",
+    "icon": "sh-paperless-ngx",
+    "category": "official",
+    "menuNumber": "06",
+    "tags": ["documents", "ocr", "archive", "paperless", "pdf"]
+  },
+
+  "deployment": {
+    "type": "multicontainer",
+    "compose": "compose.yml",
+    "profiles": ["apps", "all"],
+    "networks": ["default"],
+    "webui": true,
+    "port": 8000,
+    "protocol": "http"
+  },
+
+  "dependencies": [
+    {
+      "sname": "paperless-ngx-mariadb",
+      "pname": "Paperless-NGX MariaDB",
+      "compose": "paperless-ngx-mariadb.yml",
+      "installOrder": 1,
+      "waitForHealthy": true,
+      "required": true,
+      "description": "Dedicated MariaDB database for Paperless-NGX"
+    },
+    {
+      "sname": "paperless-ngx-redis",
+      "pname": "Paperless-NGX Redis",
+      "compose": "paperless-ngx-redis.yml",
+      "installOrder": 2,
+      "waitForHealthy": true,
+      "required": true,
+      "description": "Dedicated Redis cache for Paperless-NGX"
+    },
+    {
+      "sname": "gotenberg",
+      "pname": "Gotenberg",
+      "compose": "gotenberg.yml",
+      "installOrder": 3,
+      "waitForHealthy": false,
+      "required": true,
+      "description": "Document conversion server for Paperless-NGX"
+    },
+    {
+      "sname": "tika",
+      "pname": "Tika",
+      "compose": "tika.yml",
+      "installOrder": 4,
+      "waitForHealthy": false,
+      "required": true,
+      "description": "Document text extraction for Paperless-NGX"
+    }
+  ],
+
+  "requirements": {
+    "prerequisites": ["prerequisites"],
+    "apps": []
+  },
+
+  "database": {
+    "type": "mariadb",
+    "containerSname": "paperless-ngx-mariadb",
+    "name": "paperless",
+    "user": "paperlessngx_db_user",
+    "passwordVariable": "PAPERLESSNGX_MARIADB_PASSWORD",
+    "host": "paperless-ngx-mariadb",
+    "port": 3306
+  },
+
+  "traefik": {
+    "supported": true
+  },
+
+  "dashboard": {
+    "enabled": true,
+    "location": "local",
+    "showStats": true,
+    "portVariable": "PAPERLESSNGX_PORT"
+  },
+
+  "env": {
+    "variables": [
+      {
+        "name": "PAPERLESSNGX_PORT",
+        "description": "Web interface port",
+        "type": "port",
+        "default": 8000,
+        "prompt": true,
+        "required": true,
+        "validation": { "type": "port", "min": 1, "max": 65535 }
+      },
+      {
+        "name": "PAPERLESSNGX_SUBDOMAIN",
+        "description": "Subdomain for Paperless-NGX (used in PAPERLESS_URL)",
+        "type": "string",
+        "default": "paperless",
+        "prompt": true,
+        "required": true
+      },
+      {
+        "name": "PAPERLESSNGX_ADMIN_USER",
+        "description": "Paperless-NGX admin username",
+        "type": "string",
+        "default": "admin",
+        "prompt": true,
+        "required": true
+      },
+      {
+        "name": "PAPERLESSNGX_ADMIN_PASSWORD",
+        "description": "Paperless-NGX admin password",
+        "type": "password",
+        "generate": "random",
+        "length": 16,
+        "prompt": true,
+        "required": true
+      },
+      {
+        "name": "PAPERLESSNGX_SECRET_KEY",
+        "description": "Application secret key (auto-generated)",
+        "type": "string",
+        "generate": "random",
+        "length": 32,
+        "prompt": false,
+        "required": true
+      },
+      {
+        "name": "PAPERLESSNGX_MARIADB_ROOT_PASSWORD",
+        "description": "MariaDB root password (auto-generated)",
+        "type": "password",
+        "generate": "random",
+        "length": 32,
+        "prompt": false,
+        "required": true
+      },
+      {
+        "name": "PAPERLESSNGX_MARIADB_PASSWORD",
+        "description": "MariaDB database password (auto-generated)",
+        "type": "password",
+        "generate": "random",
+        "length": 32,
+        "prompt": false,
+        "required": true
+      }
+    ]
+  },
+
+  "postInstall": {
+    "messages": [
+      {
+        "type": "info",
+        "text": "Admin login: \\Z5$PAPERLESSNGX_ADMIN_USER\\Zn / \\Z5$PAPERLESSNGX_ADMIN_PASSWORD\\Zn"
+      },
+      {
+        "type": "note",
+        "text": "Paperless-NGX uses dedicated containers: \\Z5paperless-ngx-mariadb\\Zn, \\Z5paperless-ngx-redis\\Zn, \\Z5gotenberg\\Zn, and \\Z5tika\\Zn. Credentials are stored in \\Z4$DOCKER_FOLDER/.env\\Zn."
+      },
+      {
+        "type": "note",
+        "text": "Document consume folder: \\Z4$DOCKERDIR/appdata/paperless-ngx/consume\\Zn - drop files here for automatic import."
+      }
+    ]
+  },
+
+  "status": {
+    "file": "06_paperless-ngx_status",
+    "successMessage": "Paperless-NGX Setup Completed",
+    "telemetryAction": "paperless-ngx"
+  }
+}

package/apps/official/paperless-ngx/paperless-ngx-mariadb.yml

@@ -0,0 +1,26 @@
+services:
+  # Paperless-NGX MariaDB - Dedicated Database for Paperless-NGX
+  paperless-ngx-mariadb:
+    container_name: paperless-ngx-mariadb
+    image: mariadb:${PAPERLESSNGXMARIADB_VERSION_PIN}
+    security_opt:
+      - no-new-privileges:true
+    restart: unless-stopped
+    profiles: ["apps", "all"]
+    healthcheck:
+      test: ["CMD", "healthcheck.sh", "--connect", "--innodb_initialized"]
+      start_period: 1m
+      start_interval: 10s
+      interval: 1m
+      timeout: 5s
+      retries: 3
+    networks:
+      - default
+    volumes:
+      - $DOCKERDIR/appdata/paperless-ngx-mariadb:/var/lib/mysql
+    environment:
+      - MARIADB_ROOT_PASSWORD=$PAPERLESSNGX_MARIADB_ROOT_PASSWORD
+      - MARIADB_DATABASE=paperless
+      - MARIADB_USER=paperlessngx_db_user
+      - MARIADB_PASSWORD=$PAPERLESSNGX_MARIADB_PASSWORD
+    # DOCKER-LABELS-PLACEHOLDER

package/apps/official/paperless-ngx/paperless-ngx-redis.yml

@@ -0,0 +1,23 @@
+services:
+  # Paperless-NGX Redis - Dedicated Cache for Paperless-NGX
+  paperless-ngx-redis:
+    container_name: paperless-ngx-redis
+    image: redis:${PAPERLESSNGXREDIS_VERSION_PIN}
+    security_opt:
+      - no-new-privileges:true
+    restart: unless-stopped
+    profiles: ["apps", "all"]
+    command: redis-server --save "" --maxmemory 256mb --appendonly no --maxmemory-policy allkeys-lru
+    healthcheck:
+      test: ["CMD-SHELL", "redis-cli ping | grep PONG"]
+      start_period: 20s
+      interval: 30s
+      retries: 5
+      timeout: 3s
+    networks:
+      - default
+    deploy:
+      resources:
+        limits:
+          memory: 256MB
+    # DOCKER-LABELS-PLACEHOLDER

package/apps/official/paperless-ngx/tika.yml

@@ -0,0 +1,12 @@
+services:
+  # Tika - Document Text Extraction for Paperless-NGX
+  tika:
+    image: docker.io/apache/tika:${TIKA_VERSION_PIN}
+    container_name: tika
+    security_opt:
+      - no-new-privileges:true
+    restart: unless-stopped
+    profiles: ["apps", "all"]
+    networks:
+      - default
+    # DOCKER-LABELS-PLACEHOLDER

package/apps/official/pdfding/compose.yml

@@ -0,0 +1,32 @@
+services:
+  # PdfDing - Self-hosted PDF Management
+  pdfding:
+    container_name: pdfding
+    image: mrmn/pdfding:${PDFDING_VERSION_PIN}
+    security_opt:
+      - no-new-privileges:true
+    restart: unless-stopped
+    profiles: ["apps", "all"]
+    networks:
+      - default
+    depends_on:
+      pdfding-postgresql:
+        condition: service_healthy
+    ports:
+      - "$PDFDING_PORT:8000"
+    volumes:
+      - $DOCKERDIR/appdata/pdfding:/home/nonroot/pdfding/media
+    environment:
+      - DEFAULT_THEME=dark
+      - DEFAULT_THEME_COLOR=blue
+      - SECRET_KEY=$PDFDING_SECRET_KEY
+      - HOST_NAME=PDFDING_HOSTNAME_PLACEHOLDER
+      - DATABASE_TYPE=POSTGRES
+      - POSTGRES_PASSWORD=$PDFDING_POSTGRESQL_PASSWORD
+      - POSTGRES_HOST=pdfding-postgresql
+      - POSTGRES_PORT=5432
+      - POSTGRES_DB=pdfding
+      - POSTGRES_USER=pdfding_db_user
+      - CSRF_COOKIE_SECURE=TRUE
+      - SESSION_COOKIE_SECURE=TRUE
+    # DOCKER-LABELS-PLACEHOLDER

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

@@ -0,0 +1,55 @@
+#!/bin/bash
+# PdfDing Post-Install Hook
+# Modifies the compose file to set the correct HOST_NAME value
+#
+# HOST_NAME in compose.yml: ${SERVER_LAN_IP},PDFDING_HOSTNAME_PLACEHOLDER
+# - SERVER_LAN_IP is always included
+# - PDFDING_HOSTNAME_PLACEHOLDER is replaced with subdomain.domain ONLY if:
+#   1. Traefik is running with production status
+#   2. A file provider was created for this app
+
+APP_SNAME="pdfding"
+APP_PNAME="PdfDing"
+APP_COMPOSE_FILE="$DOCKER_FOLDER/compose/$HOSTNAME/$APP_SNAME.yml"
+FILE_PROVIDER_PATH="$DOCKER_FOLDER/appdata/traefik3/rules/$HOSTNAME/app-$APP_SNAME.yml"
+
+f_print_step "1/2" "Configuring $APP_PNAME hostname..."
+
+# Check if Traefik is running with production status and file provider exists
+TRAEFIK_RUNNING=$(sudo docker ps --filter "name=^traefik$" --filter "status=running" -q 2>/dev/null)
+TRAEFIK_PRODUCTION_STATUS="$DEPLOYRR_CONFIG/status/04_traefik_production_status"
+
+if [[ -n "$TRAEFIK_RUNNING" && -f "$TRAEFIK_PRODUCTION_STATUS" && -f "$FILE_PROVIDER_PATH" && -n "$FILE_PROVIDER_APP_SUBDOMAIN" && -n "$DOMAINNAME_1" ]]; then
+    # Traefik is running with file provider - add subdomain.domain
+    PDFDING_HOSTNAME="${FILE_PROVIDER_APP_SUBDOMAIN}.${DOMAINNAME_1}"
+    f_print_substep "Traefik file provider found: $FILE_PROVIDER_PATH"
+    f_print_substep "Adding hostname: $PDFDING_HOSTNAME"
+
+    if [[ -f "$APP_COMPOSE_FILE" ]]; then
+        sudo sed -i "s|PDFDING_HOSTNAME_PLACEHOLDER|$PDFDING_HOSTNAME|g" "$APP_COMPOSE_FILE"
+        f_print_substep "Updated HOST_NAME in: $APP_COMPOSE_FILE"
+        f_print_substep "HOST_NAME set to: \$SERVER_LAN_IP,$PDFDING_HOSTNAME"
+    else
+        f_print_warning "Compose file not found: $APP_COMPOSE_FILE"
+    fi
+else
+    # No Traefik/file provider - remove placeholder and comma
+    f_print_substep "No Traefik file provider configured"
+    f_print_substep "Using SERVER_LAN_IP only for HOST_NAME"
+
+    if [[ -f "$APP_COMPOSE_FILE" ]]; then
+        sudo sed -i "s|,PDFDING_HOSTNAME_PLACEHOLDER||g" "$APP_COMPOSE_FILE"
+        f_print_substep "Updated HOST_NAME in: $APP_COMPOSE_FILE"
+    else
+        f_print_warning "Compose file not found: $APP_COMPOSE_FILE"
+    fi
+fi
+echo
+
+# Stop and recreate the container to apply changes
+f_print_step "2/2" "Recreating $APP_PNAME container with updated configuration..."
+f_stop_containers "$APP_SNAME"
+sleep 2
+f_docker_compose_recreate "$APP_SNAME" "06"
+
+f_print_success "$APP_PNAME hostname configuration complete"