Headless

Compatibility

• ✅ 2.1 | ⛔ 2.0 | ⛔ 1.9 | ...

Objective

• Run QZ Tray in a headless environment
• See also windows-service

Prerequisites

• A Certificate (digital-certificate.txt if generated from our portal)

  Note: Step 2 of the signing messages tutorial needs to be completed in order to establish a websocket connection

Steps

1. Whitelist the certificate

   The first step is to whitelist the Certificate your signatures will be authenticating against. You can launch the software prior to this, but you will not be able to make a websocket connection, as there is no GUI for the warning dialogues to display in, causing an immediate disconnect.

   • Open a terminal or cmd prompt and execute the appropriate command for your OS:

     Note: the --whitelist flag can be substituted withed -a

     OS	Command
     Windows	java -jar "%PROGRAMFILES%\QZ Tray\qz-tray.jar" --whitelist "path\to\digital-certificate.txt" ... and optionally copy "%appdata%\qz\allowed.dat" "%programdata%\qz\allowed.dat" see also #749.
     Linux	java -jar /opt/qz-tray/qz-tray.jar --whitelist "path/to/digital-certificate.txt"
     macOS	java -jar /Applications/QZ\ Tray.app/qz-tray.jar --whitelist "path/to/digital-certificate.txt"

   • Verify the entry Successfully added YOUR COMPANY to allowed list in the log displayed in the command prompt

   • An allowed.dat file is created with the finger print of the Intermediate Certificate (digital-certificate.txt).

     OS	Location
     Windows	%APPDATA%\qz\allowed.dat
     Linux	~/.qz/allowed.dat
     macOS	~/Library/Application\ Support/qz/allowed.dat

2. Launch QZ Tray in headless mode

   • Run the software from the command line using the --headless or -h flag:

     OS	Command
     Windows	java -Xms512m -jar "%PROGRAMFILES%\QZ Tray\qz-tray.jar" --headless
     Linux	java -Xms512m -jar /opt/qz-tray/qz-tray.jar --headless
     macOS	java -Xms512m -jar /Applications/QZ\ Tray.app/qz-tray.jar --headless