├── flows_cred.json ├── README.md ├── package.json ├── flows.json ├── .gitignore ├── Dockerfile ├── server.js ├── LICENSE └── settings.js /flows_cred.json: -------------------------------------------------------------------------------- 1 | {} -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Node-RED-Docker 2 | 3 | Template project for running Node-RED in Docker 4 | 5 | This template project is used in part 5 of the [More Node-RED workshop](https://github.com/binnes/moreNodeRedWorkshop) 6 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "more-node-red", 3 | "description": "A Node-RED Project", 4 | "version": "0.0.1", 5 | "dependencies": { 6 | "@cloudnative/health-connect": "^2.0.0", 7 | "express": "4.17.1", 8 | "node-red": "^1.0.0", 9 | "node-red-dashboard" : "^2.16.3" 10 | }, 11 | "devDependencies": { 12 | "chai": "^4.2.0", 13 | "mocha": "~6.1.0", 14 | "request": "^2.88.0" 15 | }, 16 | "node-red": { 17 | "settings": { 18 | "flowFile": "flows.json", 19 | "credentialsFile": "flows_cred.json" 20 | } 21 | } 22 | } -------------------------------------------------------------------------------- /flows.json: -------------------------------------------------------------------------------- 1 | [{"id":"3af82246.3634ae","type":"tab","label":"Flow 1","disabled":false,"info":""},{"id":"bc5230a9.52453","type":"inject","z":"3af82246.3634ae","name":"","topic":"","payload":"Gobble Gobble","payloadType":"str","repeat":"","crontab":"","once":false,"onceDelay":0.1,"x":160,"y":120,"wires":[["c2d107be.0004f8"]]},{"id":"c2d107be.0004f8","type":"debug","z":"3af82246.3634ae","name":"","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"false","x":350,"y":120,"wires":[]},{"id":"4f4ccaa6.dbfe8c","type":"http in","z":"3af82246.3634ae","name":"","url":"/hello","method":"get","upload":false,"swaggerDoc":"","x":120,"y":200,"wires":[["94dc4412.c5d6d8"]]},{"id":"479c09f3.ab53f8","type":"http response","z":"3af82246.3634ae","name":"","statusCode":"","headers":{},"x":460,"y":200,"wires":[]},{"id":"94dc4412.c5d6d8","type":"change","z":"3af82246.3634ae","name":"","rules":[{"t":"set","p":"payload","pt":"msg","to":"{\"text\":\"Hello\"}","tot":"json"}],"action":"","property":"","from":"","to":"","reg":false,"x":290,"y":200,"wires":[["479c09f3.ab53f8"]]}] -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | 8 | # Runtime data 9 | pids 10 | *.pid 11 | *.seed 12 | *.pid.lock 13 | 14 | # Directory for instrumented libs generated by jscoverage/JSCover 15 | lib-cov 16 | 17 | # Coverage directory used by tools like istanbul 18 | coverage 19 | 20 | # nyc test coverage 21 | .nyc_output 22 | 23 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 24 | .grunt 25 | 26 | # Bower dependency directory (https://bower.io/) 27 | bower_components 28 | 29 | # node-waf configuration 30 | .lock-wscript 31 | 32 | # Compiled binary addons (https://nodejs.org/api/addons.html) 33 | build/Release 34 | 35 | # Dependency directories 36 | node_modules/ 37 | jspm_packages/ 38 | 39 | # TypeScript v1 declaration files 40 | typings/ 41 | 42 | # Optional npm cache directory 43 | .npm 44 | 45 | # Optional eslint cache 46 | .eslintcache 47 | 48 | # Optional REPL history 49 | .node_repl_history 50 | 51 | # Output of 'npm pack' 52 | *.tgz 53 | 54 | # Yarn Integrity file 55 | .yarn-integrity 56 | 57 | # dotenv environment variables file 58 | .env 59 | 60 | # next.js build output 61 | .next 62 | 63 | # VSCode 64 | *.code-workspace 65 | .vscode 66 | 67 | # MacOS system index files 68 | .DS_Store 69 | 70 | package-lock.json 71 | node_modules -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM node:lts as build 2 | 3 | RUN apt-get update \ 4 | && apt-get install -y build-essential python perl-modules 5 | 6 | RUN deluser --remove-home node \ 7 | && groupadd --gid 1000 nodered \ 8 | && useradd --gid nodered --uid 1000 --shell /bin/bash --create-home nodered 9 | 10 | USER 1000 11 | 12 | RUN mkdir -p /home/nodered/.node-red 13 | 14 | WORKDIR /home/nodered/.node-red 15 | 16 | COPY ./package.json /home/nodered/.node-red/ 17 | RUN npm install 18 | 19 | ## Release image 20 | FROM node:lts-slim 21 | 22 | RUN apt-get update && apt-get install -y perl-modules 23 | 24 | RUN deluser --remove-home node \ 25 | && groupadd --gid 1000 nodered \ 26 | && useradd --gid nodered --uid 1000 --shell /bin/bash --create-home nodered 27 | 28 | USER 1000 29 | 30 | RUN mkdir -p /home/nodered/.node-red 31 | 32 | WORKDIR /home/nodered/.node-red 33 | 34 | COPY ./server.js /home/nodered/.node-red/ 35 | COPY ./settings.js /home/nodered/.node-red/ 36 | COPY ./flows.json /home/nodered/.node-red/ 37 | COPY ./flows_cred.json /home/nodered/.node-red/ 38 | COPY ./package.json /home/nodered/.node-red/ 39 | COPY --from=build /home/nodered/.node-red/node_modules /home/nodered/.node-red/node_modules 40 | 41 | USER 0 42 | 43 | RUN chgrp -R 0 /home/nodered/.node-red \ 44 | && chmod -R g=u /home/nodered/.node-red 45 | 46 | USER 1000 47 | 48 | ENV PORT 1880 49 | ENV NODE_ENV=production 50 | ENV NODE_PATH=/home/nodered/.nodered/node_modules 51 | EXPOSE 1880 52 | 53 | CMD ["node", "/home/nodered/.node-red/server.js", "/home/nodered/.node-red/flows.json"] 54 | -------------------------------------------------------------------------------- /server.js: -------------------------------------------------------------------------------- 1 | // Requires statements and code for non-production mode usage 2 | // if (!process.env.NODE_ENV || !process.env.NODE_ENV === 'production') { 3 | // require('appmetrics-dash').attach(); 4 | //} 5 | 6 | var http = require('http'); 7 | var https = require('https'); 8 | var util = require("util"); 9 | var express = require("express"); 10 | var crypto = require("crypto"); 11 | try { bcrypt = require('bcrypt'); } 12 | catch(e) { bcrypt = require('bcryptjs'); } 13 | var nopt = require("nopt"); 14 | var path = require("path"); 15 | var fs = require("fs-extra"); 16 | var RED = require("node-red"); 17 | var health = require('@cloudnative/health-connect'); 18 | 19 | 20 | // Create an Express app 21 | var server; 22 | var app = express(); 23 | 24 | process.env.NODE_RED_HOME = __dirname; 25 | 26 | // Add a simple route for static content served from 'public' 27 | app.use("/",express.static("public")); 28 | 29 | var healthcheck = new health.HealthChecker(); 30 | app.use('/live', health.LivenessEndpoint(healthcheck)); 31 | app.use('/ready', health.ReadinessEndpoint(healthcheck)); 32 | app.use('/health', health.HealthEndpoint(healthcheck)); 33 | 34 | // Create the settings object from file 35 | var settings = require("./settings.js"); 36 | var fs = require("fs"); 37 | 38 | if (process.env.NODE_RED_TLS_CERT && process.env.NODE_RED_TLS_KEY) { 39 | settings.https = { 40 | "key" : fs.readFileSync(process.env.NODE_RED_TLS_KEY), 41 | "cert" : fs.readFileSync(process.env.NODE_RED_TLS_CERT) 42 | }; 43 | if (process.env.NODE_RED_TLS_CA) { 44 | settings.https.ca = fs.readFileSync(process.env.NODE_RED_TLS_CA); 45 | } 46 | if (process.env.NODE_RED_TLS_PASS_FILE) { 47 | settings.https.passphrase = fs.readFileSync(process.env.NODE_RED_TLS_PASS_FILE); 48 | } else if (process.env.NODE_RED_TLS_PASS_ENV) { 49 | settings.https.passphrase = process.env.NODE_RED_TLS_PASS_ENV; 50 | } 51 | settings.requireHttps = true; 52 | } 53 | 54 | if (settings.https) { 55 | server = https.createServer(settings.https,function(req,res) {app(req,res);}); 56 | } else { 57 | server = http.createServer(function(req,res) {app(req,res);}); 58 | } 59 | server.setMaxListeners(0); 60 | 61 | function formatRoot(root) { 62 | if (root[0] != "/") { 63 | root = "/" + root; 64 | } 65 | if (root.slice(-1) != "/") { 66 | root = root + "/"; 67 | } 68 | return root; 69 | } 70 | 71 | if (settings.httpRoot === false) { 72 | settings.httpAdminRoot = false; 73 | settings.httpNodeRoot = false; 74 | } else { 75 | settings.httpRoot = settings.httpRoot||"/"; 76 | settings.disableEditor = settings.disableEditor||false; 77 | } 78 | 79 | if (settings.httpAdminRoot !== false) { 80 | settings.httpAdminRoot = formatRoot(settings.httpAdminRoot || settings.httpRoot || "/"); 81 | settings.httpAdminAuth = settings.httpAdminAuth || settings.httpAuth; 82 | } else { 83 | settings.disableEditor = true; 84 | } 85 | 86 | if (settings.httpNodeRoot !== false) { 87 | settings.httpNodeRoot = formatRoot(settings.httpNodeRoot || settings.httpRoot || "/"); 88 | settings.httpNodeAuth = settings.httpNodeAuth || settings.httpAuth; 89 | } 90 | 91 | if (settings.uiPort === undefined){ 92 | settings.uiPort = 1880; 93 | } 94 | 95 | 96 | settings.uiHost = settings.uiHost||"0.0.0.0"; 97 | 98 | // Initialise the runtime with a server and settings 99 | RED.init(server,settings); 100 | 101 | // Serve the editor UI from /red 102 | app.use(settings.httpAdminRoot,RED.httpAdmin); 103 | 104 | // Serve the http nodes UI from /api 105 | app.use(settings.httpNodeRoot,RED.httpNode); 106 | 107 | server.listen(settings.uiPort); 108 | 109 | // Start the runtime 110 | RED.start(); -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /settings.js: -------------------------------------------------------------------------------- 1 | /** 2 | * Copyright JS Foundation and other contributors, http://js.foundation 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | **/ 16 | 17 | // The `https` setting requires the `fs` module. Uncomment the following 18 | // to make it available: 19 | //var fs = require("fs"); 20 | 21 | module.exports = { 22 | // the tcp port that the Node-RED web server is listening on 23 | uiPort: process.env.PORT || 1880, 24 | 25 | // By default, the Node-RED UI accepts connections on all IPv4 interfaces. 26 | // To listen on all IPv6 addresses, set uiHost to "::", 27 | // The following property can be used to listen on a specific interface. For 28 | // example, the following would only allow connections from the local machine. 29 | //uiHost: "127.0.0.1", 30 | 31 | // Retry time in milliseconds for MQTT connections 32 | mqttReconnectTime: 15000, 33 | 34 | // Retry time in milliseconds for Serial port connections 35 | serialReconnectTime: 15000, 36 | 37 | // Retry time in milliseconds for TCP socket connections 38 | //socketReconnectTime: 10000, 39 | 40 | // Timeout in milliseconds for TCP server socket connections 41 | // defaults to no timeout 42 | //socketTimeout: 120000, 43 | 44 | // Maximum number of messages to wait in queue while attempting to connect to TCP socket 45 | // defaults to 1000 46 | //tcpMsgQueueSize: 2000, 47 | 48 | // Timeout in milliseconds for HTTP request connections 49 | // defaults to 120 seconds 50 | //httpRequestTimeout: 120000, 51 | 52 | // The maximum length, in characters, of any message sent to the debug sidebar tab 53 | debugMaxLength: 1000, 54 | 55 | // The maximum number of messages nodes will buffer internally as part of their 56 | // operation. This applies across a range of nodes that operate on message sequences. 57 | // defaults to no limit. A value of 0 also means no limit is applied. 58 | //nodeMaxMessageBufferLength: 0, 59 | 60 | // To disable the option for using local files for storing keys and certificates in the TLS configuration 61 | // node, set this to true 62 | //tlsConfigDisableLocalFiles: true, 63 | 64 | // Colourise the console output of the debug node 65 | //debugUseColors: true, 66 | 67 | // The file containing the flows. If not set, it defaults to flows_.json 68 | flowFile: 'flows.json', 69 | 70 | // To enabled pretty-printing of the flow within the flow file, set the following 71 | // property to true: 72 | //flowFilePretty: true, 73 | 74 | // By default, credentials are encrypted in storage using a generated key. To 75 | // specify your own secret, set the following property. 76 | // If you want to disable encryption of credentials, set this property to false. 77 | // Note: once you set this property, do not change it - doing so will prevent 78 | // node-red from being able to decrypt your existing credentials and they will be 79 | // lost. 80 | credentialSecret: false, 81 | 82 | // By default, all user data is stored in a directory called `.node-red` under 83 | // the user's home directory. To use a different location, the following 84 | // property can be used 85 | userDir: '/home/nodered/.node-red/', 86 | 87 | // Node-RED scans the `nodes` directory in the userDir to find local node files. 88 | // The following property can be used to specify an additional directory to scan. 89 | nodesDir: '/home/nodered/.node-red/nodes', 90 | 91 | // By default, the Node-RED UI is available at http://localhost:1880/ 92 | // The following property can be used to specify a different root path. 93 | // If set to false, this is disabled. 94 | //httpAdminRoot: false, 95 | httpAdminRoot: "/admin", 96 | 97 | // Some nodes, such as HTTP In, can be used to listen for incoming http requests. 98 | // By default, these are served relative to '/'. The following property 99 | // can be used to specify a different root path. If set to false, this is 100 | // disabled. 101 | httpNodeRoot: '/', 102 | 103 | // The following property can be used in place of 'httpAdminRoot' and 'httpNodeRoot', 104 | // to apply the same root to both parts. 105 | //httpRoot: '/red', 106 | 107 | // When httpAdminRoot is used to move the UI to a different root path, the 108 | // following property can be used to identify a directory of static content 109 | // that should be served at http://localhost:1880/. 110 | httpStatic: '/', 111 | 112 | // The maximum size of HTTP request that will be accepted by the runtime api. 113 | // Default: 5mb 114 | //apiMaxLength: '5mb', 115 | 116 | // If you installed the optional node-red-dashboard you can set it's path 117 | // relative to httpRoot 118 | ui: { path: "ui" }, 119 | 120 | // Securing Node-RED 121 | // ----------------- 122 | // To password protect the Node-RED editor and admin API, the following 123 | // property can be used. See http://nodered.org/docs/security.html for details. 124 | //adminAuth: { 125 | // type: "credentials", 126 | // users: [{ 127 | // username: "admin", 128 | // password: "$2a$08$zZWtXTja0fB1pzD4sHCMyOCMYz2Z6dNbM6tl8sJogENOMcxWV9DN.", 129 | // permissions: "*" 130 | // }] 131 | //}, 132 | 133 | // To password protect the node-defined HTTP endpoints (httpNodeRoot), or 134 | // the static content (httpStatic), the following properties can be used. 135 | // The pass field is a bcrypt hash of the password. 136 | // See http://nodered.org/docs/security.html#generating-the-password-hash 137 | //httpNodeAuth: {user:"user",pass:"$2a$08$zZWtXTja0fB1pzD4sHCMyOCMYz2Z6dNbM6tl8sJogENOMcxWV9DN."}, 138 | //httpStaticAuth: {user:"user",pass:"$2a$08$zZWtXTja0fB1pzD4sHCMyOCMYz2Z6dNbM6tl8sJogENOMcxWV9DN."}, 139 | 140 | // The following property can be used to enable HTTPS 141 | // See http://nodejs.org/api/https.html#https_https_createserver_options_requestlistener 142 | // for details on its contents. 143 | // See the comment at the top of this file on how to load the `fs` module used by 144 | // this setting. 145 | // 146 | //https: { 147 | // key: fs.readFileSync('privatekey.pem'), 148 | // cert: fs.readFileSync('certificate.pem') 149 | //}, 150 | 151 | // The following property can be used to cause insecure HTTP connections to 152 | // be redirected to HTTPS. 153 | //requireHttps: true, 154 | 155 | // The following property can be used to disable the editor. The admin API 156 | // is not affected by this option. To disable both the editor and the admin 157 | // API, use either the httpRoot or httpAdminRoot properties 158 | //disableEditor: false, 159 | 160 | // The following property can be used to configure cross-origin resource sharing 161 | // in the HTTP nodes. 162 | // See https://github.com/troygoode/node-cors#configuration-options for 163 | // details on its contents. The following is a basic permissive set of options: 164 | //httpNodeCors: { 165 | // origin: "*", 166 | // methods: "GET,PUT,POST,DELETE" 167 | //}, 168 | 169 | // If you need to set an http proxy please set an environment variable 170 | // called http_proxy (or HTTP_PROXY) outside of Node-RED in the operating system. 171 | // For example - http_proxy=http://myproxy.com:8080 172 | // (Setting it here will have no effect) 173 | // You may also specify no_proxy (or NO_PROXY) to supply a comma separated 174 | // list of domains to not proxy, eg - no_proxy=.acme.co,.acme.co.uk 175 | 176 | // The following property can be used to add a custom middleware function 177 | // in front of all http in nodes. This allows custom authentication to be 178 | // applied to all http in nodes, or any other sort of common request processing. 179 | //httpNodeMiddleware: function(req,res,next) { 180 | // // Handle/reject the request, or pass it on to the http in node by calling next(); 181 | // // Optionally skip our rawBodyParser by setting this to true; 182 | // //req.skipRawBodyParser = true; 183 | // next(); 184 | //}, 185 | 186 | // The following property can be used to pass custom options to the Express.js 187 | // server used by Node-RED. For a full list of available options, refer 188 | // to http://expressjs.com/en/api.html#app.settings.table 189 | //httpServerOptions: { }, 190 | 191 | // The following property can be used to verify websocket connection attempts. 192 | // This allows, for example, the HTTP request headers to be checked to ensure 193 | // they include valid authentication information. 194 | //webSocketNodeVerifyClient: function(info) { 195 | // // 'info' has three properties: 196 | // // - origin : the value in the Origin header 197 | // // - req : the HTTP request 198 | // // - secure : true if req.connection.authorized or req.connection.encrypted is set 199 | // // 200 | // // The function should return true if the connection should be accepted, false otherwise. 201 | // // 202 | // // Alternatively, if this function is defined to accept a second argument, callback, 203 | // // it can be used to verify the client asynchronously. 204 | // // The callback takes three arguments: 205 | // // - result : boolean, whether to accept the connection or not 206 | // // - code : if result is false, the HTTP error status to return 207 | // // - reason: if result is false, the HTTP reason string to return 208 | //}, 209 | 210 | // The following property can be used to seed Global Context with predefined 211 | // values. This allows extra node modules to be made available with the 212 | // Function node. 213 | // For example, 214 | // functionGlobalContext: { os:require('os') } 215 | // can be accessed in a function block as: 216 | // global.get("os") 217 | functionGlobalContext: { 218 | // os:require('os'), 219 | // jfive:require("johnny-five"), 220 | // j5board:require("johnny-five").Board({repl:false}) 221 | }, 222 | // `global.keys()` returns a list of all properties set in global context. 223 | // This allows them to be displayed in the Context Sidebar within the editor. 224 | // In some circumstances it is not desirable to expose them to the editor. The 225 | // following property can be used to hide any property set in `functionGlobalContext` 226 | // from being list by `global.keys()`. 227 | // By default, the property is set to false to avoid accidental exposure of 228 | // their values. Setting this to true will cause the keys to be listed. 229 | exportGlobalContextKeys: false, 230 | 231 | 232 | // Context Storage 233 | // The following property can be used to enable context storage. The configuration 234 | // provided here will enable file-based context that flushes to disk every 30 seconds. 235 | // Refer to the documentation for further options: https://nodered.org/docs/api/context/ 236 | // 237 | //contextStorage: { 238 | // default: { 239 | // module:"localfilesystem" 240 | // }, 241 | //}, 242 | 243 | // The following property can be used to order the categories in the editor 244 | // palette. If a node's category is not in the list, the category will get 245 | // added to the end of the palette. 246 | // If not set, the following default order is used: 247 | //paletteCategories: ['subflows', 'input', 'output', 'function', 'social', 'mobile', 'storage', 'analysis', 'advanced'], 248 | 249 | // Configure the logging output 250 | logging: { 251 | // Only console logging is currently supported 252 | console: { 253 | // Level of logging to be recorded. Options are: 254 | // fatal - only those errors which make the application unusable should be recorded 255 | // error - record errors which are deemed fatal for a particular request + fatal errors 256 | // warn - record problems which are non fatal + errors + fatal errors 257 | // info - record information about the general running of the application + warn + error + fatal errors 258 | // debug - record information which is more verbose than info + info + warn + error + fatal errors 259 | // trace - record very detailed logging + debug + info + warn + error + fatal errors 260 | // off - turn off all logging (doesn't affect metrics or audit) 261 | level: "info", 262 | // Whether or not to include metric events in the log output 263 | metrics: false, 264 | // Whether or not to include audit events in the log output 265 | audit: false 266 | } 267 | }, 268 | 269 | // Customising the editor 270 | editorTheme: { 271 | projects: { 272 | // To enable the Projects feature, set this value to true 273 | enabled: false 274 | } 275 | } 276 | }; 277 | --------------------------------------------------------------------------------