@simplehomelab/deployrr 6.0.0-rc3

package/apps/official/pdfding/manifest.json

@@ -0,0 +1,120 @@
+{
+  "$schema": "../../../apps/manifest-schema.json",
+  "version": "1.2",
+
+  "app": {
+    "sname": "pdfding",
+    "pname": "PdfDing",
+    "description": "PdfDing is a self-hosted PDF management application that allows you to organize, view, and edit PDF documents. Features include dark mode, annotations, and a clean web interface.",
+    "descriptionShort": "Self-hosted PDF management",
+    "icon": "sh-pdfding",
+    "category": "official",
+    "menuNumber": "06",
+    "tags": ["pdf", "documents", "management", "viewer"]
+  },
+
+  "deployment": {
+    "type": "multicontainer",
+    "compose": "compose.yml",
+    "profiles": ["apps", "all"],
+    "networks": ["default"],
+    "webui": true,
+    "port": 8000,
+    "protocol": "http"
+  },
+
+  "dependencies": [
+    {
+      "sname": "pdfding-postgresql",
+      "pname": "PdfDing PostgreSQL",
+      "compose": "pdfding-postgresql.yml",
+      "installOrder": 1,
+      "waitForHealthy": true,
+      "required": true,
+      "description": "Dedicated PostgreSQL database for PdfDing"
+    }
+  ],
+
+  "requirements": {
+    "prerequisites": ["prerequisites"],
+    "apps": []
+  },
+
+  "folders": {
+    "permissions": {
+      "appdata": "1000:1000"
+    }
+  },
+
+  "database": {
+    "type": "postgresql",
+    "containerSname": "pdfding-postgresql",
+    "name": "pdfding",
+    "user": "pdfding_db_user",
+    "passwordVariable": "PDFDING_POSTGRESQL_PASSWORD",
+    "host": "pdfding-postgresql",
+    "port": 5432
+  },
+
+  "traefik": {
+    "supported": true
+  },
+
+  "dashboard": {
+    "enabled": true,
+    "location": "local",
+    "showStats": true,
+    "portVariable": "PDFDING_PORT"
+  },
+
+  "env": {
+    "variables": [
+      {
+        "name": "PDFDING_PORT",
+        "description": "Web interface port",
+        "type": "port",
+        "default": 8000,
+        "prompt": true,
+        "required": true,
+        "validation": { "type": "port", "min": 1, "max": 65535 }
+      },
+      {
+        "name": "PDFDING_SECRET_KEY",
+        "description": "Django secret key (auto-generated)",
+        "type": "password",
+        "generate": "random",
+        "length": 50,
+        "prompt": false,
+        "required": true
+      },
+      {
+        "name": "PDFDING_POSTGRESQL_PASSWORD",
+        "description": "PostgreSQL database password (auto-generated)",
+        "type": "password",
+        "generate": "random",
+        "length": 32,
+        "prompt": false,
+        "required": true
+      }
+    ]
+  },
+
+  "hooks": {
+    "postInstall": "files/post-install.sh"
+  },
+
+  "postInstall": {
+    "messages": [
+      {
+        "type": "note",
+        "text": "PdfDing uses a dedicated PostgreSQL database (\\Z5pdfding-postgresql\\Zn). Credentials are stored in \\Z4$DOCKER_FOLDER/.env\\Zn."
+      }
+    ]
+  },
+
+  "status": {
+    "file": "06_pdfding_status",
+    "successMessage": "PdfDing Setup Completed",
+    "telemetryAction": "pdfding"
+  }
+}

package/apps/official/pdfding/pdfding-postgresql.yml

@@ -0,0 +1,24 @@
+services:
+  # PdfDing PostgreSQL - Dedicated Database for PdfDing
+  pdfding-postgresql:
+    container_name: pdfding-postgresql
+    image: postgres:${PDFDINGPOSTGRESQL_VERSION_PIN}
+    security_opt:
+      - no-new-privileges:true
+    restart: unless-stopped
+    profiles: ["apps", "all"]
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -d pdfding -U pdfding_db_user"]
+      start_period: 20s
+      interval: 30s
+      retries: 5
+      timeout: 5s
+    networks:
+      - default
+    volumes:
+      - $DOCKERDIR/appdata/pdfding-postgresql:/var/lib/postgresql
+    environment:
+      - POSTGRES_DB=pdfding
+      - POSTGRES_USER=pdfding_db_user
+      - POSTGRES_PASSWORD=$PDFDING_POSTGRESQL_PASSWORD
+    # DOCKER-LABELS-PLACEHOLDER

