Created
March 29, 2022 20:10
-
-
Save buglss/11738d9cd390ab73355fc246a3f8b1b6 to your computer and use it in GitHub Desktop.
Custom red.js for Multible httpStatic Folders
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
#!/usr/bin/env node | |
/** | |
* Copyright JS Foundation and other contributors, http://js.foundation | |
* | |
* Licensed under the Apache License, Version 2.0 (the "License"); | |
* you may not use this file except in compliance with the License. | |
* You may obtain a copy of the License at | |
* | |
* http://www.apache.org/licenses/LICENSE-2.0 | |
* | |
* Unless required by applicable law or agreed to in writing, software | |
* distributed under the License is distributed on an "AS IS" BASIS, | |
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
* See the License for the specific language governing permissions and | |
* limitations under the License. | |
**/ | |
/** | |
* Customized by Levent Sencer Şahin <@buglss> | 29.03.2022 | |
* | |
* Added Lines: | |
* 1. 50 - require node-red | |
* 2. 413..417 - register static paths of server in settings.httpStatics | |
* 3. 430 - if condition add settings.httpStatics | |
* 4. 437 - if condition add settings.httpStatics | |
* 5. 545..458 - log of http static paths in settings.httpStatics property | |
*/ | |
if (process.argv[2] === 'admin') { | |
try { | |
require("node-red-admin")(process.argv.slice(3)).catch(err => { | |
process.exit(1); | |
}) | |
} catch(err) { | |
console.log(err) | |
} | |
return; | |
} | |
var http = require('http'); | |
var https = require('https'); | |
var util = require("util"); | |
var express = require("express"); | |
var crypto = require("crypto"); | |
try { bcrypt = require('bcrypt'); } | |
catch(e) { bcrypt = require('bcryptjs'); } | |
var nopt = require("nopt"); | |
var path = require("path"); | |
var fs = require("fs-extra"); | |
var RED = require("node-red"); | |
var server; | |
var app = express(); | |
var settingsFile; | |
var flowFile; | |
var knownOpts = { | |
"help": Boolean, | |
"port": Number, | |
"settings": [path], | |
"title": String, | |
"userDir": [path], | |
"verbose": Boolean, | |
"safe": Boolean, | |
"define": [String, Array] | |
}; | |
var shortHands = { | |
"?":["--help"], | |
"p":["--port"], | |
"s":["--settings"], | |
// As we want to reserve -t for now, adding a shorthand to help so it | |
// doesn't get treated as --title | |
"t":["--help"], | |
"u":["--userDir"], | |
"v":["--verbose"], | |
"D":["--define"] | |
}; | |
nopt.invalidHandler = function(k,v,t) { | |
// TODO: console.log(k,v,t); | |
} | |
var parsedArgs = nopt(knownOpts,shortHands,process.argv,2) | |
if (parsedArgs.help) { | |
console.log("Node-RED v"+RED.version()); | |
console.log("Usage: node-red [-v] [-?] [--settings settings.js] [--userDir DIR]"); | |
console.log(" [--port PORT] [--title TITLE] [--safe] [flows.json]"); | |
console.log(" node-red admin <command> [args] [-?] [--userDir DIR] [--json]"); | |
console.log(""); | |
console.log("Options:"); | |
console.log(" -p, --port PORT port to listen on"); | |
console.log(" -s, --settings FILE use specified settings file"); | |
console.log(" --title TITLE process window title"); | |
console.log(" -u, --userDir DIR use specified user directory"); | |
console.log(" -v, --verbose enable verbose output"); | |
console.log(" --safe enable safe mode"); | |
console.log(" -D, --define X=Y overwrite value in settings file"); | |
console.log(" -?, --help show this help"); | |
console.log(" admin <command> run an admin command"); | |
console.log(""); | |
console.log("Documentation can be found at http://nodered.org"); | |
process.exit(); | |
} | |
if (parsedArgs.argv.remain.length > 0) { | |
flowFile = parsedArgs.argv.remain[0]; | |
} | |
process.env.NODE_RED_HOME = process.env.NODE_RED_HOME || __dirname; | |
if (parsedArgs.settings) { | |
// User-specified settings file | |
settingsFile = parsedArgs.settings; | |
} else if (parsedArgs.userDir && fs.existsSync(path.join(parsedArgs.userDir,"settings.js"))) { | |
// User-specified userDir that contains a settings.js | |
settingsFile = path.join(parsedArgs.userDir,"settings.js"); | |
} else { | |
if (fs.existsSync(path.join(process.env.NODE_RED_HOME,".config.json"))) { | |
// NODE_RED_HOME contains user data - use its settings.js | |
settingsFile = path.join(process.env.NODE_RED_HOME,"settings.js"); | |
} else if (process.env.HOMEPATH && fs.existsSync(path.join(process.env.HOMEPATH,".node-red",".config.json"))) { | |
// Consider compatibility for older versions | |
settingsFile = path.join(process.env.HOMEPATH,".node-red","settings.js"); | |
} else { | |
var userDir = parsedArgs.userDir || path.join(process.env.HOME || process.env.USERPROFILE || process.env.HOMEPATH,".node-red"); | |
var userSettingsFile = path.join(userDir,"settings.js"); | |
if (fs.existsSync(userSettingsFile)) { | |
// $HOME/.node-red/settings.js exists | |
settingsFile = userSettingsFile; | |
} else { | |
var defaultSettings = path.join(__dirname,"settings.js"); | |
var settingsStat = fs.statSync(defaultSettings); | |
if (settingsStat.mtime.getTime() <= settingsStat.ctime.getTime()) { | |
// Default settings file has not been modified - safe to copy | |
fs.copySync(defaultSettings,userSettingsFile); | |
settingsFile = userSettingsFile; | |
} else { | |
// Use default settings.js as it has been modified | |
settingsFile = defaultSettings; | |
} | |
} | |
} | |
} | |
try { | |
var settings = require(settingsFile); | |
settings.settingsFile = settingsFile; | |
} catch(err) { | |
console.log("Error loading settings file: "+settingsFile) | |
if (err.code == 'MODULE_NOT_FOUND') { | |
if (err.toString().indexOf(settingsFile) === -1) { | |
console.log(err.toString()); | |
} | |
} else { | |
console.log(err); | |
} | |
process.exit(); | |
} | |
if (parsedArgs.define) { | |
var defs = parsedArgs.define; | |
try { | |
while (defs.length > 0) { | |
var def = defs.shift(); | |
var match = /^(([^=]+)=(.+)|@(.*))$/.exec(def); | |
if (match) { | |
if (!match[4]) { | |
var val = match[3]; | |
try { | |
val = JSON.parse(match[3]); | |
} catch(err) { | |
// Leave it as a string | |
} | |
RED.util.setObjectProperty(settings, match[2], val, true); | |
} else { | |
var obj = fs.readJsonSync(match[4]); | |
for (var k in obj) { | |
if (obj.hasOwnProperty(k)) { | |
RED.util.setObjectProperty(settings, k, obj[k], true) | |
} | |
} | |
} | |
} | |
else { | |
throw new Error("Invalid syntax: '"+def+"'"); | |
} | |
} | |
} catch (e) { | |
console.log("Error processing -D option: "+e.message); | |
process.exit(); | |
} | |
} | |
if (parsedArgs.verbose) { | |
settings.verbose = true; | |
} | |
if (parsedArgs.safe || (process.env.NODE_RED_ENABLE_SAFE_MODE && !/^false$/i.test(process.env.NODE_RED_ENABLE_SAFE_MODE) )) { | |
settings.safeMode = true; | |
} | |
if (process.env.NODE_RED_ENABLE_PROJECTS) { | |
settings.editorTheme = settings.editorTheme || {}; | |
settings.editorTheme.projects = settings.editorTheme.projects || {}; | |
settings.editorTheme.projects.enabled = !/^false$/i.test(process.env.NODE_RED_ENABLE_PROJECTS); | |
} | |
if (process.env.NODE_RED_ENABLE_TOURS) { | |
settings.editorTheme = settings.editorTheme || {}; | |
settings.editorTheme.tours = !/^false$/i.test(process.env.NODE_RED_ENABLE_TOURS); | |
} | |
var defaultServerSettings = { | |
"x-powered-by": false | |
} | |
var serverSettings = Object.assign({},defaultServerSettings,settings.httpServerOptions||{}); | |
for (var eOption in serverSettings) { | |
app.set(eOption, serverSettings[eOption]); | |
} | |
// Delay logging of (translated) messages until the RED object has been initialized | |
var delayedLogItems = []; | |
var startupHttps = settings.https; | |
if (typeof startupHttps === "function") { | |
// Get the result of the function, because createServer doesn't accept functions as input | |
startupHttps = startupHttps(); | |
} | |
var httpsPromise = Promise.resolve(startupHttps); | |
httpsPromise.then(function(startupHttps) { | |
if (startupHttps) { | |
server = https.createServer(startupHttps,function(req,res) {app(req,res);}); | |
if (settings.httpsRefreshInterval) { | |
var httpsRefreshInterval = parseFloat(settings.httpsRefreshInterval)||12; | |
if (httpsRefreshInterval > 596) { | |
// Max value based on (2^31-1)ms - the max that setInterval can accept | |
httpsRefreshInterval = 596; | |
} | |
// Check whether setSecureContext is available (Node.js 11+) | |
if (server.setSecureContext) { | |
// Check whether `http` is a callable function | |
if (typeof settings.https === "function") { | |
delayedLogItems.push({type:"info", id:"server.https.refresh-interval", params:{interval:httpsRefreshInterval}}); | |
setInterval(function () { | |
try { | |
// Get the result of the function, because createServer doesn't accept functions as input | |
Promise.resolve(settings.https()).then(function(refreshedHttps) { | |
if (refreshedHttps) { | |
// The key/cert needs to be updated in the NodeJs http(s) server, when no key/cert is yet available or when the key/cert has changed. | |
// Note that the refreshed key/cert can be supplied as a string or a buffer. | |
var updateKey = (server.key == undefined || (Buffer.isBuffer(server.key) && !server.key.equals(refreshedHttps.key)) || (typeof server.key == "string" && server.key != refreshedHttps.key)); | |
var updateCert = (server.cert == undefined || (Buffer.isBuffer(server.cert) && !server.cert.equals(refreshedHttps.cert)) || (typeof server.cert == "string" && server.cert != refreshedHttps.cert)); | |
// Only update the credentials in the server when key or cert has changed | |
if(updateKey || updateCert) { | |
server.setSecureContext(refreshedHttps); | |
RED.log.info(RED.log._("server.https.settings-refreshed")); | |
} | |
} | |
}).catch(function(err) { | |
RED.log.error(RED.log._("server.https.refresh-failed",{message:err})); | |
}); | |
} catch(err) { | |
RED.log.error(RED.log._("server.https.refresh-failed",{message:err})); | |
} | |
}, httpsRefreshInterval*60*60*1000); | |
} else { | |
delayedLogItems.push({type:"warn", id:"server.https.function-required"}); | |
} | |
} else { | |
delayedLogItems.push({type:"warn", id:"server.https.nodejs-version"}); | |
} | |
} | |
} else { | |
server = http.createServer(function(req,res) {app(req,res);}); | |
} | |
server.setMaxListeners(0); | |
function formatRoot(root) { | |
if (root[0] != "/") { | |
root = "/" + root; | |
} | |
if (root.slice(-1) != "/") { | |
root = root + "/"; | |
} | |
return root; | |
} | |
if (settings.httpRoot === false) { | |
settings.httpAdminRoot = false; | |
settings.httpNodeRoot = false; | |
} else { | |
settings.disableEditor = settings.disableEditor||false; | |
} | |
if (settings.httpAdminRoot !== false) { | |
settings.httpAdminRoot = formatRoot(settings.httpAdminRoot || settings.httpRoot || "/"); | |
settings.httpAdminAuth = settings.httpAdminAuth || settings.httpAuth; | |
} else { | |
settings.disableEditor = true; | |
} | |
if (settings.httpNodeRoot !== false) { | |
settings.httpNodeRoot = formatRoot(settings.httpNodeRoot || settings.httpRoot || "/"); | |
settings.httpNodeAuth = settings.httpNodeAuth || settings.httpAuth; | |
} | |
// if we got a port from command line, use it (even if 0) | |
// replicate (settings.uiPort = parsedArgs.port||settings.uiPort||1880;) but allow zero | |
if (parsedArgs.port !== undefined){ | |
settings.uiPort = parsedArgs.port; | |
} else { | |
if (settings.uiPort === undefined){ | |
settings.uiPort = 1880; | |
} | |
} | |
settings.uiHost = settings.uiHost||"0.0.0.0"; | |
if (flowFile) { | |
settings.flowFile = flowFile; | |
} | |
if (parsedArgs.userDir) { | |
settings.userDir = parsedArgs.userDir; | |
} | |
try { | |
RED.init(server,settings); | |
} catch(err) { | |
if (err.code == "unsupported_version") { | |
console.log("Unsupported version of Node.js:",process.version); | |
console.log("Node-RED requires Node.js v8.9.0 or later"); | |
} else { | |
console.log("Failed to start server:"); | |
if (err.stack) { | |
console.log(err.stack); | |
} else { | |
console.log(err); | |
} | |
} | |
process.exit(1); | |
} | |
function basicAuthMiddleware(user,pass) { | |
var basicAuth = require('basic-auth'); | |
var checkPassword; | |
var localCachedPassword; | |
if (pass.length == "32") { | |
// Assume its a legacy md5 password | |
checkPassword = function(p) { | |
return crypto.createHash('md5').update(p,'utf8').digest('hex') === pass; | |
} | |
} else { | |
checkPassword = function(p) { | |
return bcrypt.compareSync(p,pass); | |
} | |
} | |
var checkPasswordAndCache = function(p) { | |
// For BasicAuth routes we know the password cannot change without | |
// a restart of Node-RED. This means we can cache the provided crypted | |
// version to save recalculating each time. | |
if (localCachedPassword === p) { | |
return true; | |
} | |
var result = checkPassword(p); | |
if (result) { | |
localCachedPassword = p; | |
} | |
return result; | |
} | |
return function(req,res,next) { | |
if (req.method === 'OPTIONS') { | |
return next(); | |
} | |
var requestUser = basicAuth(req); | |
if (!requestUser || requestUser.name !== user || !checkPasswordAndCache(requestUser.pass)) { | |
res.set('WWW-Authenticate', 'Basic realm="Authorization Required"'); | |
return res.sendStatus(401); | |
} | |
next(); | |
} | |
} | |
if (settings.httpAdminRoot !== false && settings.httpAdminAuth) { | |
RED.log.warn(RED.log._("server.httpadminauth-deprecated")); | |
app.use(settings.httpAdminRoot, basicAuthMiddleware(settings.httpAdminAuth.user,settings.httpAdminAuth.pass)); | |
} | |
if (settings.httpAdminRoot !== false) { | |
app.use(settings.httpAdminRoot,RED.httpAdmin); | |
} | |
if (settings.httpNodeRoot !== false && settings.httpNodeAuth) { | |
app.use(settings.httpNodeRoot,basicAuthMiddleware(settings.httpNodeAuth.user,settings.httpNodeAuth.pass)); | |
} | |
if (settings.httpNodeRoot !== false) { | |
app.use(settings.httpNodeRoot,RED.httpNode); | |
} | |
if (settings.httpStatic) { | |
settings.httpStaticAuth = settings.httpStaticAuth || settings.httpAuth; | |
if (settings.httpStaticAuth) { | |
app.use("/",basicAuthMiddleware(settings.httpStaticAuth.user,settings.httpStaticAuth.pass)); | |
} | |
app.use("/",express.static(settings.httpStatic)); | |
} | |
// Register static paths of server in settings.httpStatics | |
if (settings.httpStatics && Array.isArray(settings.httpStatics)) { | |
settings.httpStatics.forEach(s => { | |
app.use("/",express.static(s)); | |
}) | |
} | |
function getListenPath() { | |
var port = settings.serverPort; | |
if (port === undefined){ | |
port = settings.uiPort; | |
} | |
var listenPath = 'http'+(settings.https?'s':'')+'://'+ | |
(settings.uiHost == '::'?'localhost':(settings.uiHost == '0.0.0.0'?'127.0.0.1':settings.uiHost))+ | |
':'+port; | |
if (settings.httpAdminRoot !== false) { | |
listenPath += settings.httpAdminRoot; | |
} else if (settings.httpStatic || settings.httpStatics) { // add settings.httpStatics | |
listenPath += "/"; | |
} | |
return listenPath; | |
} | |
RED.start().then(function() { | |
if (settings.httpAdminRoot !== false || settings.httpNodeRoot !== false || settings.httpStatic || settings.httpStatics) { // add settings.httpStatics | |
server.on('error', function(err) { | |
if (err.errno === "EADDRINUSE") { | |
RED.log.error(RED.log._("server.unable-to-listen", {listenpath:getListenPath()})); | |
RED.log.error(RED.log._("server.port-in-use")); | |
} else { | |
RED.log.error(RED.log._("server.uncaught-exception")); | |
if (err.stack) { | |
RED.log.error(err.stack); | |
} else { | |
RED.log.error(err); | |
} | |
} | |
process.exit(1); | |
}); | |
// Log of http static paths in settings.httpStatics property | |
if (settings.httpStatics && Array.isArray(settings.httpStatics)) { | |
settings.httpStatics.forEach(function (s) { | |
RED.log.info(log._("runtime.paths.httpStatic",{path:path.resolve(s)})); | |
}); | |
} | |
// Log all the delayed messages, since they can be translated at this point | |
delayedLogItems.forEach(function (delayedLogItem, index) { | |
RED.log[delayedLogItem.type](RED.log._(delayedLogItem.id, delayedLogItem.params||{})); | |
}); | |
server.listen(settings.uiPort,settings.uiHost,function() { | |
if (settings.httpAdminRoot === false) { | |
RED.log.info(RED.log._("server.admin-ui-disabled")); | |
} | |
settings.serverPort = server.address().port; | |
process.title = parsedArgs.title || 'node-red'; | |
RED.log.info(RED.log._("server.now-running", {listenpath:getListenPath()})); | |
}); | |
} else { | |
RED.log.info(RED.log._("server.headless-mode")); | |
} | |
}).catch(function(err) { | |
RED.log.error(RED.log._("server.failed-to-start")); | |
if (err.stack) { | |
RED.log.error(err.stack); | |
} else { | |
RED.log.error(err); | |
} | |
}); | |
process.on('uncaughtException',function(err) { | |
util.log('[red] Uncaught Exception:'); | |
if (err.stack) { | |
try { | |
RED.log.error(err.stack); | |
} catch(err2) { | |
util.log(err.stack); | |
} | |
} else { | |
try { | |
RED.log.error(err); | |
} catch(err2) { | |
util.log(err); | |
} | |
} | |
process.exit(1); | |
}); | |
var stopping = false; | |
function exitWhenStopped() { | |
if (!stopping) { | |
stopping = true; | |
RED.stop().then(function() { | |
process.exit(); | |
}); | |
} | |
} | |
process.on('SIGINT', exitWhenStopped); | |
process.on('SIGTERM', exitWhenStopped); | |
process.on('SIGHUP', exitWhenStopped); | |
process.on('SIGUSR2', exitWhenStopped); // for nodemon restart | |
process.on('SIGBREAK', exitWhenStopped); // for windows ctrl-break | |
process.on('message', function(m) { // for PM2 under window with --shutdown-with-message | |
if (m === 'shutdown') { exitWhenStopped() } | |
}); | |
}).catch(function(err) { | |
console.log("Failed to get https settings: " + err); | |
console.log(err.stack) | |
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
/** | |
* This is the default settings file provided by Node-RED. | |
* | |
* It can contain any valid JavaScript code that will get run when Node-RED | |
* is started. | |
* | |
* Lines that start with // are commented out. | |
* Each entry should be separated from the entries above and below by a comma ',' | |
* | |
* For more information about individual settings, refer to the documentation: | |
* https://nodered.org/docs/user-guide/runtime/configuration | |
* | |
* The settings are split into the following sections: | |
* - Flow File and User Directory Settings | |
* - Security | |
* - Server Settings | |
* - Runtime Settings | |
* - Editor Settings | |
* - Node Settings | |
* | |
**/ | |
/** | |
* Customized by Levent Sencer Şahin <@buglss> | 29.03.2022 | |
* | |
* Added Lines: | |
* 1. 234 - httpStatics: like httpStatic but supports multi paths | |
*/ | |
module.exports = { | |
/******************************************************************************* | |
* Flow File and User Directory Settings | |
* - flowFile | |
* - credentialSecret | |
* - flowFilePretty | |
* - userDir | |
* - nodesDir | |
******************************************************************************/ | |
/** The file containing the flows. If not set, defaults to flows_<hostname>.json **/ | |
flowFile: 'flows.json', | |
/** By default, credentials are encrypted in storage using a generated key. To | |
* specify your own secret, set the following property. | |
* If you want to disable encryption of credentials, set this property to false. | |
* Note: once you set this property, do not change it - doing so will prevent | |
* node-red from being able to decrypt your existing credentials and they will be | |
* lost. | |
*/ | |
//credentialSecret: "a-secret-key", | |
/** By default, the flow JSON will be formatted over multiple lines making | |
* it easier to compare changes when using version control. | |
* To disable pretty-printing of the JSON set the following property to false. | |
*/ | |
flowFilePretty: true, | |
/** By default, all user data is stored in a directory called `.node-red` under | |
* the user's home directory. To use a different location, the following | |
* property can be used | |
*/ | |
//userDir: '/home/nol/.node-red/', | |
/** Node-RED scans the `nodes` directory in the userDir to find local node files. | |
* The following property can be used to specify an additional directory to scan. | |
*/ | |
//nodesDir: '/home/nol/.node-red/nodes', | |
/******************************************************************************* | |
* Security | |
* - adminAuth | |
* - https | |
* - httpsRefreshInterval | |
* - requireHttps | |
* - httpNodeAuth | |
* - httpStaticAuth | |
******************************************************************************/ | |
/** To password protect the Node-RED editor and admin API, the following | |
* property can be used. See http://nodered.org/docs/security.html for details. | |
*/ | |
//adminAuth: { | |
// type: "credentials", | |
// users: [{ | |
// username: "admin", | |
// password: "$2a$08$zZWtXTja0fB1pzD4sHCMyOCMYz2Z6dNbM6tl8sJogENOMcxWV9DN.", | |
// permissions: "*" | |
// }] | |
//}, | |
/** The following property can be used to enable HTTPS | |
* This property can be either an object, containing both a (private) key | |
* and a (public) certificate, or a function that returns such an object. | |
* See http://nodejs.org/api/https.html#https_https_createserver_options_requestlistener | |
* for details of its contents. | |
*/ | |
/** Option 1: static object */ | |
//https: { | |
// key: require("fs").readFileSync('privkey.pem'), | |
// cert: require("fs").readFileSync('cert.pem') | |
//}, | |
/** Option 2: function that returns the HTTP configuration object */ | |
// https: function() { | |
// // This function should return the options object, or a Promise | |
// // that resolves to the options object | |
// return { | |
// key: require("fs").readFileSync('privkey.pem'), | |
// cert: require("fs").readFileSync('cert.pem') | |
// } | |
// }, | |
/** If the `https` setting is a function, the following setting can be used | |
* to set how often, in hours, the function will be called. That can be used | |
* to refresh any certificates. | |
*/ | |
//httpsRefreshInterval : 12, | |
/** The following property can be used to cause insecure HTTP connections to | |
* be redirected to HTTPS. | |
*/ | |
//requireHttps: true, | |
/** To password protect the node-defined HTTP endpoints (httpNodeRoot), | |
* including node-red-dashboard, or the static content (httpStatic), the | |
* following properties can be used. | |
* The `pass` field is a bcrypt hash of the password. | |
* See http://nodered.org/docs/security.html#generating-the-password-hash | |
*/ | |
//httpNodeAuth: {user:"user",pass:"$2a$08$zZWtXTja0fB1pzD4sHCMyOCMYz2Z6dNbM6tl8sJogENOMcxWV9DN."}, | |
//httpStaticAuth: {user:"user",pass:"$2a$08$zZWtXTja0fB1pzD4sHCMyOCMYz2Z6dNbM6tl8sJogENOMcxWV9DN."}, | |
/******************************************************************************* | |
* Server Settings | |
* - uiPort | |
* - uiHost | |
* - apiMaxLength | |
* - httpServerOptions | |
* - httpAdminRoot | |
* - httpAdminMiddleware | |
* - httpNodeRoot | |
* - httpNodeCors | |
* - httpNodeMiddleware | |
* - httpStatic | |
******************************************************************************/ | |
/** the tcp port that the Node-RED web server is listening on */ | |
uiPort: process.env.PORT || 1880, | |
/** By default, the Node-RED UI accepts connections on all IPv4 interfaces. | |
* To listen on all IPv6 addresses, set uiHost to "::", | |
* The following property can be used to listen on a specific interface. For | |
* example, the following would only allow connections from the local machine. | |
*/ | |
//uiHost: "127.0.0.1", | |
/** The maximum size of HTTP request that will be accepted by the runtime api. | |
* Default: 5mb | |
*/ | |
//apiMaxLength: '5mb', | |
/** The following property can be used to pass custom options to the Express.js | |
* server used by Node-RED. For a full list of available options, refer | |
* to http://expressjs.com/en/api.html#app.settings.table | |
*/ | |
//httpServerOptions: { }, | |
/** By default, the Node-RED UI is available at http://localhost:1880/ | |
* The following property can be used to specify a different root path. | |
* If set to false, this is disabled. | |
*/ | |
//httpAdminRoot: '/admin', | |
/** The following property can be used to add a custom middleware function | |
* in front of all admin http routes. For example, to set custom http | |
* headers. It can be a single function or an array of middleware functions. | |
*/ | |
// httpAdminMiddleware: function(req,res,next) { | |
// // Set the X-Frame-Options header to limit where the editor | |
// // can be embedded | |
// //res.set('X-Frame-Options', 'sameorigin'); | |
// next(); | |
// }, | |
/** Some nodes, such as HTTP In, can be used to listen for incoming http requests. | |
* By default, these are served relative to '/'. The following property | |
* can be used to specifiy a different root path. If set to false, this is | |
* disabled. | |
*/ | |
//httpNodeRoot: '/red-nodes', | |
/** The following property can be used to configure cross-origin resource sharing | |
* in the HTTP nodes. | |
* See https://github.com/troygoode/node-cors#configuration-options for | |
* details on its contents. The following is a basic permissive set of options: | |
*/ | |
//httpNodeCors: { | |
// origin: "*", | |
// methods: "GET,PUT,POST,DELETE" | |
//}, | |
/** If you need to set an http proxy please set an environment variable | |
* called http_proxy (or HTTP_PROXY) outside of Node-RED in the operating system. | |
* For example - http_proxy=http://myproxy.com:8080 | |
* (Setting it here will have no effect) | |
* You may also specify no_proxy (or NO_PROXY) to supply a comma separated | |
* list of domains to not proxy, eg - no_proxy=.acme.co,.acme.co.uk | |
*/ | |
/** The following property can be used to add a custom middleware function | |
* in front of all http in nodes. This allows custom authentication to be | |
* applied to all http in nodes, or any other sort of common request processing. | |
* It can be a single function or an array of middleware functions. | |
*/ | |
//httpNodeMiddleware: function(req,res,next) { | |
// // Handle/reject the request, or pass it on to the http in node by calling next(); | |
// // Optionally skip our rawBodyParser by setting this to true; | |
// //req.skipRawBodyParser = true; | |
// next(); | |
//}, | |
/** When httpAdminRoot is used to move the UI to a different root path, the | |
* following property can be used to identify a directory of static content | |
* that should be served at http://localhost:1880/. | |
*/ | |
//httpStatic: '/home/nol/node-red-static/', | |
/** | |
* Like httpStatic but supports multi paths | |
*/ | |
//httpStatics: ['./projects/foo/assets/','./projects/bar/assets/'], | |
/******************************************************************************* | |
* Runtime Settings | |
* - lang | |
* - logging | |
* - contextStorage | |
* - exportGlobalContextKeys | |
* - externalModules | |
******************************************************************************/ | |
/** Uncomment the following to run node-red in your preferred language. | |
* Available languages include: en-US (default), ja, de, zh-CN, zh-TW, ru, ko | |
* Some languages are more complete than others. | |
*/ | |
// lang: "de", | |
/** Configure the logging output */ | |
logging: { | |
/** Only console logging is currently supported */ | |
console: { | |
/** Level of logging to be recorded. Options are: | |
* fatal - only those errors which make the application unusable should be recorded | |
* error - record errors which are deemed fatal for a particular request + fatal errors | |
* warn - record problems which are non fatal + errors + fatal errors | |
* info - record information about the general running of the application + warn + error + fatal errors | |
* debug - record information which is more verbose than info + info + warn + error + fatal errors | |
* trace - record very detailed logging + debug + info + warn + error + fatal errors | |
* off - turn off all logging (doesn't affect metrics or audit) | |
*/ | |
level: "info", | |
/** Whether or not to include metric events in the log output */ | |
metrics: false, | |
/** Whether or not to include audit events in the log output */ | |
audit: false | |
} | |
}, | |
/** Context Storage | |
* The following property can be used to enable context storage. The configuration | |
* provided here will enable file-based context that flushes to disk every 30 seconds. | |
* Refer to the documentation for further options: https://nodered.org/docs/api/context/ | |
*/ | |
//contextStorage: { | |
// default: { | |
// module:"localfilesystem" | |
// }, | |
//}, | |
/** `global.keys()` returns a list of all properties set in global context. | |
* This allows them to be displayed in the Context Sidebar within the editor. | |
* In some circumstances it is not desirable to expose them to the editor. The | |
* following property can be used to hide any property set in `functionGlobalContext` | |
* from being list by `global.keys()`. | |
* By default, the property is set to false to avoid accidental exposure of | |
* their values. Setting this to true will cause the keys to be listed. | |
*/ | |
exportGlobalContextKeys: false, | |
/** Configure how the runtime will handle external npm modules. | |
* This covers: | |
* - whether the editor will allow new node modules to be installed | |
* - whether nodes, such as the Function node are allowed to have their | |
* own dynamically configured dependencies. | |
* The allow/denyList options can be used to limit what modules the runtime | |
* will install/load. It can use '*' as a wildcard that matches anything. | |
*/ | |
externalModules: { | |
// autoInstall: false, /** Whether the runtime will attempt to automatically install missing modules */ | |
// autoInstallRetry: 30, /** Interval, in seconds, between reinstall attempts */ | |
// palette: { /** Configuration for the Palette Manager */ | |
// allowInstall: true, /** Enable the Palette Manager in the editor */ | |
// allowUpdate: true, /** Allow modules to be updated in the Palette Manager */ | |
// allowUpload: true, /** Allow module tgz files to be uploaded and installed */ | |
// allowList: ['*'], | |
// denyList: [], | |
// allowUpdateList: ['*'], | |
// denyUpdateList: [] | |
// }, | |
// modules: { /** Configuration for node-specified modules */ | |
// allowInstall: true, | |
// allowList: [], | |
// denyList: [] | |
// } | |
}, | |
/******************************************************************************* | |
* Editor Settings | |
* - disableEditor | |
* - editorTheme | |
******************************************************************************/ | |
/** The following property can be used to disable the editor. The admin API | |
* is not affected by this option. To disable both the editor and the admin | |
* API, use either the httpRoot or httpAdminRoot properties | |
*/ | |
//disableEditor: false, | |
/** Customising the editor | |
* See https://nodered.org/docs/user-guide/runtime/configuration#editor-themes | |
* for all available options. | |
*/ | |
editorTheme: { | |
/** The following property can be used to set a custom theme for the editor. | |
* See https://github.com/node-red-contrib-themes/theme-collection for | |
* a collection of themes to chose from. | |
*/ | |
//theme: "", | |
/** To disable the 'Welcome to Node-RED' tour that is displayed the first | |
* time you access the editor for each release of Node-RED, set this to false | |
*/ | |
//tours: false, | |
palette: { | |
/** The following property can be used to order the categories in the editor | |
* palette. If a node's category is not in the list, the category will get | |
* added to the end of the palette. | |
* If not set, the following default order is used: | |
*/ | |
//categories: ['subflows', 'common', 'function', 'network', 'sequence', 'parser', 'storage'], | |
}, | |
projects: { | |
/** To enable the Projects feature, set this value to true */ | |
enabled: false, | |
workflow: { | |
/** Set the default projects workflow mode. | |
* - manual - you must manually commit changes | |
* - auto - changes are automatically committed | |
* This can be overridden per-user from the 'Git config' | |
* section of 'User Settings' within the editor | |
*/ | |
mode: "manual" | |
} | |
}, | |
codeEditor: { | |
/** Select the text editor component used by the editor. | |
* Defaults to "ace", but can be set to "ace" or "monaco" | |
*/ | |
lib: "ace", | |
options: { | |
/** The follow options only apply if the editor is set to "monaco" | |
* | |
* theme - must match the file name of a theme in | |
* packages/node_modules/@node-red/editor-client/src/vendor/monaco/dist/theme | |
* e.g. "tomorrow-night", "upstream-sunburst", "github", "my-theme" | |
*/ | |
theme: "vs", | |
/** other overrides can be set e.g. fontSize, fontFamily, fontLigatures etc. | |
* for the full list, see https://microsoft.github.io/monaco-editor/api/interfaces/monaco.editor.istandaloneeditorconstructionoptions.html | |
*/ | |
//fontSize: 14, | |
//fontFamily: "Cascadia Code, Fira Code, Consolas, 'Courier New', monospace", | |
//fontLigatures: true, | |
} | |
} | |
}, | |
/******************************************************************************* | |
* Node Settings | |
* - fileWorkingDirectory | |
* - functionGlobalContext | |
* - functionExternalModules | |
* - nodeMessageBufferMaxLength | |
* - ui (for use with Node-RED Dashboard) | |
* - debugUseColors | |
* - debugMaxLength | |
* - execMaxBufferSize | |
* - httpRequestTimeout | |
* - mqttReconnectTime | |
* - serialReconnectTime | |
* - socketReconnectTime | |
* - socketTimeout | |
* - tcpMsgQueueSize | |
* - inboundWebSocketTimeout | |
* - tlsConfigDisableLocalFiles | |
* - webSocketNodeVerifyClient | |
******************************************************************************/ | |
/** The working directory to handle relative file paths from within the File nodes | |
* defaults to the working directory of the Node-RED process. | |
*/ | |
//fileWorkingDirectory: "", | |
/** Allow the Function node to load additional npm modules directly */ | |
functionExternalModules: true, | |
/** The following property can be used to set predefined values in Global Context. | |
* This allows extra node modules to be made available with in Function node. | |
* For example, the following: | |
* functionGlobalContext: { os:require('os') } | |
* will allow the `os` module to be accessed in a Function node using: | |
* global.get("os") | |
*/ | |
functionGlobalContext: { | |
// os:require('os'), | |
}, | |
/** The maximum number of messages nodes will buffer internally as part of their | |
* operation. This applies across a range of nodes that operate on message sequences. | |
* defaults to no limit. A value of 0 also means no limit is applied. | |
*/ | |
//nodeMessageBufferMaxLength: 0, | |
/** If you installed the optional node-red-dashboard you can set it's path | |
* relative to httpNodeRoot | |
* Other optional properties include | |
* readOnly:{boolean}, | |
* middleware:{function or array}, (req,res,next) - http middleware | |
* ioMiddleware:{function or array}, (socket,next) - socket.io middleware | |
*/ | |
//ui: { path: "ui" }, | |
/** Colourise the console output of the debug node */ | |
//debugUseColors: true, | |
/** The maximum length, in characters, of any message sent to the debug sidebar tab */ | |
debugMaxLength: 1000, | |
/** Maximum buffer size for the exec node. Defaults to 10Mb */ | |
//execMaxBufferSize: 10000000, | |
/** Timeout in milliseconds for HTTP request connections. Defaults to 120s */ | |
//httpRequestTimeout: 120000, | |
/** Retry time in milliseconds for MQTT connections */ | |
mqttReconnectTime: 15000, | |
/** Retry time in milliseconds for Serial port connections */ | |
serialReconnectTime: 15000, | |
/** Retry time in milliseconds for TCP socket connections */ | |
//socketReconnectTime: 10000, | |
/** Timeout in milliseconds for TCP server socket connections. Defaults to no timeout */ | |
//socketTimeout: 120000, | |
/** Maximum number of messages to wait in queue while attempting to connect to TCP socket | |
* defaults to 1000 | |
*/ | |
//tcpMsgQueueSize: 2000, | |
/** Timeout in milliseconds for inbound WebSocket connections that do not | |
* match any configured node. Defaults to 5000 | |
*/ | |
//inboundWebSocketTimeout: 5000, | |
/** To disable the option for using local files for storing keys and | |
* certificates in the TLS configuration node, set this to true. | |
*/ | |
//tlsConfigDisableLocalFiles: true, | |
/** The following property can be used to verify websocket connection attempts. | |
* This allows, for example, the HTTP request headers to be checked to ensure | |
* they include valid authentication information. | |
*/ | |
//webSocketNodeVerifyClient: function(info) { | |
// /** 'info' has three properties: | |
// * - origin : the value in the Origin header | |
// * - req : the HTTP request | |
// * - secure : true if req.connection.authorized or req.connection.encrypted is set | |
// * | |
// * The function should return true if the connection should be accepted, false otherwise. | |
// * | |
// * Alternatively, if this function is defined to accept a second argument, callback, | |
// * it can be used to verify the client asynchronously. | |
// * The callback takes three arguments: | |
// * - result : boolean, whether to accept the connection or not | |
// * - code : if result is false, the HTTP error status to return | |
// * - reason: if result is false, the HTTP reason string to return | |
// */ | |
//}, | |
} | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment