Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

CONNECT flows

TABLE OF CONTENTS

Install a flow runtime using Docker-compose

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
  • Last UpdatedAug 13, 2026
  • 2 minute read

This topic covers how to install a flow runtime using Docker-compose.

Prerequisites

You have a platform that supports the minimum requirements:

  • Docker is installed

  • Docker Compose is installed

  1. Install a flow runtime using Docker-compose

    1. Sign on to the Connect flows registry site: https://registry.flows.connect.aveva.com/

    2. Open a terminal and enter: [sudo] docker login https://registry.flows.connect.aveva.com/

    3. When prompted, enter the user name and password.

      • To locate the user name and password, open Flow manager, then select Manage and then select Flow runtimes.

      • Select the Settings icon. The Flow runtime artifacts dialog opens.

      • Select the Docker installation tab.

    4. Scroll down in the dialog and locate the user name and password under step 1.

    5. Copy this information to the clipboard.

    6. From the flow runtime page, select the Register flow runtime tab.

  2. Create docker-compose.yml

Download the file: Docker yaml code samples.

  1. Before running this Docker Compose file, create a secret for encrypting persisted credentials with the commands below.

  2. Download the file into a local folder or create it using the code sample below.

  1. Configure credentials

    1. Option A: Id and AccessKey

      Replace <ID> and <KEY> with the values from Show Credentials.

    2. Option B: Global key

      For mass deployment, generate a registration key in the Key and Name Pattern tab, then replace the credential lines with the following:

      - SecurityConfiguration__Registration__Key=ENTER-YOUR-GLOBAL-KEY-HERE

      - SecurityConfiguration__Registration__Name=UNIQUE-NAME-HERE # Optional

      Then replace:

      ENTER-YOUR-GLOBAL-KEY-HERE with the registration key from the Key and Name Pattern tab.

      UNIQUE-NAME-HERE (optional) with a unique runtime name using only alphanumeric characters and underscores.

    1. Start the runtime

      [sudo] docker compose up -d

      The Runtime image will be downloaded from the registry and started.

    2. Verify the runtime

      If startup completes without errors, the runtime should appear in CONNECT Flows with a green checkmark on the Flow runtimes or Dashboard page.

      Next, you can build and deploy flows on the new runtime.