Installing for Offline Environments¶

If the PCoIP Connection Manager and PCoIP Security Gateway machine does not have a connection to the public internet, you must create a temporary internet-connected machine to download a pre-created offline installation bundle and then transfer the bundle to the production machine.

For information on bundle dependencies, see System Requirements.

Before You Begin¶

Before you proceed with installation, note the following:

• If your connection broker is configured to identify resources by host name, then DNS must be available and configured as follows:

  • Host names must be resolvable from the PCoIP Connection Manager server.

  • Host names must be resolvable from the PCoIP broker.

Downloading Offline Installation Bundle¶

You'll need a temporary machine with internet access.

1. On the temporary machine, open a browser and go to the PCoIP Connection Manager and PCoIP Security Gateway download page, and download the installation bundle.

2. Transfer the installation bundle to the production machine using any acceptable method, such as a USB flash drive or SCP.

Installing PCoIP Connection Manager and the PCoIP Security Gateway¶

To install the PCoIP Connection Manager and the PCoIP Security Gateway:

1. SSH into the production machine.

2. Navigate to the directory where you placed the installer bundle.

3. Extract the bundle and move into the newly-created teradici-pcoip-cmsg-bundle directory:

   • RHEL 8

     ```text
     tar xzvf pcoip-cmsg-setup_darksite-<version>.el8.tar.gz
     ```
     
     ```text
     cd teradici-pcoip-cmsg-bundle
     ```
     

   • RHEL 9

     ```text
     tar xzvf pcoip-cmsg-setup_darksite-<version>.el9.tar.gz
     ```
     
     ```text
     cd teradici-pcoip-cmsg-bundle
     ```
     

4. Run the pcoip-cmsg-setup-offline.sh script to complete the installation

   • To install dependencies and follow the setup prompts to setup PCoIP Connection Manager and the PCoIP Security Gateway:

     sudo ./pcoip-cmsg-setup-offline.sh
     

     and skip the next step.

   • To install dependencies and run pcoip-cmsg-setup later to setup PCoIP Connection Manager and the PCoIP Security Gateway:

     sudo ./pcoip-cmsg-setup-offline.sh -d
     

5. Move back up one directory level and then install the PCoIP Connection Manager and PCoIP Security Gateway:

   cd ..
   sudo pcoip-cmsg-setup install --darksite-bundle-path teradici-pcoip-cmsg-bundle <installation_flags>
   

   Important: Required installation flags

   There are a number of options and settings available. You can invoke the install command with the --help flag to list them:

   pcoip-cmsg-setup install --help
   

   They are also listed in the next section.

   The install command will prompt you for required parameters that have not been supplied via flags.

Installation Flags and Options¶

The following flags can be used to provide values at the command line. Flags that are required are identified in the description.

Boolean values should be provided as either true or false, lowercased, as in this example:

--example-flag=true

Federated Authentication Flags

Federated Authentication Single Sign-On Flags

Enabling or Disabling the PCoIP Security Gateway¶

By default, the PCoIP Security Gateway is enabled when the bundle is installed. This configuration is highly recommended for deployments where users will connect over the WAN. If your users are behind a firewall and do not access their desktops from the WAN, you may not need the PCoIP Security Gateway.

If you are sure that you do not need the PCoIP Security Gateway, reinstall the bundle using the --enable-security-gateway=false flag.

To reenable the PCoIP Security Gateway, reinstall the bundle using the default options.

Creating the Installation Bundle¶

First, you'll download the package and dependencies to a temporary internet-connected machine, create an installation bundle.

To create the offline installation bundle:

1. Install Docker onto the temporary machine.

2. On the temporary, open a browser and go to the PCoIP Connection Manager and PCoIP Security Gateway download page.

3. Click Downloads and scripts:

   

   If you see a login button instead, click it to log into the site and then proceed.

4. Accept the End User License Agreement, then click Set Up Repository:

   .

   The window will expand and show the setup scripts for each supported operating system. Copy the command for your system to the clipboard.

5. Open a console window and paste in the command you copied in the previous step. You may need to press Enter to execute it.

   The command fetches a configuration script from our servers and runs it locally, setting up and configuring the repository on the local machine.

6. Install pcoip-cmsg-setup

   sudo dnf install pcoip-cmsg-setup
   

7. Find and note the rpm name for the setup package. We will use this name when creating the offline bundle next.

   sudo dnf info pcoip-cmsg-setup
   

   The rpm name will similar to this: pcoip-cmsg-setup-<version>-<release>.

8. Create the offline install bundle:

   sudo pcoip-cmsg-setup create-darksite-bundle --pcoip-cmsg-rpm-path <rpm name>
   

   ...where <rpm name> is the name you noted in the previous step.

   The process will create a tarball called teradici-pcoip-cmsg-bundle.tar.gz.

Once this process has completed successfully, you can dispose of the temporary machine.