Skip to content

FlowFuse/nr-launcher

Repository files navigation

FlowFuse Launcher for Node-RED

This is the launcher FlowFuse uses to run instances of Node-RED. It dynamically generates the Node-RED settings based on the associated Project's settings.

The launcher starts its own HTTP service to allow the FlowForge platform to remotely control it.

Configure

  • --forgeURL - URL for Forge platform
  • --port - port to listen on for management interface
  • --team - FlowForge team id UUID
  • --project - FlowForge project id UUID
  • --token - Bearer Token to access Forge platform
  • --nodeRedPath - path to dir with a node_modules directory container a version of Node-RED
  • --no-tcp-in - inhibit TCP nodes from being servers
  • --no-udp-in - inhibit UDP nodes from being servers

The following Environment Variables can be used instead of the cmd line args...

FORGE_URL, FORGE_TEAM_ID, FORGE_PROJECT_ID, FORGE_PROJECT_TOKEN, FORGE_NR_PATH, FORGE_NR_NO_TCP_IN, FORGE_NR_NO_UDP_IN

NOTE: cmd line args take precedent if both are provided

By default, the launcher does not pass host environment variables through to the Node-RED process; only setting the built-in env vars and those configured in the instance settings.

However, if FORGE_EXPOSE_HOST_ENV is set, the launcher will pass through all env vars - except that starting with FORGE_*.