https://github.com/flowfuse/nr-launcher

A Laucher for Node-RED that allows settings to be loaded at startup.
https://github.com/flowfuse/nr-launcher

Last synced: 4 months ago
JSON representation

A Laucher for Node-RED that allows settings to be loaded at startup.

• Host: GitHub
• URL: https://github.com/flowfuse/nr-launcher
• Owner: FlowFuse
• License: apache-2.0
• Created: 2021-11-12T14:15:40.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-12T13:47:51.000Z (10 months ago)
• Last Synced: 2024-04-12T16:42:47.898Z (10 months ago)
• Language: JavaScript
• Size: 955 KB
• Stars: 4
• Watchers: 3
• Forks: 5
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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_*`.