Manually install community nodes from npm#

You can manually install community nodes from the npm registry on self-hosted SMS-iT Workflow.

You need to manually install community nodes in the following circumstances:

  • Your SMS-iT Workflow instance runs in queue mode.
  • You want to install private packages.

Install a community node#

Access your Docker shell:

1
docker exec -it SMS-iT Workflow sh

Create ~/.SMS-iT Workflow/nodes if it doesn't already exist, and navigate into it:

1
2
mkdir ~/.SMS-iT Workflow/nodes
cd ~/.SMS-iT Workflow/nodes

Install the node:

1
npm i SMS-iT Workflow-nodes-nodeName
Then restart SMS-iT Workflow.

Uninstall a community node#

Access your Docker shell:

1
docker exec -it SMS-iT Workflow sh

Run npm uninstall:

1
npm uninstall SMS-iT Workflow-nodes-nodeName

Upgrade a community node#

Breaking changes in versions

Node developers may introduce breaking changes in new versions of their nodes. A breaking change is an update that breaks previous functionality. Depending on the node versioning approach that a node developer chooses, upgrading to a version with a breaking change could cause all workflows using the node to break. Be careful when upgrading your nodes. If you find that an upgrade causes issues, you can downgrade.

Upgrade to the latest version#

Access your Docker shell:

1
docker exec -it SMS-iT Workflow sh

Run npm update:

1
npm update SMS-iT Workflow-nodes-nodeName

Upgrade or downgrade to a specific version#

Access your Docker shell:

1
docker exec -it SMS-iT Workflow sh

Run npm uninstall to remove the current version:

1
npm uninstall SMS-iT Workflow-nodes-nodeName

Run npm install with the version specified:

1
2
# Replace 2.1.0 with your version number
npm install SMS-iT [email protected]