package/apps/official/pgadmin/compose.yml

@@ -0,0 +1,17 @@
+services:
+  # pgAdmin - PostgreSQL Administration
+  pgadmin:
+    image: dpage/pgadmin4
+    container_name: pgadmin
+    restart: unless-stopped
+    profiles: ["apps", "all"]
+    networks:
+      - default
+    ports:
+      - "$PGADMIN_PORT:80"
+    volumes:
+      - $DOCKERDIR/appdata/pgadmin:/var/lib/pgadmin
+    environment:
+      PGADMIN_DEFAULT_EMAIL: $PGADMIN_ADMIN_EMAIL
+      PGADMIN_DEFAULT_PASSWORD: $PGADMIN_ADMIN_PASSWORD
+    # DOCKER-LABELS-PLACEHOLDER

package/apps/official/pgadmin/manifest.json

@@ -0,0 +1,80 @@
+{
+  "$schema": "../../../apps/manifest-schema.json",
+  "version": "1.2",
+
+  "app": {
+    "sname": "pgadmin",
+    "pname": "pgAdmin",
+    "description": "pgAdmin is the most popular and feature-rich open source administration and development platform for PostgreSQL.",
+    "descriptionShort": "PostgreSQL admin",
+    "icon": "sh-pgadmin",
+    "category": "official",
+    "menuNumber": "06",
+    "tags": ["database", "admin", "web", "postgresql"]
+  },
+
+  "deployment": {
+    "type": "single",
+    "compose": "compose.yml",
+    "profiles": ["apps", "all"],
+    "networks": ["default"],
+    "webui": true,
+    "port": 8081,
+    "protocol": "http"
+  },
+
+  "requirements": {
+    "prerequisites": ["prerequisites"],
+    "apps": []
+  },
+
+  "traefik": { "supported": true },
+
+  "dashboard": {
+    "enabled": true,
+    "location": "local",
+    "showStats": true,
+    "portVariable": "PGADMIN_PORT"
+  },
+
+  "env": {
+    "variables": [
+      {
+        "name": "PGADMIN_ADMIN_EMAIL",
+        "description": "pgAdmin Admin Email",
+        "type": "string",
+        "default": "admin@example.com",
+        "prompt": true,
+        "required": true
+      },
+      {
+        "name": "PGADMIN_ADMIN_PASSWORD",
+        "description": "pgAdmin Admin Password",
+        "type": "password",
+        "prompt": true,
+        "required": true
+      },
+      {
+        "name": "PGADMIN_PORT",
+        "description": "Web interface port",
+        "type": "port",
+        "default": 8081,
+        "prompt": true,
+        "required": true,
+        "validation": { "type": "port", "min": 1, "max": 65535 }
+      }
+    ]
+  },
+
+  "folders": {
+    "permissions": {
+      "appdata": "5050:5050"
+    }
+  },
+
+  "status": {
+    "file": "06_pgadmin_status",
+    "successMessage": "pgAdmin Setup Completed",
+    "telemetryAction": "pgadmin"
+  }
+}

package/apps/official/phpmyadmin/compose.yml

@@ -0,0 +1,22 @@
+services:
+  # phpMyAdmin - Database management
+  # Create a new user with admin privileges. Cannot login as MySQL root for some reason.
+  phpmyadmin:
+    image: phpmyadmin/phpmyadmin:latest
+    container_name: phpmyadmin
+    security_opt:
+      - no-new-privileges:true
+    restart: unless-stopped
+    profiles: ["apps", "all"]
+    networks:
+      - default
+    ports:
+      - "$PHPMYADMIN_PORT:80" 
+    environment:
+      - PMA_HOST=mariadb
+      - PMA_PORT=3306
+      #- PMA_ARBITRARY=1
+      - MYSQL_ROOT_PASSWORD_FILE=/run/secrets/mariadb_root_password
+    secrets:
+      - mariadb_root_password
+    # DOCKER-LABELS-PLACEHOLDER

