Deployment

To deploy io.Bridge locally on your machine without using a Docker image, execute the @interopio/bridge package directly via npm by using the npx command.

The following sections describe the requirements and the steps for executing the @interopio/bridge package locally.

1. To be able to execute the @interopio/bridge locally, you must have the following tools installed:

• npm
• Node.js 24 or later

2. io.Bridge requires a valid license key to operate.

Provide your license key directly or provide a path to a file containing your license key by using the IO_BRIDGE_LICENSE_KEY or the IO_BRIDGE_LICENSE_KEY_FILE environment variable respectively:

• on Windows:

set IO_BRIDGE_LICENSE_KEY_FILE=./secrets/io-bridge-license.key

• on macOS or Linux:

export IO_BRIDGE_LICENSE_KEY_FILE=./secrets/io-bridge-license.key

3. Execute the @interopio/bridge package via the npx command:

npx @interopio/bridge

This will initialize a single io.Bridge node on your local machine. Optionally, you can configure io.Bridge by using command line arguments.

4. To connect your io.Connect platform (io.Connect Desktop or io.Connect Browser) to io.Bridge, you must provide the necessary platform configuration.

For more details on configuring the io.Connect platforms, see the Configuration > Platform > io.Connect Desktop and Configuration > Platform > io.Connect Browser sections.