Workbench

The Connectware ships with a running Node-RED (https://nodered.org) application.

To start working with the prototyping Node-RED Workbench, on the navigation panel click on the Workbench menu item. This will open the running Node-RED editor for the Workbench in another browser tab.

../_images/menu_item_workbench.png

Note

However, this Node-RED workbench is not intended to be used in production-ready services but rather for quick and easy prototyping tests. In deployments where Node-RED should be used in production, the recommended setup is to create a service commissioning file which installs a Node-RED container as Cybus::Container resource on its own. This way, the authors of the service have the full control over the versioning and life cycle of the Node-RED instance.

Further instructions on how to work with Node-RED can be found here: https://nodered.org/docs

For connecting the Node-RED flow to the Connectware API, the Connectware can be reached by using the server name connectware both for MQTT (1883) and HTTPS (443) connections.

../_images/nodered-mqtt-server.png

Additionally, when subscribing or publishing to the Connectware server, a suitable username and password has to be set manually in the Node-RED workbench. You need to ensure that the given user has sufficient permissions (or suitable roles) in order to access the topics in question. See also User Management.

../_images/nodered-username.png

The Workbench allows to store Flows in any external Git Repository. You can get familiar with Node-RED’s Projects feature (https://nodered.org/docs/user-guide/projects/) to understand how this works in practice. In order to enable it in your Connectware, you must modify the configuration as described next.

Workbench Parameters

  • CYBUS_WORKBENCH_PROJECTS_ENABLED: If true, the Projects feature will be enabled. Default: false.

Configuration

Important

The provided steps are valid, if your Connectware was installed with the official installer script. For different deployment types, such as Managed Appliances or Kubernetes, please reach out to support@cybus.io.

1. Navigate into your Connectware installation directory. If you have used the default values during installation this would be /opt/connectware.

2. The directory contains a .env file that is loaded when starting the Connectware. Open the .env file in a text editor of your choice.

3. Modify the parameter in question in the .env file. By default the settings should look like this:

# Workbench Configuration
CYBUS_WORKBENCH_PROJECTS_ENABLED=false