Documentation

• ✅ 2.2 | ⚠️ 2.1 | ⛔ 2.0 | ⛔ 1.9 ...

Advanced command line usage and environmental variable usage examples. For compiling options, see compiling. For installer options, see deployment.

💡 Environmental variables will take effect after QZ Tray is restarted.

Windows environmental variables are often set through Advanced System Settings, Advanced, Environment Variables. Alternatively,through the set|setx command.

setx QZ_OPTS "-Xmx4096m"

... and to revert:

setx QZ_OPTS ""

macOS environmental variables do not persist; set via defaults write instead:

defaults write io.qz.qz-tray QZ_OPTS -string "-Xmx4096m"`

... and to revert:

defaults delete io.qz.qz-tray QZ_OPTS

💡 For custom branded (white-label) customers, this command will change to defaults write <BUNDLE_ID>.
... where <BUNDLE_ID> is the value returned from java -jar /Applications/MyApp.app/my-app.jar --bundleid

See deployment steps.

Since 2.2.0

# Windows
"C:\Program Files\QZ Tray\qz-tray-console.exe" [options]

# Mac
"/Applications/QZ Tray.app/Contents/MacOS/QZ Tray" [options]

# Linux
"/opt/qz-tray/qz-tray" [options]

Usage: java -jar qz-tray.jar (command)

INFORMATION
  --help, -h, /?                   Display help information and exit.
  --version, -v                    Display version information and exit.
  --bundleid, -i                   Display Apple bundle identifier and exit.
  --libinfo, -l                    Display detailed library version information and exit.

ACTION
  --allow, --whitelist, -a         Add the specified certificate to allowed.dat.
                                     java -jar qz-tray.jar --allow cert.pem
  --block, --blacklist, -b         Add the specified certificate to blocked.dat.
                                     java -jar qz-tray.jar --block cert.pem
  --file-allow                     Add the specified file.allow entry to qz-tray.properties for FileIO operations, sandboxed to a specified certificate if provided
                                     java -jar qz-tray.jar --file-allow /my/file/path [--sandbox "Company Name"]
  --file-remove                    Removes the specified file.allow entry from qz-tray.properties for FileIO operations
                                     java -jar qz-tray.jar --file-remove /my/file/path

OPTION
  --honorautostart, -A             Read and honor any autostart preferences before launching. [true]
  --steal, qz:steal                Ask other running instance to stop so that this instance can take precedence. [false]
  --headless                       Force startup "headless" without graphical interface or interactive components. [false]

INSTALLER
  preinstall                       Perform critical pre-installation steps: Stop instances, all other special considerations.
  install                          Copy to the specified destination and preforms platform-specific registration.
                                     java -jar qz-tray.jar install --dest /my/install/location [--silent]
  certgen                          Performs certificate generation and registration for proper HTTPS support.
                                     java -jar qz-tray.jar certgen [--key key.pem --cert cert.pem] [--pfx cert.pfx --pass 12345] [--host "list;of;hosts"]
  uninstall                        Perform all uninstall tasks: Stop instances, delete files, unregister settings.
  spawn                            Spawn an instance of the specified program as the logged-in user, avoiding starting as the root user if possible.
                                     java -jar qz-tray.jar spawn [program params ...]

BUILD
  jlink                            Download, compress and bundle a Java Runtime
                                     java -jar qz-tray.jar jlink [--platform mac|windows|linux] [--arch x64|aarch64] [--vendor bellsoft|eclipse|...] [--version ...] [--gc hotspot|openj9] [--gcversion ...]
  provision                        Provision/bundle addition settings or resources into this installer
                                     java -jar qz-tray.jar provision --json file.json [--target-os windows --target-arch x86_64]
For help on a specific command:
  Usage: java -jar qz-tray.jar --help (command)
    --help --file-allow
    --help install
    --help certgen

QZ Tray will honor Java system properties via:

• Command-line override: -Doption=value
• Environmental variables: QZ_OPTS
• Properties file: qz-tray.properties (Advanced --> Diagnostic --> Browse App Folder)
• Preferences file: prefs.properties* (Advanced --> Diagnostic --> Browse User Folder)
  *for properties which support user-scoped overrides

e.g.

# custom websocket port example
websocket.secure.ports=9191,9292
websocket.insecure.ports=9192,9293