Installation
  • 13 Jan 2023
  • 4 Minutes to read
  • Dark
    Light
  • PDF

Installation

  • Dark
    Light
  • PDF

Liquit Agent Bootstrapper is a small tool to assist in installation or updating of the Liquit Workspace Agent, and optionally in running a deployment after installation.

The bootstrapper requires Liquit Workspace Server and Agent 3.9.2712 or higher to function properly!

The bootstrapper must always be executed with Administrator privileges.

The bootstrapper can be downloaded here.

Process

Uninstalling

If the command /uninstall is specified, the uninstall process is executed and the rest of the bootstrapper processes are ignored.

The bootstrapper will find the first Liquit Agent installation it can find in the registry, searching for the DisplayName matching "Liquit Universal Agent" or "Liquit Workspace Agent", and use its GUID to run the msiexec /x command.

To uninstall multiple copies of the Liquit Agent you will have to run the Bootstrapper multiple times with the /uninstall command specified.

After executing the uninstall the bootstrapper will quit.

Checking for Zone Override

If the command /zoneOverride= is specified, the tool will write the value to the Agent configuration file before continuing.

Configuration File

The bootstrapper will either use the Agent.JSON or Agent.XML configuration file depending on which is available next to the bootstrapper.

Installing certificate

If the command /certificate="path/to/file.cer" is specified the bootstrapper will copy the certificate to the Liquit data folder, for example to C:\ProgramData\Liquit\Agent.

After that it will add the data "Type" = "Certificate" to the configuration file under the "Registration" section.

If the command /certificateThumbprint="XYZ" is specified the bootstrapper will also write the value to the "Certificate Thumbprint" field under the "Registration" section in the configuration file.

Downloading Agent Installer

The tool will then check if there is an Agent.MSI or Agent.EXE file already available next to itself. If not, it will try to download it instead.

To download the file the tool needs a direct download URL. If the command /downloadUrl= is specified it will use this. Otherwise it will use the configuration file to get the server zone URL.

Using the static zone URL download only functions on Server 3.9.2608 or higher. If you're using a version before Server 4.0 the command /legacyDownload is also required! If you are using a Server version earlier than 3.9.2608, and you are not including an installer file with the tool, then /downloadUrl= is required instead.

If you are using Liquit Workspace Server 4.0 or higher, the tool will by default download the new Universal Windows Agent installer instead of the legacy MSI installer. If you want to download the legacy MSI installer instead of the new Universal Windows Agent installer, you should specify /legacyDownload as a command-line argument.

The tool also checks if the downloaded file is a valid .MSI or .EXE file.

Static Zone URL

If you are using Liquit Workspace Server 3.9.2608 or higher, the tool can use the server URL specified in the Agent configuration to attempt to download the installer file directly from the Workspace Server.

NOTE: If you are using a version lower than Liquit Workspace Server 3.9.2608, the static zone URL fetch will not function. You must specify a direct download URL to the .MSI or .EXE file via command line or include the Agent.MSI or Agent.EXE file with the Bootstrapper before running.

Running Agent Installer

The tool will then run the installer and check for a successful install afterwards.

If the /startDeployment flag is specified, the bootstrapper will run the command 'ShellAPI deployment run' after successful installation.

Also, if /startDeployment is specified, the Bootstrapper will write the field Deployment.Autostart.Enabled to True in the configuration file. This is important because otherwise the ShellAPI will not know which deployment to start.

If you'd like the application to wait until deployment is finished, you can use the flag /waitForDeployment.

Command Line Options

All commands are case insensitive.

Command Description
/? or /help Lists the available commands with a quick description of its function.
/forceDownload Force the download from URL even if the Agent installer is locally available.
/downloadUrl=https://example.com/some/direct/path/agent.MSI Uses the input after '=' as the download URL, instead of the static address.
/legacyDownload If you're using the static server download feature, it will download the legacy installer instead of the Universal Windows Agent installer.
/startDeployment Runs the command 'ShellAPI deployment start' after installing the Workspace Agent.
/waitForDeployment Halts execution for the program as long as the deployment process is running. Will only work in combination with the parameter /startDeployment.
/skipOverrideConfig Will not include 'OVERRIDE_CONFIG=1' for the MSI installation. Please refer at the corresponding documentation for more information on this property.
/logPath="c:\install" Specifies the directory where the log files will be placed in, if not specified, the current working directory will be used.
/msiProperties="TEST=1 EXAMPLE=1" Passes along the specified properties to the installer as command line arguments. Please refer at the corresponding documentation for more information on this property.
/zoneOverride="https://zone.example.com/" Writes the value to the Zone field in the Agent configuration file as specified in Checking for Zone Override
/certificate="path/to/file.cer" Installs the specified certificate to the Liquit data folder.
/certificateThumbprint="XYZ" Writes the specified certificate thumbprint to the configuration file.
/uninstall Uninstalls the first Liquit Agent installation it can find in the registry.

Was this article helpful?

What's Next