Skip to main content
Feedback

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, you need to create a local runtime player 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, you must create and configure a local player. This player uses the local runtime's Run API to render a local runtime Flow.

For example:

  • You create a new default.html file in a web server folder on the local runtime machine.

  • You copy the contents of the default player 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:

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

You can host players in different ways depending on your requirements, using any web server or content management site that can render HTML. Examples include 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 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.

On this Page