Skip to main content
Version: Archive

Deploying DxOdyssey Using an Unattended Installation Script (PowerShell)

Applies to:

  • DxOdyssey 19.5 and newer
  • PowerShell 5+ on Windows
  • PowerShell Core 6+ on Linux

Summary​

Installation and deployment of DxOdyssey using an unattended installation script.

Information​

Download the script file and the example config file.

The script requires the following paramaters:

  • -config [string] - The path to the dxo.ini file that contains the configuration options.

  • -deploy [int] - The deployment options (1-4), which are as follows:

    1. First run on the first server. This will install DxOdyssey, activate the license and create a One Time Pass Key (OTPK).

    2. Additional server installations. This will install DxOdyssey, activate the license and join an existing gateway server (the server in deployment 1).

    3. Last run on the final server. This will install DxOdyssey, activate the license, join an existing gateway server and run the full deployment script.

    4. Single node deployment. The full script will run without creating an OTPK or joining any additional gateways.

Installation instructions​

  1. Copy the dxo_deploy_*.ps1 script and the example dxo.ini file to the first server in the gateway group.

  2. Download the latest copy of the DxOdyssey installation file to the first server.

  3. Open the dxo.ini file for edit.

  4. Set the path= value to the path and filename of the DxOdyssey installation file.

  5. Set the license= value to a valid DxOdyssey license key.

  6. Set the otpk_ttl= value to the desired duration of the One Time Pass Key (OTPK) in hours. The OTPK is used to join additional servers to the gateway group. Once the OTPK has expired, additional servers will not be allowed to join the gateway group until another OTPK has been set.

    info

    The OTPK creation step is skipped when using deployment option 4 (single node deployment).

  7. Set the remaining deployment options (clients, groups, tunnels, etc) using the examples in the dxo.ini config file.

  8. Save the dxo.ini file.

    info

    If using deployment option 4 then the script can be run now using -deploy 4 and then skip the remaining steps.

  9. Run the dxo_deploy_*.ps1 script on the first server with the path to the dxo.ini file and the -deploy 1 option. For Example:

    ./dxo_deploy.ps1 -config ./dxo.ini -deploy 1

  10. The first time that deployment option 1 is used, it will create an OTPK and write it back to the dxo.ini file.

  11. Copy the dxo_deploy_*.ps1, dxo.ini and the DxOdyssey installation files to the remaining servers in the gateway group.

  12. Run the dxo_deploy_*.ps1 script on all additional servers using the -deploy 2 option.

  13. Run the dxo_deploy_*.ps1 script on the final server using the -deploy 3 option. This will fully deploy all options specified in the dxo.ini file.

Additional Information​