Provisioning

Compatibility

✅ 2.2 | ✅ 2.1 | ✅ 2.0 | ⛔ 1.9 | ...

Objective

Provide custom deployment options with QZ Tray

Quick Start

Prepare environment for compiling

Prepare provision.json file

[
   {
      "description": "Configure log file size",
      "type": "property",
      "data": "log.size=2097152"
   }
]

Invoke ant with the provision file:

ant -Dprovision.file=provision.json nsis

You now have a customized installer.

Provision Types

Certificate

Certificates are installed during the "phase": "startup" and write an entry to allowed.dat (e.g. %APPDATA%\qz) to avoid clicking "Remember this decision".

[
   {
      "description": "Trusts a certificate",
      "type": "certificate",
      "data": "digital-certificate.txt"
   }
]

Property

Properties are installed during "phase": "certgen" (during install) and writes a properties entry to qz-tray.properties located in the installation directory. (e.g. %PROGRAMFILES%\QZ Tray)

[
   {
      "description": "Disable logs",
      "type": "property",
      "data": "log.disable=true"
   }
]

Preference

Properties are installed during "phase": "startup" and write a properties entry to prefs.properties located in the user data directory (e.g. %APPDATA%\qz)

[
   {
      "description": "Disable logs",
      "type": "property",
      "data": "log.disable=true"
   }
]

Script

Script are run during "phase": "install" and allow granular customizations. The script will be automatically copied into the installer.

data Must point to a valid script file and may be relative or absolute in respect to the location of provision.json.
os is recommended and never inferred.

[
   {
      "description": "Shell script",
      "os": "linux|mac",
      "type": "script",
      "data": "my_script.sh"
   }
]

Software

Software is run during "phase": "install" and will execute with the provided deployment arguments.

os optional but will be assumed based on file extension
arch is optional but strongly recommended
args will automatically be split up on whitespace for convenience
- ... if whitespace is needed, use "arg1": "first arg", "arg2": "second arg"

Supported file types:

Windows: .exe, .msi
macOS: .pkg
Linux: .run

[
   {
      "description": "Install Notepad++",
      "type": "software",
      "os": "windows",
      "arch": "x86_64",
      "data": "npp.8.5.8.Installer.x64.exe",
      "args": "/S"
   }
]

Remover

Remover is a task to uninstall other QZ Tray installations, which is especially helpful for Company Branded builds to remove known-conflicting installs.

data may be qz, or the application identifiers from the Company Branded portal.
- Example: "data": "qz" Shorthand for QZ branded installers)
- Example: "data": "Cherry Connect,cc-util,cc" Long format, required for Company Branded builds.

[
   {
      "description": "Remove QZ Tray",
      "type": "remover",
      "data": "QZ Tray,qz-tray,qz",
   }
]

Phases

Install | Certgen | Startup | Uninstall

Install

The "phase": "install" will run run as a privileged account during QZ Tray installation, but before QZ Tray has been fully deployed to the system.

Certgen

The "phase": "certgen" will run as a privileged account during QZ Tray installation, but after QZ Tray has been fully deployed to the system.

Startup

The "phase": "startup" will run as ordinary user during the startup of QZ Tray.

Uninstall

The "phase": "uninstall" will run as as a privileged account during uninstallation of QZ Tray.

Arch

Arch will designate which architecture to perform the step.

If not provided, arch will default to "arch": "*" and run on all systems.
Multiple values may be provided: "arch": "aarch64|riscv64"

Supported values:

Intel: "arch": "x86_64"
ARM64: "arch": "aarch64"
RISCV: "arch": "riscv64"

OS

OS will designate which platform to perform the step.

If not provided, os will default to "os": "*" and run on all systems
- Except software installers, which will try to choose a sane value.
Multiple values may be provided: "os": "mac|linux"