flowfuse/installer

A set of install scripts for FlowFuse

FlowFuse helps Node-RED developers deliver applications in a more reliable, collaborative and secure manner. Node-RED’s intuitive, low-code development environment is great for connecting together hardware devices, APIs and online services. FlowFuse adds to Node-RED collaborative development, management of remote deployments, support for DevOps deliver pipelines, and the ability to host Node-RED applications on FlowFuse Cloud. FlowFuse is the devops platform for Node-RED application development and delivery.

Key Features

• FlowFuse adds team collaboration to Node-RED, allowing multiple developers to work together on a single instance.
• Many organizations deploy Node-RED instances to remote servers or edge devices. FlowFuse automates this process by creating snapshots on Node-RED instances that can be deployed to multiple remote targets.
• FlowFuse simplifies the software development lifecycle of Node-RED applications. You can now set up DevOps delivery pipelines to support development, test and production environments for Node-RED application delivery.
• FlowFuse is available from FlowFuse Cloud, a managed cloud service, or a self-hosted solution.
• FlowFuse offers professional technical support for FlowFuse and Node-RED.

Links

• Home Page
• Documentation
• Contributing
• Code of Conduct
• Security
• License

installer's Issues

Pre-build Mosquitto go-auth binaries to remove step from install

Epic

No response

Description

### As a: new localfs user

I want to: not have to build go-auth plugin

So that: I don't need to know how to setup a Go build environment

Acceptance Criteria

Build of the pluign for the following platforms

• Linux/amd64
• Linux/arm64
• Linux/armv7
• Darwin/amd64
• Darwin/arm64

This may be better solved by submitting a PR to the plug-in project to resurrect: iegomez/mosquitto-go-auth#162

Update link to install.zip to always point at latest

Story

No response

Description

Update link in readme (and in flowforge.com docs) to point to

https://github.com/flowforge/installer/releases/latest/download/flowforge-installer.zip

This needs to be done after the 1.1 release

(Windows) Installation of the stack kills the parent install process

Current Behavior

During install on windows, the latest stack is now installed.

After stack installation, the install batch file is existed & the completion message is not seen

Expected Behavior

stack installer should exit and the installer batch should continue to the_end

Steps To Reproduce

run the installer on windows box

Environment

Windows

Move installer to a tar from zip

Story

No response

Description

Since Windows has a command line tar command we can move to using tar on all platforms and use the --strip-components=1 option to remove the directory in the tar file.

This means we can do away with the temp directory.

Add belt and braces execute permissions to the installer.sh

Story

No response

Description

User had unzipped the installer.zip on a windows machine and then used SCP to copy the files over to the Linux machine.

This stripped the execute bits from all the scripts.

Update the install instructions to add them back and have the install script check and fix if needed.

Remove version number from installer zip file

Story

No response

Description

Remove -x.y.z from artefact name for installer so we can have a static link

./install.sh fails on mac

Current Behavior

https://www.reddit.com/r/nodered/comments/yfepz2/comment/iu3g5xe/?utm_source=share&utm_medium=web2x&context=3

**************************************************************
 FlowForge Installer                                        
                                                            
 Warning: 
 The install may need root priviledges at times, it uses    
 sudo so may ask for your password.                         
 root access is used to install NodeJS if needed and to set 
 directory pemissions                                       
                                                            
**************************************************************
NodeJS found
**************************************************************
 NodeJS Version 16 or newer found 
**************************************************************
**************************************************************
 npm found                                                  
**************************************************************
6.14.9
**************************************************************
 Setting execute bit on FlowForge binaries, this uses sudo  
 to ensure correct permissions                              
**************************************************************
**************************************************************
 Installing FlowForge                                       
**************************************************************
[bcrypt] Success: "/opt/flowforge/app/node_modules/bcrypt/lib/binding/napi-v3/bcrypt_lib.node" is installed via remote
[sqlite3] Success: "/opt/flowforge/app/node_modules/sqlite3/lib/binding/napi-v6-darwin-unknown-x64/node_sqlite3.node" is installed via remote
added 487 packages from 481 contributors in 15.715s
./install.sh: line 266: syntax error near unexpected token `fi'
./install.sh: line 266: `fi'

Expected Behavior

No error and print the closing message

Steps To Reproduce

pull v1.0.0 installer and run it on a mav

Environment

• FlowForge version: v1.0.0
• Node.js version: 16.x
• npm version: 6.x
• Platform/OS: MacOS
• Browser: NA

Installation problem on windows

Getting error on the following line

• Installing latest Node-RED as a stack... *
  The system cannot find the path specified.

bat file found
.\app\node_modules.bin\ff-install-stack.cmd %*
There is an error on this line.

I think there is not "ff-install-stack.cmd" in bin directory.

Installer fails on EC2 Machines

EC2 reports 2 *-release files,

Slack thread at https://flowforgeworkspace.slack.com/archives/C02248RCPJ4/p1640794810074400

Incorrect directory name inside the installer zip file

Current Behavior

