Setting up a local runtime steps
This topic provides an overview of the steps involved in setting up a Flow local runtime.
Installing a local runtime
You install and set up local runtimes using a Flow Docker image. The Docker local runtime packages up the local runtime installation into a single easily-installable image.
You must install the local runtime Flow Docker image on a 64–bit Linux machine. The minimum supported Docker version is 19.03.8. Installation on a Windows Operating System is not supported.
Setting up a local runtime HTML5 player
Once you have set up a local runtime, you need to define your local runtime player configuration to allow users to view local runtime Flows in a web browser. As the local runtime does not access the Flow cloud, you need to create and configure a local HTML5 player. This allows the local runtime to access the player and use it to render your local runtime Flow(s) in a web browser.
A local runtime HTML5 player is not a requirement if your Flows will not run in a web browser. Your organization may instead deliver Flows using the API, a custom user interface, or a connector such as Twilio, for example.
Upgrading local runtimes
To upgrade to a new version of a local runtime, change the version number in your deployment manifests, and then restart all runtime instances.
Runtime health checking
A health API endpoint can be used to monitor the general system health of a runtime.
Runtime observability
Observability data can be exported for runtime environments. As well as basic error logging, more detailed system-level OpenTelemetry data can be exported from a runtime environment and sent to an OpenTelemetry Protocol (OTLP) endpoint/APM system.
