groups: - name: Node-RED Configuration description: Configure Node-RED - name: Network Configuration description: Configure Network for Node-RED - name: Storage Configuration description: Configure Storage for Node-RED - name: Labels Configuration description: Configure labels for Node-RED - name: Resources Configuration description: Configure Resources for Node-RED questions: - variable: TZ group: Node-RED Configuration label: Timezone schema: type: string default: Etc/UTC required: true $ref: - definitions/timezone - variable: node_red label: "" group: Node-RED Configuration schema: type: dict attrs: - variable: image_selector label: Node-RED Image Selector description: The image selector for Node-RED. schema: type: string required: true default: "image" enum: - value: "image" description: Node-RED on Node.js 18 - value: "node_18_minimal_image" description: Node-RED Minimal on Node.js 18 - value: "node_20_image" description: Node-RED on Node.js 20 - value: "node_20_minimal_image" description: Node-RED Minimal on Node.js 20 - value: "node_22_image" description: Node-RED on Node.js 22 - value: "node_22_minimal_image" description: Node-RED Minimal on Node.js 22 # TODO: Remove EOL images - value: "node_16_image" description: Node-RED on Node.js 16 (EOL - Deprecated) - value: "node_16_minimal_image" description: Node-RED Minimal on Node.js 16 (EOL - Deprecated) - value: "node_14_image" description: Node-RED on Node.js 14 (EOL - Deprecated) - value: "node_14_minimal_image" description: Node-RED Minimal on Node.js 14 (EOL - Deprecated) - variable: enable_safe_mode label: Enable Safe Mode description: | Starts Node-RED without starting the flows.
This allows you to open the flows in the editor and make changes without the flows running.
When you deploy your changes, the flows are then started. schema: type: boolean default: false - variable: enable_projects label: Enable Projects description: | Enable projects in Node-RED.
This allows you to use the projects feature in Node-RED. schema: type: boolean default: false - variable: additional_envs label: Additional Environment Variables schema: type: list default: [] items: - variable: env label: Environment Variable schema: type: dict attrs: - variable: name label: Name schema: type: string required: true - variable: value label: Value schema: type: string - variable: network label: "" group: Network Configuration schema: type: dict attrs: - variable: web_port label: WebUI Port description: The port for Node-RED WebUI schema: type: dict attrs: - variable: bind_mode label: Port Bind Mode description: | The port bind mode.
- Publish: The port will be published on the host for external access.
- Expose: The port will be exposed for inter-container communication.
- None: The port will not be exposed or published.
Note: If the Dockerfile defines an EXPOSE directive, the port will still be exposed for inter-container communication regardless of this setting. schema: type: string default: "published" enum: - value: "published" description: Publish port on the host for external access - value: "exposed" description: Expose port for inter-container communication - value: "" description: None - variable: port_number label: Port Number schema: type: int default: 30049 min: 1 max: 65535 required: true - variable: host_ips label: Host IPs description: IPs on the host to bind this port schema: type: list show_if: [["bind_mode", "=", "published"]] default: [] items: - variable: host_ip label: Host IP schema: type: string required: true $ref: - definitions/node_bind_ip - variable: host_network label: Host Network description: | Bind to the host network. It's recommended to keep this disabled. schema: type: boolean default: false - variable: additional_ports label: Additional Ports schema: type: list show_if: [["host_network", "=", false]] items: - variable: port label: Port schema: type: dict attrs: - variable: bind_mode label: Port Bind Mode description: | The port bind mode.
- Publish: The port will be published on the host for external access.
- Expose: The port will be exposed for inter-container communication.
schema: type: string default: "published" enum: - value: "published" description: Publish port on the host for external access - value: "exposed" description: Expose port for inter-container communication - variable: port_number label: Port Number schema: type: int min: 1 max: 65535 required: true - variable: container_port label: Container Port schema: type: int min: 1 max: 65535 required: true - variable: protocol label: Protocol schema: type: string required: true default: "tcp" enum: - value: "tcp" description: TCP - value: "udp" description: UDP - variable: host_ips label: Host IPs description: IPs on the host to bind this port schema: type: list show_if: [["bind_mode", "=", "published"]] default: [] items: - variable: host_ip label: Host IP schema: type: string required: true $ref: - definitions/node_bind_ip - variable: storage label: "" group: Storage Configuration schema: type: dict attrs: - variable: data label: Node-RED Data Storage description: The path to store Node-RED Data. schema: type: dict attrs: - variable: type label: Type description: | ixVolume: Is dataset created automatically by the system.
Host Path: Is a path that already exists on the system. schema: type: string required: true default: "ix_volume" enum: - value: "host_path" description: Host Path (Path that already exists on the system) - value: "ix_volume" description: ixVolume (Dataset created automatically by the system) - variable: ix_volume_config label: ixVolume Configuration description: The configuration for the ixVolume dataset. schema: type: dict show_if: [["type", "=", "ix_volume"]] $ref: - "normalize/ix_volume" attrs: - variable: acl_enable label: Enable ACL description: Enable ACL for the storage. schema: type: boolean default: false - variable: dataset_name label: Dataset Name description: The name of the dataset to use for storage. schema: type: string required: true hidden: true default: "data" - variable: acl_entries label: ACL Configuration schema: type: dict show_if: [["acl_enable", "=", true]] attrs: [] - variable: host_path_config label: Host Path Configuration schema: type: dict show_if: [["type", "=", "host_path"]] attrs: - variable: acl_enable label: Enable ACL description: Enable ACL for the storage. schema: type: boolean default: false - variable: acl label: ACL Configuration schema: type: dict show_if: [["acl_enable", "=", true]] attrs: [] $ref: - "normalize/acl" - variable: path label: Host Path description: The host path to use for storage. schema: type: hostpath show_if: [["acl_enable", "=", false]] required: true - variable: additional_storage label: Additional Storage schema: type: list default: [] items: - variable: storageEntry label: Storage Entry schema: type: dict attrs: - variable: type label: Type description: | ixVolume: Is dataset created automatically by the system.
Host Path: Is a path that already exists on the system.
SMB Share: Is a SMB share that is mounted to as a volume. schema: type: string required: true default: "ix_volume" enum: - value: "host_path" description: Host Path (Path that already exists on the system) - value: "ix_volume" description: ixVolume (Dataset created automatically by the system) - value: "cifs" description: SMB/CIFS Share (Mounts a volume to a SMB share) - variable: read_only label: Read Only description: Mount the volume as read only. schema: type: boolean default: false - variable: mount_path label: Mount Path description: The path inside the container to mount the storage. schema: type: path required: true - variable: host_path_config label: Host Path Configuration schema: type: dict show_if: [["type", "=", "host_path"]] attrs: - variable: acl_enable label: Enable ACL description: Enable ACL for the storage. schema: type: boolean default: false - variable: acl label: ACL Configuration schema: type: dict show_if: [["acl_enable", "=", true]] attrs: [] $ref: - "normalize/acl" - variable: path label: Host Path description: The host path to use for storage. schema: type: hostpath show_if: [["acl_enable", "=", false]] required: true - variable: ix_volume_config label: ixVolume Configuration description: The configuration for the ixVolume dataset. schema: type: dict show_if: [["type", "=", "ix_volume"]] $ref: - "normalize/ix_volume" attrs: - variable: acl_enable label: Enable ACL description: Enable ACL for the storage. schema: type: boolean default: false - variable: dataset_name label: Dataset Name description: The name of the dataset to use for storage. schema: type: string required: true default: "storage_entry" - variable: acl_entries label: ACL Configuration schema: type: dict show_if: [["acl_enable", "=", true]] attrs: [] - variable: cifs_config label: SMB Configuration description: The configuration for the SMB dataset. schema: type: dict show_if: [["type", "=", "cifs"]] attrs: - variable: server label: Server description: The server to mount the SMB share. schema: type: string required: true - variable: path label: Path description: The path to mount the SMB share. schema: type: string required: true - variable: username label: Username description: The username to use for the SMB share. schema: type: string required: true - variable: password label: Password description: The password to use for the SMB share. schema: type: string required: true private: true - variable: domain label: Domain description: The domain to use for the SMB share. schema: type: string - variable: labels label: "" group: Labels Configuration schema: type: list default: [] items: - variable: label label: Label schema: type: dict attrs: - variable: key label: Key schema: type: string required: true - variable: value label: Value schema: type: string required: true - variable: containers label: Containers description: Containers where the label should be applied schema: type: list items: - variable: container label: Container schema: type: string required: true enum: - value: node-red description: node-red - variable: resources label: "" group: Resources Configuration schema: type: dict attrs: - variable: limits label: Limits schema: type: dict attrs: - variable: cpus label: CPUs description: CPUs limit for Node-RED. schema: type: int default: 2 required: true - variable: memory label: Memory (in MB) description: Memory limit for Node-RED. schema: type: int default: 4096 required: true