When I tried the instructions in README.md, I found that cp -R flowforge-installer-0.1.0/* /opt/flowforge command doesn't work.

$ cp -R flowforge-installer-0.1.0/* /opt/flowforge
cp: cannot stat 'flowforge-installer-0.1.0/*': No such file or directory

The problem occurs from wrong directory name inside the installer zip file. It has flowforge-install-0.1.0 directory.

Expected Behavior

The command executes without error.

Steps To Reproduce

No response

Environment

• FlowForge version: v0.1.0
• Node.js version: v16.13.1
• npm version: v8.1.2
• Platform/OS: Ubuntu 20.04.2 LTS on WSL2 in Windows 10
• Browser: Google Chrome 97.0.4692.99 (Official Build)(64 bit)

Add default mosquitto.conf file in local install

Epic

No response

Description

As a: first time user

I want to: a default mosquitto configuration file to be provided

So that: I have less to do

---

Our install instructions leave the user with a lot of work to do around mosquitto. A quick win will be for the installer to create a etc/mosquitto.conf file with our default configuration in.

The file should include suitable comments to highlight the entries that they will need to modify for their environment - although the defaults should largely just work.

I think the tricker one will be the path to the auth plugin. We should get more opinionated about where that should be - as the docs currently leave it completely up to the user to chose.

Acceptance Criteria

• After running the installer, there is a default mosquitto.conf file
• Install docs updated (both here and in main docs) to reflect improved process

Pre-build MacOS mosquitto-auth-go plugin

Story

#53

Description

Finish off #53 which delivered Linux builds

Installer outputs "flowforge" to the user instead of "flowfuse"

Originally posted by @Steve-Mcl in #87 (comment)

"FlowForge" is still being printed to the screen during installation:

Win

Linux

install.sh script doesn't work on Ubuntu

Current Behavior

I followed the instruction in README.md but I encountered the following error. The script expects bash but the script uses another shell. I thought that the correct command is ./install.sh instead of sh ./install.sh.

$ sh ./install.sh
**************************************************************
 FlowForge Installer

 Warning:
 If this script needs to install NodeJS it may ask for your
 password in able to run some commands as root.

**************************************************************
NodeJS found
./install.sh: 55: [[: not found
**************************************************************
 You need NodeJS 16 or newer, please upgrade
**************************************************************

Expected Behavior

./install.sh works correctly.

$ ./install.sh
**************************************************************
 FlowForge Installer

 Warning:
 If this script needs to install NodeJS it may ask for your
 password in able to run some commands as root.

**************************************************************
NodeJS found
**************************************************************
 NodeJS Version 16 or newer found
**************************************************************
**************************************************************
 npm found
**************************************************************
8.1.2
**************************************************************
 Installing FlowForge
**************************************************************
⸨⠂⠂⠂⠂⠂⠂⠂⠂⠂⠂⠂⠂⠂⠂⠂⠂⠂⠂⸩ ⠦ idealTree:app: sill idealTree buildDeps

Steps To Reproduce

No response

Environment

• FlowForge version: v0.1.0
• Node.js version: v16.13.1
• npm version: v8.1.2
• Platform/OS: Ubuntu 20.04.2 LTS on WSL2 in Windows 10
• Browser: Google Chrome 97.0.4692.99 (Official Build)(64 bit)

Installer ignores suggested default option for user choice (current or Flowforge) and bails when user hits enter

Current Behavior

Installer asks three questions during installation and the linux convention is that the uppercase option is default, and if the user submits empty input then that default option is used.
This doesn't work properly for the last question (and potentially others), the installer then bails and the user is left unaware how to proceed except to reinstall.

Expected Behavior

As expected with the capitol option being accepted as user default, and the option to use the Flowforge user is chosen when the user just hits enter with no other input.

Steps To Reproduce

On a pi 3A+ (512mb with 2/5ghz wifi), be patient as it appears to stall during npm but is just slow.

Run installer on fresh copy of raspberry pi OS 32bit headless.
Accept first question to install NodeJS, then expect following output (truncated):

Installing latest Node-RED as a stack
**************************************************************
installing stack node-red@latest
node-red@latest is currently [email protected]
installed stack [email protected]
**************************************************************
 Do you want to run FlowForge as a service?
**************************************************************
Y/n: y
**************************************************************
 Do you want to run FlowForge as the current user (pi)   
 or create a flowforge user?                                
**************************************************************
Current/FlowForge (c/F): 
**************************************************************
 Not C or F                                                  
**************************************************************
pi@rpi3a0001:/opt/flowforge $ 

Environment

• FlowForge version: latest install instructions + zip

Typos in README.md

Current Behavior

I found that there are two typos in the README.md.

• Prerequistes -> Prerequisites
• Amzon Linux 2 -> Amazon Linux 2

Expected Behavior

No response

Steps To Reproduce

No response

Environment

• FlowForge version: 0.1.0

Change link to point to upstream pre-built linux binaries

Story

No response

Description

Pre-built Linux binaries are currently hosted on my (@hardillb) fork of the mosquitto-auth-go hardillb/mosquitto-go-auth as the upstream project had problems with the publish step in the GH Action.

When fixed should point to their builds.