ZendHQ User Interface Installation

ZendHQ has a separate user interface (GUI) for interacting with the daemon.

Supported platforms for ZendHQ User Interface

The following details all platforms on which ZendHQ User Interface is currently supported:

Operating system Supported version(s)
Linux

All 64-bit architecture

Windows

10, 11

Windows Server

2016, 2019, or 2022

MacOS

14 (Sonoma)

Download the installer from: https://downloads.zend.com/zendphp/zendhq-ui/

Select the release appropriate for your platform:

  • For Windows, run the MSI Installer Wizard for installation, removal, and repair.

  • For macOS, use the DMG package for installation, removal, and repair.

  • For Linux/UNIX, download the zip or tar.gz file. Extract its contents to a directory. It contains two files, an executable, and a resources.neu file; both must be present for the executable to run.

How to update the ZendHQ User Interface

When starting the application, the ZendHQ User Interface notifies you when there's an update available. To install the update, click Update to confirm.

If you close the dialog, the application won't update automatically. In this case, open the About page in the application to initiate the update later.

How to run the User Interface on a different machine than the daemon

It is common to install the ZendHQ User Interface on a different machine from the ZendHQ Daemon. As, by default, the Daemon is configured to only listen to requests from localhost, update its configuration to establish a connection to the ZendHQ User Interface.

  1. Log on to the machine where the daemon runs.

  2. Find your ZendHQ daemon configuration file and open it in a text editor:
    /opt/zend/zendphp/etc/zendhqd.ini

  3. Modify the following directive so that the ZendHQ daemon listens on the IP address of your ZendHQ UI installation.
    For WebSocket protocol, prepend ws:// or wss:// respectively.
    zendhqd.websocket.interface = {YOUR_UI_IP_ADDRESS}:10091

  4. (Optional) Repeat this directive to listen on multiple interfaces or multiple port numbers.

Warning
Do not configure the zendhqd.websocket.interface setting to listen on all IP addresses unless the ZendHQ Daemon is behind a secure firewall. Not specifying an IP address poses a security risk.

How to install the User Interface on Windows

For Windows, download and run the MSI Installer Wizard. In some cases on Windows, you may need to grant privileges so that you can make HTTP and websocket requests to localhost. You achieve this by running the following from a command prompt:

Copy
CheckNetIsolation.exe LoopbackExempt -a -n="Microsoft.Win32WebViewHost_cw5n1h2txyewy"

Troubleshooting:

Symptom: My ZendHQ User Interface on Windows displays a blank screen.

  • Reason: Some versions of Windows do not include the MS Edge Webview2 component by default. Known versions affected include Windows 10 Enterprise and Windows Server 2019 Datacenter.

  • Solution: To fix this issue, download the Webview2 component from Microsoft and install it. After you have installed WebView2, relaunch the ZendHQ User Interface to verify the fix. For more information, see Microsoft Edge WebView2.

Logging in to ZendHQ User Interface

To let users log in, the ZendHQ admin must first create the accounts and share the user names and passwords with the users. For more information on how to create users, see ZendHQ Role Management.

Follow these steps:

  1. Verify that the ZendHQ daemon is running.

  2. Double-click the executable to start the ZendHQ User Interface.

  3. When prompted, provide the IP address or DNS-resolvable name to connect to ZendHQ.

  4. Log in.

    • To log in as the admin user, use the configured ZendHQ token. Either use the username "admin" or do not specify a username. By default, the token is "zendphp". The admin has access to all features.

    • To log in as users, users enter their user name and password that the ZendHQ admin provided them with. Some ZendHQ features are not available to users based on the permissions of their assigned groups.