Skip to content

Commit

Permalink
See CHANGELOG for update details
Browse files Browse the repository at this point in the history
  • Loading branch information
TotallyInformation committed May 1, 2021
1 parent e16e3b4 commit 4492225
Show file tree
Hide file tree
Showing 3 changed files with 504 additions and 5 deletions.
16 changes: 15 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,24 @@ alternate-node-red-installer adheres to [Semantic Versioning](https://semver.org

## [Unreleased](https://github.com/TotallyInformation/alternate-node-red-installer/compare/v2.0.2...master)

None

## [2.0.3](https://github.com/TotallyInformation/alternate-node-red-installer/compare/v2.0.2...v2.0.3)

### Added

- `backup.sh`, `backupw.sh`, and `backupm.sh` BASH scripts to efficiently back up your working Node-RED installation if installed using this alternate installer.
- An example `settings.js` file (`data/example-settings/js`)

This contains a number of enhancements over the default including extended information that can be collapsed for easier reading.

It also is configured to pick up the environment variables specified in this packages templates.

- `backup.sh`, `backupw.sh`, and `backupm.sh` BASH scripts in the new `scripts` folder to efficiently back up your working Node-RED installation if installed using this alternate installer.

The scripts should be run from CRON daily, weekly and monthly respectively.

Please amend the indicated variables in the scripts so that they will work for your own installation.

```text
# Node-RED daily backup (3AM every day)
0 3 * * * "/home/home/nrmain"/backup.sh > /dev/null
Expand All @@ -25,6 +37,8 @@ alternate-node-red-installer adheres to [Semantic Versioning](https://semver.org

Output from the scripts are written to syslog, review with `sudo cat /var/log/syslog | grep nrmain-backup` or `sudo journalctl -t nrmain-backup`.

Note that the backup scripts have been updated for Node-RED v1.3 such that `data/externalModules/node_modules` is excluded.

## [2.0.2](https://github.com/TotallyInformation/alternate-node-red-installer/compare/v1.0.0...v2.0.2)
### Breaking

Expand Down
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,12 @@ alternate-node-red-installer -f <root folder name>

Where <root folder name>` is a relative or absolute folder path that you want to be the root of your new Node-RED installation.

Instead of the long-winded executable name, you can also use `nrinstall`

Example (for Mac, Linux or Windows PowerShell):

```
alternate-node-red-installer -f ~/nrtest
nrinstall -f ~/nrtest
```

Once the install has completed (it may take some time), you can navigate to the data sub-folder and work with Node-RED as normal (e.g. `cd ~/nrtest/data`).
Expand All @@ -43,7 +45,7 @@ These instructions should work on any platform supported by Node.JS.
* [The solution](#the-solution)
* [The advamtages](#the-advamtages)
* [Starting Node-RED](#starting-node-red)
* [Updating](#updating)
* [Updating Node-RED and installed nodes](#updating-node-red-and-installed-nodes)
* [Changes](#changes)
* [To Do](#to-do)
* [Prerequisites](#prerequisites)
Expand Down Expand Up @@ -110,7 +112,7 @@ When using this method, uou can start Node-RED manually from either the master o
The start script tells Node-RED of the correct userDir folder (the `data` sub-folder). You can also use the
start script with any other method you may wish to use of starting Node-RED (Windows Scheduler, systemd, PM2, nodemon, etc.)

## Updating
## Updating Node-RED and installed nodes

If you have installed the two `package.json` files in this repository, you will find that they contain `npm run ...`
scripts such as `check-master` and `update-data`. These scripts do everything necessary to see if anything needs
Expand Down Expand Up @@ -140,4 +142,4 @@ Please see the [TODO](./TODO.md) file.

## Prerequisites

* NodeJS. v8.16.0 (LTS) is the minimum supported version.
* NodeJS. v10 is the minimum supported version.
Loading

0 comments on commit 4492225

Please sign in to comment.