Getting error while running with custom settings.js file


I am facing issue with the setting.js file. I cloned a project from git. when i am running node-red server with "node-red" command it is automatically picking up default settings.js file from ~\Users\thakusu.node-red.

25 Feb 12:05:16 - [info] Settings file : C:\Users\thakusu.node-red\settings.js this works fine with deffault settings.

but when I am running with my project settings file getting error.

C:\Users\thakusu\Desktop\Ruby_Project\NodeRed>node-red -s rubysettings.js Error loading settings file: C:\Users\thakusu\Desktop\Ruby_Project\NodeRed\rubysettings.js

And where to check error for the setting files.

can anyone please help me in this issue, as i am new to node-red.
And additionally how to setup node-red project and directly running from vs-code.


  • Does rubysettings.js exist in C:\Users\thakusu\Desktop\Ruby_Project\NodeRed\?
  • Does the account you run node-red with have access to user thakusu desktop folder?

impossible to help if you dont provide a copy of your custom settings.js file.

If you are running node-red from source...

Open the project folder then

  1. VSCODE: Modify launch.json ...
     "version": "0.2.0",
     "configurations": [
            "type": "node",
            "request": "launch",
            "name": "Launch Program",
            "skipFiles": [
            "env": { "NODE_ENV": "development" },
            "preLaunchTask": "npm: build-dev",
            "program": "${workspaceFolder}\\packages\\node_modules\\node-red\\red.js"
  1. VSCODE: Add an entry in tasks.json
    "version": "2.0.0",
    "tasks": [
			"type": "npm",
			"script": "build-dev",
			"group": "build",
			"problemMatcher": [],
			"label": "npm: build-dev",
			"detail": "build-dev"
  1. Press F5 to start debugging

If you are running from NPM Installed node-red...

see How to proper debug custom node - #13 by Steve-Mcl

Thanks Steve,

  • Does rubysettings.js exist in C:\Users\thakusu\Desktop\Ruby_Project\NodeRed\ ---> Yes this exist
  • Does the account you run node-red with have access to user thakusu desktop folder----> Yes have access

and my rubysettings.js file


 * Copyright JS Foundation and other contributors,


 * 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




 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,


 * See the License for the specific language governing permissions and

 * limitations under the License.


// The `https` setting requires the `fs` module. Uncomment the following

// to make it available:

//var fs = require("fs");

module.exports = {

    // 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.

    // 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: "::",

    // 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,

    // Timeout in milliseconds for HTTP request connections

    //  defaults to 120 seconds

    //httpRequestTimeout: 120000,

    // The maximum length, in characters, of any message sent to the debug sidebar tab

    debugMaxLength: 1000,

    // 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,

    // The file containing the flows. If not set, it defaults to flows_<hostname>.json

    //flowFile: 'flows.json',

    // To enabled pretty-printing of the flow within the flow file, set the following

    //  property to true:

    //flowFilePretty: true,

    // 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: "isp6",

    // By default, all user data is stored in the Node-RED install 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 install directory to find nodes.

    // The following property can be used to specify an additional directory to scan.

    //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

    // 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 in place of 'httpAdminRoot' and 'httpNodeRoot',

    // to apply the same root to both parts.

    httpRoot: 'node-red',

    // 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 httpRoot

    ui: { path: "ui" },

    // Securing Node-RED

    // -----------------

    // To password protect the Node-RED editor and admin API, the following

    // property can be used. See for details.

    adminAuth: {


        strategy: {

            name: "keycloak",

            label: 'Sign in',

            icon:"fas fa-user-secret",

            strategy: require('passport-keycloak-oauth2-oidc').Strategy,

            options: {

                authServerURL: 'https://' + process.env.ISP_HOSTNAME + '/auth',

                clientID: "isp",

                clientSecret: "isp",

                scope: "openid email profile",

                callbackURL: 'https://' + process.env.ISP_HOSTNAME + '/node-red/auth/strategy/callback'


            verify: function(accessToken, refreshToken, profile, done)  {

                if (profile) {

                    return done(null,;


                return done(null, false);



        users: async arg => {

            if (arg) {

                return {

                    username: arg,

                    permissions: ["*"]


            } else {

                return {};




    // 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

    //httpNodeAuth: {user:"user",pass:"$2a$08$zZWtXTja0fB1pzD4sHCMyOCMYz2Z6dNbM6tl8sJogENOMcxWV9DN."},

    //httpStaticAuth: {user:"user",pass:"$2a$08$zZWtXTja0fB1pzD4sHCMyOCMYz2Z6dNbM6tl8sJogENOMcxWV9DN."},

    // The following property can be used to enable HTTPS

    // See

    // for details on its contents.

    // See the comment at the top of this file on how to load the `fs` module used by

    // this setting.


    //https: {

    //    key: fs.readFileSync('privatekey.pem'),

    //    cert: fs.readFileSync('certificate.pem')


    // The following property can be used to cause insecure HTTP connections to

    // be redirected to HTTPS.

    //requireHttps: false,

    // 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,

    // The following property can be used to configure cross-origin resource sharing

    // in the HTTP nodes.

    // See 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=

    // (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 -,

    // 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.

    //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;

        //"http_req_url: " + req.url);



    // 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


    // Anything in this hash is globally available to all functions.

    // It is accessed as

    // eg:

    //    functionGlobalContext: { os:require('os') }

    // can be accessed in a function block as:


    functionGlobalContext: {

        // os:require('os'),

        // octalbonescript:require('octalbonescript'),

        // jfive:require("johnny-five"),

        // j5board:require("johnny-five").Board({repl:false})


    // 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', 'input', 'output', 'function', 'social', 'mobile', 'storage', 'analysis', 'advanced'],

    // 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: "debug",

            // 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: true



    editorTheme: {

        page: {

            title: "RUBY RED",

            //favicon: "/absolute/path/to/theme/icon", //TODO W&H favicon

            //css: "/absolute/path/to/custom/css/file" //TODO Background Color


        header: {

            title: "RUBY RED",

            image: "/usr/src/node-red/logo-wuh.png",


        deployButton: {



            icon: "null"


        projects: {

            enabled: true


        menu: { // Hide unwanted menu items by id. see editor/js/main.js:loadEditor for complete list

            "menu-item-import-library": false,

            "menu-item-export-library": false,

            "menu-item-keyboard-shortcuts": false,

            //"menu-item-help": {

            //    label: "Alternative Help Link Text",

            //    url: ""





And also I tried your launch.json and tasks.json in .vscode, but getting error while running.

Executing task: npm run build-dev <

npm ERR! missing script: build-dev

npm ERR! A complete log of this run can be found in:
npm ERR! C:\Users\thakusu\AppData\Roaming\npm-cache_logs\2021-02-25T09_41_50_119Z-debug.log
The terminal process "C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe -Command npm run build-dev" terminated with exit code: 1.


Well you have something wrong because the NPM script does exist...

Thanks Steve,

Could you please help me in the custom setttings.js file issue mentioned above.


In the file you have this

            options: {
                clientID: "isp",
                clientSecret: "isp",
                scope: "openid email profile",

The comma after "openid email profile", should not be there.

Also in

        header: {
            title: "RUBY RED",
            image: "/usr/src/node-red/logo-wuh.png",


        projects: {
            enabled: true
            "menu-item-import-library": false,
            "menu-item-export-library": false,
            "menu-item-keyboard-shortcuts": false,

the last item should not have a comma after it.

Thanks Zenofmud for you response,

Can you please help me, In running node-red with my custom setting file and if there is problem in setting file than is there any tool to check that. because setting is javascript file which is checked syntactically in vscode itself, we get red line beneath error syntax.

because my node-red is running with default things from ~/.node-red directory like flow, setting.

25 Feb 18:43:13 - [info] Settings file : C:\Users\thakusu.node-red\settings.js
25 Feb 18:43:13 - [info] Context store : 'default' [module=memory]
25 Feb 18:43:13 - [info] User directory : C:\Users\thakusu.node-red
25 Feb 18:43:13 - [warn] No active project : using default flows file
25 Feb 18:43:13 - [info] Flows file : C:\Users\thakusu.node-red\flows_SP10444.json

please help me in setting up and running with my custom setting and flow.


What issue do you currently have? Is node-red running?

Yes, Node-red is perfectly running with default settings and behavior. But I want to run node-red with my projects setting file.

Lets back up a bit

First: How did you initially install Node-RED? What directions did you use?


What did you clone and where on your computer did you clone it to?
Is this a node-red 'project' i.e. using the node-red 'Projects feature'?

Thanks zenofmud,
Yes, I cloned an node red project from gitlab in my system and then I install the node red in my system to run the project. but I came to know that to run any node red project we have to link our ~/.node-red directory, I did that by installing my project at ~/.node-red directory. And then running node-red with command "node-red", so it is taking the ~/node-red setting file only.

1 Mar 15:00:49 - [info] Settings file  : C:\Users\thakusu\.node-red\settings.js
1 Mar 15:00:49 - [info] Context store  : 'default' [module=memory]
1 Mar 15:00:49 - [info] User directory : C:\Users\thakusu\.node-red
1 Mar 15:00:49 - [warn] No active project : using default flows file
1 Mar 15:00:49 - [info] Flows file     : C:\Users\thakusu\.node-red\flows_SP10444.json
1 Mar 15:00:49 - [info] Server now running at

So as I understand it

  1. you have a Node-RED project you cloned before you ever insrtalled Node-RED
  2. You then installed Node-RED
  3. the project is not in the 'projects' folder in the node-RED folder

If this is correct, I would try
a) moving the project into the .node-red/projects folder
b) moving the rubysettings.js file into the .node-red' folder and then start node-red pointing at the rubysettings.js` file