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

mention credentials

Dave Conway-Jones 2018-04-02 10:35:26 +01:00
parent 6d585ffec0
commit 179f3d9c0f
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Design:-Runnable-Project.md

@ -14,7 +14,7 @@ It should be possible to deploy a project without using the editor. For example:
We can't quite do this today. Here are the missing pieces: We can't quite do this today. Here are the missing pieces:
1. the project's `package.json` needs to list `node-red` as a dependency. On balance, I think this is the right approach, rather than treat node-red as an assumed prerequisite. I don't think we should do this be default; maybe add a checkbox in the project settings' dependencies page to include `node-red`. 1. the project's `package.json` needs to list `node-red` as a dependency. On balance, I think this is the right approach, rather than treat node-red as an assumed prerequisite. I don't think we should do this be default; maybe add a checkbox in the project settings' dependencies page to include `node-red`.
> DCJ: Yes - agree it should be a dependency. > DCJ: Yes - agree it should be a dependency. Currently not hard to add manually, but could be even easier.
2. it must be possible to point node-red at a project on start-up, without using the editor to do so. Currently we overload the flowFile argument to set the active project - but that only works if the project is 'known'. It would be better to point at a `projectDir` wherever it may exist. 2. it must be possible to point node-red at a project on start-up, without using the editor to do so. Currently we overload the flowFile argument to set the active project - but that only works if the project is 'known'. It would be better to point at a `projectDir` wherever it may exist.
> DCJ: Are we pointing Node-RED or npm start ? Which are we calling to run it ? If npm start then don't we already have to be in the correct project directory ? (or use npm start --prefix projdir) > DCJ: Are we pointing Node-RED or npm start ? Which are we calling to run it ? If npm start then don't we already have to be in the correct project directory ? (or use npm start --prefix projdir)
3. it must be possible to provide the credentialSecret for the project without it being part of any of the version controlled files. Options for this include: 3. it must be possible to provide the credentialSecret for the project without it being part of any of the version controlled files. Options for this include:
@ -36,11 +36,17 @@ It could also provide a `bin` section that could allow starting via command line
When deploying the project, there will also be a need to have the runtime settings provided. These are not normally part of a project generated by Node-RED. The question is whether we have some tooling support to generate, or we just document how to do it. For example, the user would manually add a `settings.js` file to their project repo. When deploying the project, there will also be a need to have the runtime settings provided. These are not normally part of a project generated by Node-RED. The question is whether we have some tooling support to generate, or we just document how to do it. For example, the user would manually add a `settings.js` file to their project repo.
> DCJ: If we have the "add node-red as a dependency" checkbox - could it not also... "copy default settings.js into project" ? (but ensuring flowFile doesn't clash) > DCJ: If we have the "add node-red as a dependency" checkbox - could it not also... "copy default settings.js into project" ? (but ensuring flowFile doesn't clash)
### Credentials
When deploying a project, it may also need to have credentials provided. Normally when exporting flows we don't include credentials. By default everything in the projects folder including credentials will be included. How do we make it obvious to people they could be copying credentials externally ? Do we also include *cred.json in .gitignore/.npmignore by default ?
### Dockerfile ### Dockerfile
We should also have an example Dockerfile that can be used to build and run a project. We should also have an example Dockerfile that can be used to build and run a project.
> DCJ: Here is an example that works with resin.io - note that the flow file is set using the start command in package.json, and it needs node red as a dependency) > DCJ: Here is an example *Dockerfile.template* that works with resin.io - note that the flow file is set using the start command in package.json, and it needs node red as a dependency)
"scripts": {"start": "node node_modules/node-red/red.js flow.json"}, "scripts": {"start": "node node_modules/node-red/red.js flow.json"},