Environment Variables

Environment Variables allow you to manage variables used in your Node-RED flows from the FlowForge application, you can read more on how to access environment variables inside Node-RED in the Node-RED Docs.

An Environment Variable consists of a name and a value.

Editing

You can edit the environment variables for a project from the Settings tab of a project, select the Environment option from the side menu.

Changes will only take effect when the project is restarted.

Template provided variables

The Template may include some predefined environment variables that are automatically applied to the project. The template may lock some of those variables to prevent a Project from changing them.

Variables provided by the template cannot be deleted, however if they are editable, their value can be set to blank.

Project

You can create additional variables for a single project by entering the name and value in the boxes at the bottom of the list and clicking the + button.

You can delete a project variable using the trash can icon.

The image below shows a project with 3 environment variables.

The first one foo is set by the template but the value bar is editable

The second one locked is set by the template and the value is set to true is not editable

The third one user is set for the project, the value can be edited or the variable deleted

Standard environment variables

Projects running on FlowForge are assigned a standard set environment variables as follows.

  • FF_PROJECT_ID
  • FF_PROJECT_NAME
  • FF_DEVICE_ID
  • FF_DEVICE_NAME

FF_PROJECT_ID and FF_PROJECT_NAME are assigned to the Project running on the FlowForge server as well as all associated Devices. In all Node-RED instances within a Project these variables will be the same.

Unique values for FF_DEVICE_ID and FF_DEVICE_NAME are assigned to each instance of Node-RED running on a Device within a Project however these variables are not assigned to the instance running on the FlowForge server.