frodovdr/node-red
1
0
Fork 0
mirror of https://github.com/node-red/node-red.git synced 2023-10-10 13:36:53 +02:00
Code Issues Releases Wiki Activity

Restructure default settings.js to be more organised

Browse Source
This commit is contained in:
Nick O'Leary 2021-06-08 15:58:19 +01:00
parent ff5e038c49
commit bcd6e8fd63
No known key found for this signature in database
GPG Key ID: 4F2157149161A6C9
1 changed files with 304 additions and 228 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

454
packages/node_modules/node-red/settings.js vendored
View File

@ -9,74 +9,31 @@
* *
* For more information about individual settings, refer to the documentation: * For more information about individual settings, refer to the documentation:
* https://nodered.org/docs/user-guide/runtime/configuration * 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
*
**/ **/
module.exports = { module.exports = {
// The file containing the flows. If not set, it defaults to flows_<hostname>.json
/*******************************************************************************
* Flow File and User Directory Settings
* - flowFile
* - credentialSecret
* - flowFilePretty
* - userDir
* - nodesDir
******************************************************************************/
// The file containing the flows. Defaults to flows_<hostname>.json
flowFile: 'flows.json', flowFile: 'flows.json',
// To enabled pretty-printing of the flow within the flow file, set the following
// property to true:
//flowFilePretty: true,
// 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",
// 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 HTTP request connections
// defaults to 120 seconds
//httpRequestTimeout: 120000,
// Maximum buffer size for the exec node
// defaults to 10Mb
//execMaxBufferSize: 10000000,
// The working directory to handle relative file paths from within the File nodes
// defaults to the working directory of the Node-RED process.
//fileWorkingDirectory: "",
// Timeout in milliseconds for inbound WebSocket connections that do not
// match any configured node.
// defaults to 5000
//inboundWebSocketTimeout: 5000,
// The maximum length, in characters, of any message sent to the debug sidebar tab
debugMaxLength: 1000,
// 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,
// To disable the option for using local files for storing keys and certificates in the TLS configuration
// node, set this to true
//tlsConfigDisableLocalFiles: true,
// Colourise the console output of the debug node
//debugUseColors: true,
// By default, credentials are encrypted in storage using a generated key. To // By default, credentials are encrypted in storage using a generated key. To
// specify your own secret, set the following property. // specify your own secret, set the following property.
// If you want to disable encryption of credentials, set this property to false. // If you want to disable encryption of credentials, set this property to false.
@ -85,6 +42,10 @@ module.exports = {
// lost. // lost.
//credentialSecret: "a-secret-key", //credentialSecret: "a-secret-key",
// To enabled pretty-printing of the flow within the flow file, set the following
// property to true. This makes it easier to compare changes when using version control.
flowFilePretty: true,
// By default, all user data is stored in a directory called `.node-red` under // 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 // the user's home directory. To use a different location, the following
// property can be used // property can be used
@ -94,36 +55,17 @@ module.exports = {
// The following property can be used to specify an additional directory to scan. // The following property can be used to specify an additional directory to scan.
//nodesDir: '/home/nol/.node-red/nodes', //nodesDir: '/home/nol/.node-red/nodes',
// 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',
// 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 * Security
// can be used to specifiy a different root path. If set to false, this is * - adminAuth
// disabled. * - https
//httpNodeRoot: '/red-nodes', * - httpsRefreshInterval
* - requireHttps
* - httpNodeAuth
* - httpStaticAuth
******************************************************************************/
// 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/',
// The maximum size of HTTP request that will be accepted by the runtime api.
// Default: 5mb
//apiMaxLength: '5mb',
// 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" },
// Securing Node-RED
// -----------------
// To password protect the Node-RED editor and admin API, the following // 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. // property can be used. See http://nodered.org/docs/security.html for details.
//adminAuth: { //adminAuth: {
@ -135,24 +77,17 @@ module.exports = {
// }] // }]
//}, //},
// To password protect the node-defined HTTP endpoints (httpNodeRoot), 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."},
// The following property can be used to enable HTTPS // 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 // See http://nodejs.org/api/https.html#https_https_createserver_options_requestlistener
// for details on its contents. // for details of its contents.
// This property can be either an object, containing both a (private) key and a (public) certificate, //// Option 1: static object
// or a function that returns such an object:
//// https object:
//https: { //https: {
// key: require("fs").readFileSync('privkey.pem'), // key: require("fs").readFileSync('privkey.pem'),
// cert: require("fs").readFileSync('cert.pem') // cert: require("fs").readFileSync('cert.pem')
//}, //},
////https function: //// Option 2: function that returns the HTTP configuration object
// https: function() { // https: function() {
// // This function should return the options object, or a Promise // // This function should return the options object, or a Promise
// // that resolves to the options object // // that resolves to the options object
@ -162,22 +97,75 @@ module.exports = {
// } // }
// }, // },
// The following property can be used to refresh the https settings at a // If the `https` setting is a function, the following setting can be used
// regular time interval in hours. // to set how often, in hours, the function will be called. That can be used
// This requires: // to refresh any certificates.
// - the `https` setting to be a function that can be called to get
// the refreshed settings.
// - Node.js 11 or later.
//httpsRefreshInterval : 12, //httpsRefreshInterval : 12,
// The following property can be used to cause insecure HTTP connections to // The following property can be used to cause insecure HTTP connections to
// be redirected to HTTPS. // be redirected to HTTPS.
//requireHttps: true, //requireHttps: true,
// The following property can be used to disable the editor. The admin API // To password protect the node-defined HTTP endpoints (httpNodeRoot), or
// is not affected by this option. To disable both the editor and the admin // the static content (httpStatic), the following properties can be used.
// API, use either the httpRoot or httpAdminRoot properties // The pass field is a bcrypt hash of the password.
//disableEditor: false, // 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 // The following property can be used to configure cross-origin resource sharing
// in the HTTP nodes. // in the HTTP nodes.
@ -206,86 +194,23 @@ module.exports = {
// next(); // 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/',
// 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 * Runtime Settings
// headers. It can be a single function or an array of middleware functions. * - lang
// httpAdminMiddleware: function(req,res,next) { * - logging
// // Set the X-Frame-Options header to limit where the editor * - contextStorage
// // can be embedded * - exportGlobalContextKeys
// //res.set('X-Frame-Options', 'sameorigin'); * - externalModules
// next(); ******************************************************************************/
// },
// 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: { },
// 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
//},
// The following property can be used to seed Global Context with predefined
// values. This allows extra node modules to be made available with the
// Function node.
// For example,
// functionGlobalContext: { os:require('os') }
// can be accessed in a function block as:
// global.get("os")
functionGlobalContext: {
// os:require('os'),
// jfive:require("johnny-five"),
// j5board:require("johnny-five").Board({repl:false})
},
// Allow the Function node to load additional npm modules
functionExternalModules: false,
// `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,
// Uncomment the following to run node-red in your preferred language: // Uncomment the following to run node-red in your preferred language:
// lang: "de", // lang: "de",
// 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"
// },
//},
// 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:
//paletteCategories: ['subflows', 'common', 'function', 'network', 'sequence', 'parser', 'storage'],
// Configure the logging output // Configure the logging output
logging: { logging: {
// Only console logging is currently supported // Only console logging is currently supported
@ -306,6 +231,26 @@ module.exports = {
} }
}, },
// 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. // Configure how the runtime will handle external npm modules.
// This covers: // This covers:
// - whether the editor will allow new node modules to be installed // - whether the editor will allow new node modules to be installed
@ -329,8 +274,29 @@ module.exports = {
// } // }
}, },
/*******************************************************************************
* 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 // Customising the editor
// See https://nodered.org/docs/user-guide/runtime/configuration#editor-themes
// for all available options.
editorTheme: { editorTheme: {
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: { projects: {
// To enable the Projects feature, set this value to true // To enable the Projects feature, set this value to true
enabled: false, enabled: false,
@ -359,6 +325,116 @@ module.exports = {
//fontFamily: "Cascadia Code, Fira Code, Consolas, 'Courier New', monospace" //fontFamily: "Cascadia Code, Fira Code, Consolas, 'Courier New', monospace"
//fontLigatures: true, //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: "",
// 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'),
},
// Allow the Function node to load additional npm modules
functionExternalModules: false,
// 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 120 seconds
//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
//},
} }