package/apps/official/phpmyadmin/manifest.json

@@ -0,0 +1,65 @@
+{
+  "$schema": "../../../apps/manifest-schema.json",
+  "version": "1.2",
+
+  "app": {
+    "sname": "phpmyadmin",
+    "pname": "phpMyAdmin",
+    "description": "phpMyAdmin is a free software tool written in PHP intended to handle the administration of MySQL or MariaDB databases over the Web.",
+    "descriptionShort": "Web UI for MariaDB/MySQL",
+    "icon": "sh-phpmyadmin",
+    "category": "official",
+    "menuNumber": "06",
+    "tags": ["database", "admin", "mysql", "mariadb"]
+  },
+
+  "deployment": {
+    "type": "single",
+    "compose": "compose.yml",
+    "profiles": ["apps", "all"],
+    "networks": ["default"],
+    "webui": true,
+    "port": 8081,
+    "protocol": "http"
+  },
+
+  "requirements": {
+    "prerequisites": ["prerequisites"],
+    "apps": []
+  },
+
+  "traefik": {
+    "supported": true
+  },
+
+  "dashboard": {
+    "enabled": true,
+    "location": "local",
+    "showStats": true,
+    "portVariable": "PHPMYADMIN_PORT"
+  },
+
+  "env": {
+    "variables": [
+      {
+        "name": "PHPMYADMIN_PORT",
+        "description": "Web interface port",
+        "type": "port",
+        "default": 8081,
+        "prompt": true,
+        "required": true,
+        "validation": {
+          "type": "port",
+          "min": 1,
+          "max": 65535
+        }
+      }
+    ]
+  },
+
+  "status": {
+    "file": "06_phpmyadmin_status",
+    "successMessage": "phpMyAdmin Setup Completed",
+    "telemetryAction": "phpmyadmin"
+  }
+}

package/apps/official/pihole/compose.yml

@@ -0,0 +1,41 @@
+services:
+  # Pi-hole - DNS Server and AdBlocker
+  pihole:
+    image: pihole/pihole:latest
+    container_name: pihole
+    security_opt:
+      - no-new-privileges:true
+    restart: unless-stopped
+    profiles: ["all", "core"]
+    networks:
+      - default
+    # cap_add:
+    #   # See https://github.com/pi-hole/docker-pi-hole#note-on-capabilities
+    #   # Required if you are using Pi-hole as your DHCP server, else not needed
+    #   - NET_ADMIN
+    #   # Required if you are using Pi-hole as your NTP client to be able to set the host's system time
+    #   - SYS_TIME
+    #   # Optional, if Pi-hole should get some more processing time
+    #   - SYS_NICE
+    ports:
+      - "53:53/tcp"
+      - "53:53/udp"
+      - "67:67/udp" # DHCP Server
+      - "$PIHOLE_PORT:80/tcp" # HTTP
+      # - "123:123/udp" # NTP
+      # - "443:443" # HTTPS
+    volumes:
+      - "$DOCKERDIR/appdata/pihole/etc:/etc/pihole"
+      # - "$DOCKERDIR/appdata/pihole/etc/dnsmasq.d:/etc/dnsmasq.d"
+      - "$DOCKERDIR/appdata/pihole/log:/var/log/pihole"
+    environment:
+      # https://docs.pi-hole.net/docker/upgrading/v5-v6/?h=pihole_dns#misc Variables list for v6
+      TZ: ${TZ}
+      FTLCONF_webserver_api_password: ${PIHOLE_WEB_PASSWORD}
+      FTLCONF_dns_listeningMode: 'all'
+      FTLCONF_dns_upstreams: 1.1.1.1;1.0.0.1
+      FTLCONF_dns_bogusPriv: "true"
+      FTLCONF_dns_domainNeeded: "true"
+      FTLCONF_dns_domain: ${PIHOLE_LOCAL_DOMAIN}
+      FTLCONF_webserver_interface_theme: "default_dark"
+    # DOCKER-LABELS-PLACEHOLDER

