ProxMenux/oci/catalog/apps/node-red.json

{
  "schema_version": "0.5.0",
  "kind": "proxmenux.oci-template",
  "id": "image-node-red",
  "status": "generated-unvalidated",
  "catalog_ui": {
    "title": {
      "en_US": "Node-RED"
    },
    "tagline": {
      "en_US": "Low-code programming for event-driven applications"
    },
    "description": {
      "en_US": "Node-RED is a flow-based low-code development platform that enables creating automation tasks and applications by connecting various nodes. A browser-based editor, simple to use, makes it ideal for users in home automation, industrial control, or other fields to quickly build data processing flows.\n\nCore features include a low-code flow editor and robust data handling. Built on Node.js with an event-driven, non-blocking model, the platform supports real-time data collection, transformation, and visualization. A palette with over 5000 nodes allows users to construct flows via drag-and-drop. A rich text editor enables creating JavaScript functions for enhanced customization.\n\nIt stores flows in JSON format, facilitating easy import and export for sharing. A built-in library allows saving useful functions, templates, or flows for reuse, and an online flow library supports sharing top flows globally. With ease of use and efficiency at the core, the platform delivers a modern solution for diverse automation needs.\n\n**Key Features:**\n- Browser-based low-code flow editor with drag-and-drop node connections\n- Real-time data collection, transformation, and visualization\n- Event-driven, non-blocking model with Node.js\n- Palette with over 5000 nodes for extended functionality\n- Rich text editor for creating JavaScript functions\n- JSON-based flow storage for easy sharing\n- Built-in library for saving functions, templates, and flows\n- Online flow library for sharing top flows\n\n**Learn More:**\n- [Node-RED Official Website](https://nodered.org/)\n- [Node-RED GitHub](https://github.com/node-red/node-red)\n"
    },
    "category": "smarthome",
    "category_label": "IoT & Smart Home",
    "author": "Node-RED",
    "developer": "Node-RED",
    "icon": null,
    "thumbnail": null,
    "screenshots": [],
    "architectures": [
      "amd64",
      "arm64"
    ],
    "launch": {
      "scheme": "http",
      "port": 1880,
      "path": "/"
    },
    "website": "https://nodered.org/",
    "documentation": null,
    "repository": "https://hub.docker.com/r/nodered/node-red",
    "tips": [],
    "mini_changelog": [],
    "display_version": null,
    "updated_at": null
  },
  "source": {
    "provider": "official",
    "repository": "https://hub.docker.com/r/nodered/node-red",
    "revision": "7197d1b1debcb07a6287b7f2068d9180f9e6cb962c4aa0033d4949e8fd5a43c2",
    "image_repository_url": "https://hub.docker.com/r/nodered/node-red",
    "readme_pushed_at": "2026-09-11T10:43:22Z",
    "compose_sha256": "7197d1b1debcb07a6287b7f2068d9180f9e6cb962c4aa0033d4949e8fd5a43c2",
    "generated_at": "2026-09-13T15:35:01+00:00"
  },
  "container_contract": {
    "service_name": "node-red",
    "container_name": "node-red",
    "image": {
      "reference": "nodered/node-red:latest",
      "registry": "docker.io",
      "repository": "nodered/node-red",
      "tag": "latest",
      "digest": null,
      "pull_policy": "resolve-selected-tag-to-architecture-digest-at-install"
    },
    "environment": [],
    "volumes": [
      {
        "id": "volume-0",
        "container_path": "/data",
        "compose_source_example": "/DATA/AppData/$AppID/data",
        "read_only": false,
        "required": true,
        "installation_choice": [
          "managed-volume",
          "host-bind"
        ],
        "default": "managed-volume",
        "managed_volume": {
          "backup": true,
          "default_size_gb": 8
        }
      }
    ],
    "ports": [
      {
        "container_port": 1880,
        "published_example": 1880,
        "protocol": "tcp",
        "required": true,
        "proxmox_behavior": "listener-on-dedicated-lxc-address-no-nat"
      }
    ],
    "related_services": [],
    "restart": "always",
    "stop_grace_period": null,
    "original_compose": "name: node-red\nservices:\n  node-red:\n    image: nodered/node-red:latest\n    deploy:\n      resources:\n        reservations:\n          memory: 64M\n    network_mode: host\n    ports:\n    - target: 1880\n      published: '1880'\n      protocol: tcp\n    restart: always\n    volumes:\n    - type: bind\n      source: /DATA/AppData/$AppID/data\n      target: /data\n    container_name: node-red\n"
  },
  "compose_stack": {
    "project_name": "node-red",
    "deployment_model": "one-native-oci-lxc-per-compose-service",
    "user_experience": "single-application-install",
    "main_service": "node-red",
    "service_count": 1,
    "services": [
      {
        "name": "node-red",
        "image": "nodered/node-red:latest",
        "is_main": true,
        "role": "frontend",
        "vmid_offset": 0,
        "depends_on": [],
        "frontend_network": true,
        "private_network": false,
        "compose": {
          "image": "nodered/node-red:latest",
          "deploy": {
            "resources": {
              "reservations": {
                "memory": "64M"
              }
            }
          },
          "network_mode": "host",
          "ports": [
            {
              "target": 1880,
              "published": "1880",
              "protocol": "tcp"
            }
          ],
          "restart": "always",
          "volumes": [
            {
              "type": "bind",
              "source": "/DATA/AppData/$AppID/data",
              "target": "/data"
            }
          ],
          "container_name": "node-red"
        }
      }
    ],
    "top_level": {
      "name": "node-red"
    },
    "networking": {
      "frontend": "selected-proxmox-bridge",
      "private_required": false,
      "private_creation": "automatic-create-if-missing",
      "private_address_allocation": "automatic-static-address-per-service",
      "service_discovery": "private-addresses-with-compose-service-host-aliases",
      "dependency_external_access": "disabled-unless-service-publishes-ports",
      "prompt_user_for_private_network": false
    },
    "storage": [
      {
        "id": "node-red-volume-0",
        "service": "node-red",
        "container_path": "/data",
        "mode": "host-bind",
        "user_selectable": true,
        "backup": false,
        "shared_with_other_lxc": true,
        "source_path": null,
        "source_path_prompt": "Host directory for node-red:/data"
      }
    ],
    "orchestration": {
      "reserve_vmids_atomically": 1,
      "start_order": [
        "node-red"
      ],
      "stop_order": [
        "node-red"
      ],
      "dependency_readiness": "compose-healthcheck-then-port-or-process-fallback",
      "rollback_on_failure": "remove-new-rootfs-preserve-created-persistent-volumes"
    },
    "installer_inputs": {
      "prompted": [
        "stack_name",
        "base_vmid",
        "rootfs_storage",
        "persistent_data_destinations",
        "frontend_bridge",
        "frontend_ipv4_mode"
      ],
      "automatic": [
        "dependent_vmids",
        "private_bridge",
        "private_subnet",
        "private_service_addresses",
        "compose_service_aliases",
        "generated_secrets",
        "dependency_start_and_stop_order"
      ],
      "generated_secrets": []
    }
  },
  "first_run": {
    "endpoints": [
      {
        "label": "Web UI",
        "scheme": "http",
        "port": 1880,
        "path": "/",
        "source": "compose-metadata"
      }
    ],
    "credentials": []
  },
  "proxmox": {
    "runtime": "native-oci-lxc",
    "technology_status": "proxmox-technology-preview",
    "defaults": {
      "unprivileged": true,
      "ostype": "auto-from-image",
      "cores": 2,
      "memory_mb": 128,
      "swap_mb": 512,
      "rootfs_size_gb": 8,
      "rootfs_storage": "local-lvm",
      "volume_storage": "local-lvm",
      "template_storage": "local",
      "bridge": "vmbr0",
      "ipv4": "dhcp",
      "firewall": true,
      "host_managed_network": true,
      "onboot": false,
      "features": [
        "nesting=1"
      ],
      "shutdown_timeout_seconds": 30
    },
    "image_metadata_policy": {
      "entrypoint": "import-from-oci-image",
      "cmd": "import-from-oci-image",
      "environment": "import-image-env-then-apply-compose-overrides",
      "user": "import-from-oci-image",
      "working_dir": "import-from-oci-image",
      "stop_signal": "import-from-oci-image"
    },
    "adaptations": [
      {
        "id": "imported-compose-source",
        "upstream_behavior": "The source definition deploys the complete Docker Compose application model.",
        "native_lxc_behavior": "The source model is preserved and remains blocked until every service option has a reviewed native Proxmox mapping.",
        "reason": "Catalog import must not imply runtime compatibility.",
        "behavioral_impact": "No automatic installation before review.",
        "validation": "pending-per-application"
      },
      {
        "id": "rolling-latest-image",
        "upstream_behavior": "A discovered Compose may pin a release tag or digest.",
        "native_lxc_behavior": "ProxMenux selects the same image repository with the latest tag for catalog installations.",
        "reason": "The automatic catalog intentionally offers rolling latest images; pinned versions belong to the future manual installer.",
        "behavioral_impact": "The installed release can be newer than the discovered Compose revision.",
        "validation": "pending-per-application"
      },
      {
        "id": "dedicated-lxc-network",
        "upstream_behavior": "Docker publishes selected container ports on the Docker host.",
        "native_lxc_behavior": "A reviewed native application will listen on its original container ports at a dedicated LXC address.",
        "reason": "A native LXC has its own address and does not require Docker port NAT.",
        "behavioral_impact": "Published ports are metadata; ProxMenux URLs use the matching container target port.",
        "validation": "pending-per-application"
      },
      {
        "id": "compose-shm-size",
        "upstream_behavior": "Compose sets the size of the container /dev/shm tmpfs.",
        "native_lxc_behavior": "ProxMenux mounts a native LXC tmpfs at /dev/shm with the same requested capacity.",
        "reason": "The OCI image runs directly as an LXC and therefore needs the equivalent Proxmox mount entry.",
        "behavioral_impact": "None expected.",
        "validation": "not-requested-by-compose"
      },
      {
        "id": "compose-command",
        "upstream_behavior": "Compose replaces the image Cmd while retaining its Entrypoint.",
        "native_lxc_behavior": "ProxMenux reads the official OCI Entrypoint and combines it with the Compose command as the native LXC init command.",
        "reason": "Proxmox stores the effective OCI process as one entrypoint string.",
        "behavioral_impact": "None expected.",
        "validation": "not-requested-by-compose"
      },
      {
        "id": "compose-privileged-mode",
        "upstream_behavior": "Compose selects whether the container runs in privileged mode.",
        "native_lxc_behavior": "ProxMenux uses a privileged LXC only after an explicit high-risk confirmation; otherwise it keeps the LXC unprivileged.",
        "reason": "The native OCI-LXC deployment must preserve the requested privilege level without silently weakening isolation.",
        "behavioral_impact": "A privileged LXC has weaker isolation from the Proxmox host.",
        "validation": "native-equivalent"
      },
      {
        "id": "compose-process-runtime",
        "upstream_behavior": "Compose can replace Entrypoint, User and WorkingDir and request an init process or interactive terminal.",
        "native_lxc_behavior": "ProxMenux applies the process overrides through native LXC init directives; lxc-init provides PID 1 supervision and the CT console provides terminal access.",
        "reason": "The OCI process must start with the same identity, command and working directory without Docker.",
        "behavioral_impact": "Compose stdin_open and tty become access through the Proxmox LXC console.",
        "validation": "not-requested-by-compose"
      },
      {
        "id": "compose-healthcheck",
        "upstream_behavior": "Docker periodically executes the declared container healthcheck.",
        "native_lxc_behavior": "For a single-service LXC, ProxMenux translates HTTP localhost checks into a mandatory first-start service check.",
        "reason": "Proxmox has no persistent Docker health state, while the installer still must detect a failed first boot.",
        "behavioral_impact": "The check runs during installation rather than continuously after installation.",
        "validation": "not-requested-by-compose"
      },
      {
        "id": "compose-cpu-priority",
        "upstream_behavior": "Docker cpu_shares sets a relative scheduling weight with 1024 as its neutral value.",
        "native_lxc_behavior": "ProxMenux converts the relative weight to Proxmox cpuunits with 100 as its neutral value and lets the user review it.",
        "reason": "Both settings express relative CPU priority on different scales.",
        "behavioral_impact": "Rounding and Proxmox minimum limits can slightly change very low weights.",
        "validation": "not-requested-by-compose"
      },
      {
        "id": "compose-network-identity",
        "upstream_behavior": "Compose can set hostname, MAC address, extra hosts and attach a service to Docker networks.",
        "native_lxc_behavior": "ProxMenux applies hostname and MAC to net0, writes additional host aliases into the LXC and uses its dedicated bridge connection for single-service networks.",
        "reason": "A dedicated LXC has its own network namespace and does not need a Docker bridge per service.",
        "behavioral_impact": "host-gateway resolves to the IPv4 address of the selected Proxmox bridge.",
        "validation": "not-requested-by-compose"
      },
      {
        "id": "docker-engine-metadata",
        "upstream_behavior": "Compose labels annotate Docker objects and the json-file logging driver rotates Docker-managed logs.",
        "native_lxc_behavior": "Labels remain source metadata; Docker json-file settings are not applied because the OCI process runs directly under LXC.",
        "reason": "There is no Docker object or Docker json-file log behind a native OCI-LXC application.",
        "behavioral_impact": "Docker-only label consumers and Docker log-driver rotation do not exist in the native deployment.",
        "validation": "not-requested-by-compose"
      },
      {
        "id": "compose-device-passthrough",
        "upstream_behavior": "Compose passes host character devices or requests an NVIDIA runtime GPU.",
        "native_lxc_behavior": "ProxMenux converts recognized device declarations to native Proxmox dev resources; NVIDIA profiles also inject compatible host driver libraries read-only.",
        "reason": "Native OCI-LXC does not execute Docker device or NVIDIA runtime hooks.",
        "behavioral_impact": "Hardware is exposed only after explicit user confirmation and host-path validation.",
        "validation": "not-requested-by-compose"
      },
      {
        "id": "compose-host-ipc",
        "upstream_behavior": "ipc: host shares the Docker host IPC namespace, commonly to avoid Docker's small default shared-memory allocation.",
        "native_lxc_behavior": "The application keeps the LXC IPC namespace and receives a configurable 1 GiB /dev/shm instead of sharing Proxmox host IPC.",
        "reason": "Processes in a single native LXC already share one IPC namespace; retaining isolation is safer than exposing host IPC.",
        "behavioral_impact": "The application cannot exchange IPC objects with processes on the Proxmox host.",
        "validation": "not-requested-by-compose"
      }
    ]
  },
  "compatibility": {
    "automatic_install_candidate": true,
    "validated": false,
    "supported_compose_keys": [
      "command",
      "container_name",
      "cpu_shares",
      "deploy",
      "devices",
      "entrypoint",
      "environment",
      "extra_hosts",
      "healthcheck",
      "hostname",
      "image",
      "init",
      "ipc",
      "labels",
      "logging",
      "mac_address",
      "network_mode",
      "networks",
      "ports",
      "privileged",
      "restart",
      "runtime",
      "shm_size",
      "stdin_open",
      "stop_grace_period",
      "tty",
      "user",
      "volumes",
      "working_dir"
    ],
    "untranslated_blockers": [],
    "policy": "Single-image definitions are installable when every declared Compose option has a native Proxmox translation. Multi-image and unsupported runtime features remain blocked until their orchestrator or mapping is available."
  },
  "validation": {
    "schema": "passed-at-generation",
    "clean_install": "pending",
    "service_health": "pending",
    "restart_persistence": "pending",
    "backup_restore": "pending",
    "update_preserves_data": "pending"
  },
  "lifecycle": {
    "update_strategy": "resolve-latest-image-then-apply-reviewed-native-lxc-update",
    "registry_state": {
      "resolved_architecture": null,
      "resolved_digest": null,
      "image_version_label": null,
      "image_created": null
    },
    "change_detection": "compare-compose-sha256-and-resolved-latest-image-digest",
    "automatic_unattended_updates": false
  }
}