Skip to main content
Version: v22.0

DxOdyssey Windows Installation Quick Start Guide


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


  • A physical or virtual machine running Windows 2008R2 or later. A second machine is required for joining two gateways into a gateway group.

  • Ensure the server hostname is set and unique.

  • Set host resolution for all servers (nodes) that will be participating in the cluster by adding their entries to the hosts file located at %SystemRoot%\System32\drivers\etc\hosts.


Update Server and Install Dependencies

  1. Ensure the VM is up-to-date using Windows Update or sconfig.

  2. Install Microsoft .NET Framework 4.5.2 if it is not already installed.

Install DxOdyssey

  1. Copy the DxOdyssey .msi to the server.

  2. Double-click the DxOdyssey setup program.

  3. A welcome screen will be displayed. Click Next to continue with the installation.

    Welcome screen

  4. Select I accept... to accept the software license agreement and click Next to continue.

    DxOdyssey EULA

  5. OPTIONAL: In the Destination Folder window, select an installation folder for DxOdyssey.

    Change the installation folder

  6. Select Next.

  7. In the Read to Install window, select Install.

  8. Select Finish to complete the installation.

    Finish the DxOdyssey installation

Configure DxOdyssey Using DxConfiguration Manager

DxConfiguration Manager is a client tool used to configure first-time DxOdyssey installations on Windows. After the configuration is completed, administrators can use DxOdyssey’s Client management UI for gateway group management. See the DxConfiguration Manager Admin Guide for more information.

  1. Start DxConfiguration Manager by double-clicking the desktop shortcut.

  2. At the main screen, select Activate License.

    DxConfiguration Manager license management screen

    1. In the License Management window, enter the DxOdyssey license key (including dashes) in the license code box, check the Accept EULA box, and select Activate.
    2. After the server successfully activates, close the License Management window to return to the main menu.
  3. Prepare the gateway so other members can join the gateway group.


    DxOdyssey utilizes NAT Matchmaking Service to easily connect servers across the internet.

    1. Click Manage OTPK to set a One-Time PassKey for the gateway group that can be used by other gateways to join the gateway group via NAT.

      OTPK Management Window

    2. Select New, and a window will appear for setting the expiration time of the OTPK.

      Set the OTPK for the gateway group

    3. Choose a time and date for expiration (or leave the default), the select Set to generate the OTPK and close the window.

    4. Save the OTPK for later so it can be used to join the second gateway to the gateway group.

    5. OPTIONAL: At the main menu, select Set Passkey to open the Passkey Management window.


      Setting a gateway group passkey is not required for NAT joins. However, a gateway group passkey is required for remote gateway group management.

      Enter a gateway group passkey

      1. Enter a passkey for the gateway group and select Submit.
      2. After the passkey is successfully set, select OK to return to the main menu.

Configure Additional Members

  1. Complete all the steps in the Installation section for the second gateway.

  2. Start DxConfiguration Manager by double-clicking the desktop shortcut.

  3. Activate the server using the instructions from step 2 of the previous section.

  4. At the DxConfiguration Manager main menu, select Join Membership.

    Join the VMs into a gateway group using membership management

    1. Select the Join via NAT Match Agent checkbox.

    2. Leave the Target Member field with the default value of

    3. In the Pass Key field, paste (or type) the OTPK.

    4. Select OK to join the gateway group via NAT.

  5. Close the DxConfiguration Manager window.

Additional Information