v13.0.1 and higher - Install PSM HTML5 Gateway using a container manager

This topic describes how to install the PSM HTML5 gateway via Docker or Podman.

Software prerequisites

  • Docker - Red Hat Enterprise Linux 7.x versions or Ubuntu 20.x or 22.x versions

  • Podman - Red Hat Enterprise Linux 8.x versions

Install the HTML5 Gateway

This section describes how to install the PSM HTML5 Gateway.

  1. Download HTML5 Gateway from the CyberArk Marketplace and copy the HTML5 Gateway-Rls-v13.0.1.zip\PSMGWDocker directory to the Linux host.

  2. Go to that directory.

  3. Run the following command to grant execution rights to the setup script.

    chmod +x html5_console.sh
  4. Run the following command to execute the setup script

    sudo ./html5_console.sh install -l

If there are users or groups that already exist on the host machine, the installation will stop for security purposes.

  • To remove and replace the users and groups with the relevant IDs, run the installation script again with the -f flag:

    sudo ./html5_console.sh install -f
  • To view the help, run the installation script with the -h flag:

    sudo ./html5_console.sh install -h

Launch the HTML5 Gateway container


  1. Harden the host machine by executing the following command:

    • Red Hat 7:

      sudo sh RHEL7-CIS/harden.sh
    • Red Hat 8:

      sudo sh RHEL8-CIS/harden.sh
    • Ubuntu 20:

      sudo bash UBUNTU20-CIS/harden.sh
    • Ubuntu 22:

      sudo bash UBUNTU22-CIS/harden.sh
  2. Restart the machine. This is required after hardening.

    After hardening, the root account does not have PermitRootLogin rights and therefore cannot log in using SSH.

Post-installation configuration

After installation, configure the HTML5 Gateway. For details, see Secure Access with an HTML5 Gateway.

Load balancing

The PSM HTML5 gateway can be load balanced as you would load balance any other web server (or the PVWA).

You can deploy farms of HTML5 gateway servers behind a load balancer. Then when adding a configured PSM Gateway server, use the relevant farm's Virtual IP (VIP) in the Address parameter. For details, see Add PSM HTML5 Gateway server.

In deployments where multiple connectors point to the same load-balanced URL, and multiple HTML5 gateways are behind this URL, the HTML5 copy files capability works if the Load Balancer has been configured with sticky sessions so that all requests for a particular user session are routed through the same HTML5 gateway.

You can perform a health check on the servers. For details, see Health Check.

Upgrade the PSM HTML5 Gateway

For details, see Using a container manager.