Local runtime HTML5 player setup

A Flow player needs to be configured for use with the local runtime.

Once you have set up a local runtime, a local runtime player needs to be created to render and allow users to view local runtime flows in a web browser. Refer to Players for more information on using players in Flow.

As the local runtime does not connect to and use players in the Flow cloud, a local player must be created and configured to use the local runtime's Run API to render a local runtime Flow.

For example:

• A new default.html file is created in a web server folder on the local runtime machine.

• The contents of the default player are copied into this new local player file.

• The contents of this new local player file are edited and configured to point to and use the local runtime.

How to set up a local runtime HTML5 player

A local runtime player is typically set up using either of the following two approaches:

• Setting up a local runtime default HTML5 player

• Setting up a local runtime HTML5 player for an individual Flow

If you wish to use a custom player based on an existing custom player in the Flow cloud, simply copy the content of the Flow cloud custom player into a local version of the player that you can then use with the local runtime.

Players can be hosted in different ways depending on your requirements, using any web server or content management site that can render HTML, such as an Apache web server or a content management site such as Atlassian Confluence.

A containerized web server can be used to display the HTML player if required, for example using an Apache Web Server. Refer to Apache HTTP Server.

note

A local runtime HTML5 player is not a requirement when using local runtimes if your flows will not be run in a web browser, as your organization may deliver flows using the API, a custom user interface, or a connector such as Twilio for example.