NodeRED#

NodeRED Node-RED is a programming tool for wiring together hardware devices, APIs and online services in new and interesting ways.

amd64
arm64
armv7

Information#

Docker Image: !!! LINK TO DOCKER IMAGE/ DOCKER HUB !!!
Current Image Version: latest-12-minimal

SETUP#

Enabling nodered#

Command:#

vlab set nodered.enable True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

nodered
enable: True

Finalising changes:#

run: vlab update_one service=nodered

FIRST RUN#

!!! DEVELOPERS: make sure that you include any information that the user requires to get started, below. !!!
!!! Below are some examples with headings, and with some example instructions !!!

ADMINISTRATOR SETUP#

Navigate to https://False/admin

Create an account with your desired username; as this is the first user, nodered makes this account the administrator.

SMTP/ MAIL#

  1. run vlab decrypt to decrypt the vault.yml file
  2. make some changes

SMTP Settings#

smtp:
host:
port:
user:
pass:
from_email:
from_name:
  1. run vlab update_one service=nodered to complete the changes

ACCESS#

nodered (HTTPS) link: https://nodered.vivumlab.xyz/ nodered (HTTP) link: http://nodered.vivumlab.xyz/

OPTIONS#

HTTPS_ONLY#

Default: False
Options: True/False

Command:#

vlab set nodered.https_only True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

nodered
https_only: True
Finalising changes:#

run: vlab update_one service=nodered

AUTH#

Default: False
Options: True/False

Command:#

vlab set nodered.auth True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

nodered
auth: True
Finalising changes:#

run: vlab update_one service=nodered

DOMAIN#

Default: False
NOTE: include the sitename and top level domain suffix. eg. name.com, site.net

Command:#

vlab set nodered.domain nodered.com

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

nodered
domain: nodered.com
Finalising changes:#

run: vlab update_one service=nodered

SUBDOMAIN#

Default: nodered
NOTE: Periods/ delimiters are not required. eg. 'media' will set the full URL as 'media.vivumlab.xyz'

Command:#

vlab set nodered.subdomain media

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

nodered
subdomain: media
Finalising changes:#

run: vlab update_one service=nodered

VERSION#

Default: latest-12-minimal
NOTE: Ensure that the version exists

Command:#

vlab set nodered.version 2.7

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

nodered
version: 2.7
Finalising changes:#

run: vlab update_one service=nodered

Need more help?#

Further information regarding services can be found.
General Information can be found in the documentation.
Additional assistance can be found on our Contact Us page.