Articles in this section

See more

How to install a Docker container via the Containers tab

  • Updated
Follow

As of Cloud Agent V1.19.0, Container Directory will be available to your devices via the Containers tab in LiveEdge Cloud. The Container Directory is where Videon will list all validated Docker containers created by both Videon and partners. If you would like your container listed in Container Directory, please open a support request. Our engineers will begin the process of vetting and validating your container.

In order to enable your workflows that use Docker containers, Videon provides an example of how to use the Containers tab on the device page in LiveEdge Cloud. This article will explain the processing for using both the Standard tab (explained in the walkthrough video above) and the Advanced tab.

 

Container Eligibility Requirements

In order for your container to be listed in Videon's Container Directory, it must meet the following criteria:

  1. Container was created and is managed/maintained by your organization or Videon.

  2. Container can be installed and run via the Advanced tab (explained later).

    • This means the container can function properly using only the options shown.
      NOTE: The option to modify DNS Servers is only available in Cloud Agent versions >V1.34.0. If you would like to set a custom DNS Server, first make sure your Cloud Agent is updated to at least V1.34.0.

  3. Container can be run on a test device by Videon to validate installation and functionality.

  4. Container image is hosted in a public Docker Hub or Amazon ECR repository.

 

Installing the Container


Once the container has been verified and tested by Videon, it will appear in your Container List. To install the container, you can use either the Standard tab or Advanced tab.

Standard

Below is an example step-by-step process for installing Videon's HTML5 graphics rendering container via the Standard tab.

  1. Navigate to the desired device (https://videoncloud.com/devices/{device_guid})

  2. Click on Containers

  3. In the Available Containers section in the row with the name "HTML5 Graphic Overlay Renderer", click the green install button

  4. Users can navigate away and come back when installation is complete

  5. You can now view your newly installed container within the Installed Containers section.

 

Advanced

Below is an example step-by-step process for installing Videon's HTML5 graphics rendering container via the Advanced tab.

  1. Navigate to the desired device (https://videoncloud.com/devices/{device_guid})

  2. Click on Containers

  3. Click "+ Pull Image" and enter the following:

    1. Enter the image repository: 
      818162850908.dkr.ecr.us-west-2.amazonaws.com/videon_html5_playwright 
      (Videon tests and supports both Docker hub and Amazon ECR repositories)

    2. Enter the image tag: 
      V1.0.0

    3. Enter any repository credentials (not needed for public containers)

    4. Click the orange "Pull Image" button

  4. Wait until the image appears in the "Available Images" section

    • This may take a few minutes, especially with large containers on slow networks

  5. Click "+ Create Container" and enter the following:

    • Enter a container name: 
      HTML5 (DO NOT use spaces or special characters in the name. Docker does not accept spaces or special characters in the container name). 

      • Instead of "Graphics Renderer", you could use "GraphicsRenderer" instead, for example.

    • Select an available image: 
      videon_html5_playwright:V1.0.0

    • Select "Apply Restart Policy" and assign a restart policy: 
      always

      • See --restart here for more information

    • Select "ADD PORT MAPPING" to map any ports needed: None for this example.

      • See --publish here for more information

    • Select "ADD VARIABLE" to set any environment variables needed:  None for this example.

      • See --env here for more information

    • Select "ADD VOLUME" to map any volumes needed:  None for this example.

      • See --volume here for more information

  6. Under Advanced, select the desired Network Mode: 
    host

    • bridge is the default

    • See --network here for more information

  7. Click Create Container and wait for the container to appear in the "Installed Containers" section

  8. Click the MANAGE symbol

  9. Finally, click the START button to run the container

 
 
 
 
For the HTML5 rendering container:

  • See these steps on how to configure the HTML5 URL to use with the newly installed container.

  • Ensure the Static Graphic Overlay feature is turned ON to enable the HTML5 graphic to display on the encoded stream.

  • Videon's AV Input Preview can be used from the local Web UI or LiveEdge Cloud to validate the presence of the HTML5 graphic on the encoded video.

  • Make sure your input video is not 3840x2160 resolution, or the container will not be able to overlay a graphic onto the stream. This container only supports up to 1920x1080.

Related articles