node-red.github.io icon indicating copy to clipboard operation
node-red.github.io copied to clipboard

Adding balena on Getting Started

Open mpous opened this issue 3 years ago • 6 comments

This is the balena Getting Started contribution to enable any user to install Node-RED on Raspberry Pi (e.g.) in just one click running balenaOS and Node-RED on containers.

Feel free to add any comment to this PR.

Change-type: minor Signed-off-by: Marc Pous [email protected]

mpous avatar Nov 01 '21 09:11 mpous

CLA Signed

The committers are authorized under a signed CLA.

  • :white_check_mark: Marc Pous (b1b49e7cf63e59ea193d8c605e7ae7cb97ad1652, cd9e654b90c8ab18735975462f91078f226917d4, 6c0c71e7936a13e1a90fb5a5acaefb526893a503, 68ab1590b3767f9974c27a201cca1f336a7b9bdc)

Hi Marc,

Thanks for this, Nick asked me to review things, there's a few comments/changes if you wouldn't mind.

I'm trying to move to a standardised template for the getting started guides as there are so many ways to run node-red so having a consistent style will allow people to compare the different options, I think you're mostly there its just adding a few headings and a few bits of information,

The format is as follows:

[Overview of the platform/solution]

### Requirements
[What do you need setup in order to run node-red on this platform, links to external guides if required] 

### Installing
[The Steps to Install Node-RED once you have met the requirements]

### Costs
[Any costs of the platform (mostly for cloud providers)]

### Configuration
[ The Node-RED configuration options that can be set within the platform, Username and Password are a minimum]

### Limitations
[Any limitations of running Node-RED in this way compared to a regular local hardware install

#### Connections
[What connections are supported or not by the platform, HTTP (additional ports) MQTT, Serial, TCP DP etc]

#### Files
[What access does Node-RED have to a local filesystem and is this persistent]

#### Packages
[Any Packages/Nodes that are incompatible with the platform]

### Restarting
[How to restart Node-RED on the platform]

### Upgrading
[How to upgrade the version of Node-RED on the platform]

In terms of your page I think it would be better to move the second section on installing with the CLI and the Node-RED MQTT configuration onto a separate page on the Balena site/GitHub etc. with a link from this page to find out more The idea of the Getting Started guides is to give users a simple way to "Get Started" with a specific platform in the simplest and most vanilla way possible.

sammachin avatar Dec 07 '21 11:12 sammachin

One other thing I noticed when I was installing it, I think your image is running under Node12? this is now in Maintenance mode and will be end of life in April, Node-RED 3.0 will also drop support for Node12 around the same time. Would it be possible to update to 14 or 16 now.

sammachin avatar Dec 07 '21 11:12 sammachin

ok @sammachin let me check your comments! Thanks

mpous avatar Dec 07 '21 12:12 mpous

Hello @sammachin i would like to work again on this. I will try to update all the content again and commit new changes. Is there anything else that we can do?

mpous avatar Sep 14 '23 08:09 mpous

Hi @mpous

we haven't necessarily adopted the structure Sam proposed across the other guides. if you give the content a refresh to make sure its up to date, with some thought for the general direction Sam described, we can get this merged.

knolleary avatar Sep 14 '23 09:09 knolleary