DH2i DxOdyssey 21.0 Software: Ubuntu Installation Quick Start Guide

Download the PDF

Ubuntu Installation

This quick start guide describes how to install DxOdyssey on an Ubuntu Linux server. Using this guide, the user will install DxOdyssey dependencies and software, then join a second server (gateway) into a gateway group.

Prerequisites

  • A physical or virtual machine running Ubuntu 16.04, 18.04, or 20.04. A second machine is required for joining two gateways into a gateway group.

Configure Server and Install Dependencies

  1. Update the Ubuntu package list by using the command sudo apt-get update.
  2. Update system packages using the command sudo apt-get dist-upgrade. If prompted to confirm, enter Y.
  3. Ensure that the hostname is set and unique using the hostname command.
    • To rename the server, run sudo hostnamectl set-hostname <name>. The server must be restarted for the change to take effect.
  4. Install Microsoft .NET 3.1 Runtime using Microsoft’s installation instructions.
  5. Install remaining DxOdyssey dependencies by running sudo apt-get install zip.
  6. OPTIONAL: Set host resolution for all servers (gateways) that will be participating in the gateway group using sudo nano /etc/hosts. Write the IP address and hostname of the servers to the file and save.

Install DxOdyssey

  1. Download the DxOdyssey package signing key by running the command:
    wget -qO- https://repos.dh2i.com/public.gpg | sudo gpg --dearmor -o /etc/apt/trusted.gpg.d/dh2i.gpg
  2. Register the DxOdyssey Ubuntu repository by running the command
    sudo sh -c 'echo deb [arch=amd64] https://repos.dh2i.com/ bionic retail >/etc/apt/sources.list.d/dh2i.list'

    NOTE: The architecture parameter [arch=amd64] can be changed to arm64 or armhf to install DxEnterprise on those platforms.

  3. Update the Ubuntu package list by using the command sudo apt-get update.
  4. Install DxOdyssey from the repository by running the command sudo apt-get install -y dxodyssey.

Configure DxOdyssey

  1. Activate the server using the command sudo dxcli activate-server.

    Syntax

    dxcli activate-server <key> [gateway]

    Parameters

    Name Description Required
    key The license key. True
    gateway The name of the gateway (comma-separated list of multiples). False

    Example

    dxcli activate-server AAAA-BBBB-CCCC-DDDD

  2. Set the gateway group passkey using the command sudo dxcli gateway-group-set-secret.

    Syntax

    dxcli gateway-group-set-secret

    Parameters

    Interactive only.

    Example

    dxcli gateway-group-set-secret

  3. DxOdyssey utilizes NAT matchmaking to easily connect servers across the internet. Use the command sudo dxcli set-otpk to set a One-Time PassKey for the gateway group. The One-Time PassKey expires one hour after creation by default.

    Syntax

    dxcli set-otpk [ttl] [otpk]

    Parameters

    Name Description Required
    ttl The time the key will expire. False
    otpk The One-Time PassKey in base64. False

    Example

    dxcli set-otpk

Setup Second Gateway and Join to Gateway Group

  1. Complete all the steps in the Configure Server and Install Dependencies section for the second gateway.
  2. Complete the Install DxOdyssey section and step one of the Configure DxOdyssey section for the second gateway.
  3. Join the second gateway to the gateway group using sudo dxcli join-gateway-group and follow the prompts. When asked to use a NAT proxy, select Y. Enter the OTPK to join the gateway group.

    Syntax

    dxcli join-gateway-group

    Parameters

    Interactive only.

    Example

    dxcli join-gateway-group

References

Download the PDF