package/apps/official/pihole/manifest.json

@@ -0,0 +1,89 @@
+{
+  "$schema": "../../../apps/manifest-schema.json",
+  "version": "1.2",
+
+  "app": {
+    "sname": "pihole",
+    "pname": "Pi-hole",
+    "description": "Pi-hole is a network-level advertisement and internet tracker blocking application. It acts as a DNS sinkhole, protecting devices from unwanted content without installing any client-side software.",
+    "descriptionShort": "DNS Server and AdBlocker",
+    "icon": "sh-pi-hole",
+    "category": "official",
+    "menuNumber": "06",
+    "tags": ["dns", "adblock", "networking", "security"]
+  },
+
+  "deployment": {
+    "type": "single",
+    "compose": "compose.yml",
+    "profiles": ["all", "core"],
+    "networks": ["default"],
+    "webui": true,
+    "port": 83,
+    "protocol": "http"
+  },
+
+  "requirements": {
+    "prerequisites": ["prerequisites"],
+    "apps": []
+  },
+
+  "postInstall": {
+    "messages": [
+      {
+        "type": "note",
+        "text": "Use http://${SERVER_LAN_IP}:${PIHOLE_PORT}/admin/ or https://example.com/admin/ to access the Pi-hole WebUI."
+      }
+    ]
+  },
+
+  "traefik": {
+    "supported": true
+  },
+
+  "dashboard": {
+    "enabled": true,
+    "location": "local",
+    "showStats": true,
+    "portVariable": "PIHOLE_PORT"
+  },
+
+  "env": {
+    "variables": [
+      {
+        "name": "PIHOLE_WEB_PASSWORD",
+        "description": "Pihole Web Password",
+        "type": "password",
+        "prompt": true,
+        "required": true
+      },
+      {
+        "name": "PIHOLE_LOCAL_DOMAIN",
+        "description": "Pihole Local Domain (e.g. myhome.internal)",
+        "type": "string",
+        "default": "home.internal",
+        "prompt": true,
+        "required": true
+      },
+      {
+        "name": "PIHOLE_PORT",
+        "description": "Web interface port",
+        "type": "port",
+        "default": 83,
+        "prompt": true,
+        "required": true,
+        "validation": {
+          "type": "port",
+          "min": 1,
+          "max": 65535
+        }
+      }
+    ]
+  },
+
+  "status": {
+    "file": "06_pihole_status",
+    "successMessage": "Pi-hole Setup Completed",
+    "telemetryAction": "pihole"
+  }
+}

package/apps/official/piwigo/compose.yml

@@ -0,0 +1,22 @@
+services:
+  # Piwigo - Photo Gallery
+  piwigo:
+    image: lscr.io/linuxserver/piwigo:latest
+    container_name: piwigo
+    security_opt:
+      - no-new-privileges:true
+    restart: unless-stopped
+    profiles: ["apps", "all"]
+    networks:
+      - default
+    ports:
+      - "$PIWIGO_PORT:80"
+    volumes:
+      - $DOCKERDIR/appdata/piwigo/config:/config
+      - $DOCKERDIR/appdata/piwigo/gallery:/gallery
+      - $PHOTOSDIR:/data/photos
+    environment:
+      TZ: $TZ
+      PUID: $PUID
+      PGID: $PGID
+    # DOCKER-LABELS-PLACEHOLDER

package/apps/official/piwigo/manifest.json

