Creating a DxOdyssey Docker Container

Applies to…

  • DxOdyssey 19.5 and newer

Summary

DxOdyssey can be run in Docker containers using the commands provided below. Links are provided at the bottom of the page for gateway group deployment and special configurations.

Information

  1. Pull a DxOdyssey Docker image.
    docker pull dh2i/dxo
    docker pull dh2i/dxo:xenial
    docker pull dh2i/dxo:centos7
  2. Start the DxOdyssey container.
    • DxOdyssey requires port 7979 be accessible for gateway group adminstration. The -d flag runs the container detached so the command line may still be used on the host machine, -h specifies the hostname inside the container, –name specifies Docker’s name for the container, and -p is for each port mapping assigned to the container. To start a DxOdyssey container, execute this command:
      docker run -p 17979:7979 -d -h < CONTAINER_HOSTNAME > --name < CONTAINER_NAME > dh2i/dxo
    • [OPTIONAL] The /etc/dh2i folder may be saved on the host machine within a virtual volume to persist data beyond the lifetime of the container. This will save DxOdyssey’s configuration in case the container is deleted.
      docker run -p 17979:7979 -v dxoVolume:/etc/dh2i -d -h < CONTAINER_HOSTNAME > --name < CONTAINER_NAME > dh2i/dxo
    • [OPTIONAL] To connect to a tunnel origin in a container, the tunnel port needs to be mapped to the host machine. Specify these additional mappings with -p flags:
      docker run -p 17979:7979 -p 20000:20000 -v dxoVolume:/etc/dh2i -d -h < CONTAINER_HOSTNAME > --name < CONTAINER_NAME > dh2i/dxo
  3. After the container has started, execute “docker exec -it < CONTAINER_NAME > bash” to issue commands within the container.

Please see the links below for information about deploying DxOdyssey using DxCli. Additionally, DH2i provides automated deployment scripts for DxOdyssey. It is recommended to use these scripts for larger deployments.

Additional Information