Template project for running Node-RED in Docker
The code in this repository is to provide a starting project for Node-RED, where the aim is to run in a production, cloud based environment. There have been a few modifications over the standard Node-RED released code.
- using a standard install of Node-RED with the projects feature enabled, clone a fork of this repository
- develop your Node-RED application
- when you are ready to release it use the Dockerfile in this repository to build your application
See the tutorials here
In a production system the Node-RED editor should be disabled. However, in this project the editor has been moved from the root (/) endpoint to the /admin endpoint to allow the application to be examined within the container.
It is recommended that the editor be disabled for any production workload. This is achieved by modifying the settings.js file to change the httpAdminRoot property from "/admin" to false : **httpAdminRoot: false,**
For more details about configuring the runtime using the settings.js file see the configuration section of the Node-RED documentation.
When running containers within a managed cloud environment, it is often useful to provide some endpoints within the container, so the cloud management system can verify the container is still alive and responding to requests.
This project adds the Health Checking capability from CloudNativeJS.io. The integration has be done in the server.js file by adding the following lines of code:
var health = require('@cloudnative/health-connect');
var healthcheck = new health.HealthChecker();
app.use('/live', health.LivenessEndpoint(healthcheck));
app.use('/ready', health.ReadinessEndpoint(healthcheck));
app.use('/health', health.HealthEndpoint(healthcheck));