@@ -0,0 +1,65 @@
+{
+  "$schema": "../../../apps/manifest-schema.json",
+  "version": "1.2",
+
+  "app": {
+    "sname": "piwigo",
+    "pname": "Piwigo",
+    "description": "Piwigo is an open-source photo gallery software for the web. It allows you to organize, manage, and share your photo collection with powerful features for albums, tags, and user management.",
+    "descriptionShort": "Open-source photo gallery",
+    "icon": "sh-piwigo",
+    "category": "official",
+    "menuNumber": "06",
+    "tags": ["photos", "gallery", "images", "media"]
+  },
+
+  "deployment": {
+    "type": "single",
+    "compose": "compose.yml",
+    "profiles": ["apps", "all"],
+    "networks": ["default"],
+    "webui": true,
+    "port": 8081,
+    "protocol": "http"
+  },
+
+  "requirements": {
+    "prerequisites": ["prerequisites", "photos_folder", "basicpluspro", "appfolder_permission"],
+    "apps": []
+  },
+
+  "traefik": {
+    "supported": true
+  },
+
+  "dashboard": {
+    "enabled": true,
+    "location": "local",
+    "showStats": true,
+    "portVariable": "PIWIGO_PORT"
+  },
+
+  "env": {
+    "variables": [
+      {
+        "name": "PIWIGO_PORT",
+        "description": "Web interface port",
+        "type": "port",
+        "default": 8081,
+        "prompt": true,
+        "required": true,
+        "validation": {
+          "type": "port",
+          "min": 1,
+          "max": 65535
+        }
+      }
+    ]
+  },
+
+  "status": {
+    "file": "06_piwigo_status",
+    "successMessage": "Piwigo Setup Completed",
+    "telemetryAction": "piwigo"
+  }
+}

package/apps/official/plex/compose.yml

@@ -0,0 +1,39 @@
+services:
+  # Plex - Media Server
+  plex:
+    image: plexinc/pms-docker:latest
+    container_name: plex
+    security_opt:
+      - no-new-privileges:true
+    restart: "no"
+    profiles: ["media", "all"]
+    networks:
+      - default
+    ports:
+      - "$PLEX_PORT:32400/tcp"
+      - "3005:3005/tcp"
+      - "8324:8324/tcp"
+      - "32469:32469/tcp"
+      - "1900:1900/udp"
+      - "32410:32410/udp"
+      - "32412:32412/udp"
+      - "32413:32413/udp"
+      - "32414:32414/udp"
+    # DEVICES-GPU-PLACEHOLDER-DO-NOT-DELETE
+    volumes:
+      - $DOCKERDIR/appdata/plex:/config
+      - $DOWNLOADSDIR:/data/downloads
+      # - $MEDIADIR1:/data/media1
+      # - $MEDIADIR2:/data/media2
+      # - $MEDIADIR3:/data/media3
+      - /dev/shm:/data/transcode
+    environment:
+      TZ: $TZ
+      HOSTNAME: $PLEX_SERVER_NAME
+      PLEX_CLAIM_FILE: /run/secrets/plex_claim
+      PLEX_UID: $PUID
+      PLEX_GID: $PGID
+      ADVERTISE_IP: "http://$SERVER_LAN_IP:$PLEX_PORT/"
+    secrets:
+      - plex_claim
+    # DOCKER-LABELS-PLACEHOLDER

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

@@ -0,0 +1,24 @@
+#!/bin/bash
+# Plex pre-install hook
+# Handles optional Plex claim token - if empty, comments out secrets section
+
+APP_COMPOSE_FILE="$DOCKER_FOLDER/compose/$HOSTNAME/plex.yml"
+
+# Read the plex claim secret (may be empty)
+PLEX_CLAIM=$(sudo cat "$DOCKER_FOLDER/secrets/plex_claim" 2>/dev/null)
+
+# If plex_claim is empty, comment out the secrets-related lines
+if [[ -z "$PLEX_CLAIM" ]]; then
+    f_print_substep "No Plex claim token provided, skipping claim configuration"
+
+    # Comment out PLEX_CLAIM_FILE environment variable
+    sed -i 's|      PLEX_CLAIM_FILE: /run/secrets/plex_claim|      # PLEX_CLAIM_FILE: /run/secrets/plex_claim|' "$APP_COMPOSE_FILE"
+
+    # Comment out secrets section
+    sed -i 's|    secrets:|    # secrets:|' "$APP_COMPOSE_FILE"
+    sed -i 's|      - plex_claim|      # - plex_claim|' "$APP_COMPOSE_FILE"
+
+    f_print_substep "Secrets section commented out in: $APP_COMPOSE_FILE"
+else
+    f_print_substep "Plex claim token provided, server will claim on first start"
+fi