-
Notifications
You must be signed in to change notification settings - Fork 0
- ✅ 2.1 | ✅ 2.0 | ✅ 1.9 | ...
- How does the certificate licensing work?
- How do you suppress print warning dialogues?
- How much does QZ Tray cost?
- How do I renew the certificate?
- I've updated my certificate but the old certificate is still appearing.
- How do I debug QZ Tray?
- Why won't QZ Tray launch?
- QZ Tray crashes
- Why can't I list my printers?
- Why is my thermal printer only printing text characters?
- Installation of a new version will succeed even if an older version is present and/or running.
- Note: QZ Tray 2.0 is not backwards compatible with QZ tray 1.9.
########### TODO ###########
When you purchase Premium Support you are granted the ability to generate an Intermediate Certificate and a public/private key pair to suppress all warning dialogues. This certificate has:
- No client/user limitations
- No domain restrictions
- It must be renewed annually (multiple years may be purchased at once) A single license will suffice for 99% of organizations
The purchase of the premium version also provides technical support for one year. The Technical Support Team of QZ Industries, LLC will work diligently to help integrate the software (installers, API, etc.) into your environment. All questions are promised to be answered as fast as possible (usually well within a 24-hour period).
We also offer a White Labeling option. This allows you to rebrand the software entirely with your company's logo. More information on this option can be found here.
- In order to suppress print warning dialogues, all print requests must be signed using the Intermediate Certificate and private key. An in-depth tutorial explaining how to do this can be found here.
- QZ Tray is free. Organizations wishing to print silently are required to purchase a certificate from QZ Industries, LLC or implement their own root certificate. Pricing options can be found on QZ's homepage at https://qz.io.
If you have updated the digital-certificate.txt
per the renewal steps, yet the old certificate is still showing, it is likely that the browser has cached the certificate.
-
You may force a reload of the cache by modifying the URL: e.g.
http://foo/bar/digital-certificate.txt?modify_url
-
Be sure to modify the JavaScript file's URL that contains this code if it is imported in your page
Product | Minimum Version |
---|---|
QZ Tray 2.1 | Java 8 / OpenJDK 1.8* |
QZ Tray 2.0 | Java 7 / OpenJDK 1.7* |
*HTML printing in QZ Tray 2.x requires Java 8 + Java FX.
Operating System | Minimum Version |
---|---|
Apple OS X | OS X 10.7 Lion or higher* |
Microsoft Windows | Windows XP or higher* |
Linux | Ubuntu 12.04 Precise or higher |
Version 2.0 or higher requires
512MB
of free memory (RAM), recommends6GB
or higher total system memory for raster graphics.
*Safari 5.1.7 is bundled with Lion but is not supported. Alternate browser required.
*Windows XP requires manual certificate installation. Will prompt at install time.
Web Browser | Minimum Version |
---|---|
Safari | Safari 6.0.3 or higher |
Firefox | Firefox 31 or higher* |
Chrome | Chrome 31 or higher |
Internet Explorer | IE 10 or higher* |
Microsoft Edge | 20.x or higher* |
* Firefox requires a browser restart for HTTPS
* IE/Edge on domain networks require external DNS access to localhost.qz.io
due to a Local Intranet Limitation.
- QZ Tray places log files in the following locations:
- Windows:
%APPDATA%\qz
- Mac:
~/Library/Application Support/qz
- Linux:
~/.qz
- Windows:
-
The recommended approach for getting verbose output from QZ Tray is to launch the software from command line. This will expose the Java Console with detailed information about debug messages and exceptions including full backtrace of where a particular exception occurred.
-
QZ Tray launches with
512MB
of memory. We must specify-Xms512M
in the command in order to prevent unexpected behavior and crashing. This unnecessary for Mac unless following the basic syntax (java -jar qz-tray.jar
) . More memory can be allocated but should not be necessary.Basic syntax
java -Xms512M -jar qz-tray.jar
Windows
java -Xms512M -jar "%PROGRAMFILES%\QZ Tray\qz-tray.jar"
Mac OS X
/Applications/QZ\ Tray.app/Contents/MacOS/QZ\ Tray
Linux/Other
java -Xms512M -jar /opt/qz-tray/qz-tray.jar
-
A corrupt Java installation may prevent the software from installing or loading. A corrupt Java installation is fairly common in Windows, and can be resolved by reinstalling Java using the Java offline installer. The offline installer has been reported to fix many issues with corrupt Java installations. Take a look at this guide for our recommended steps on reinstalling Java on all platforms.
Signs of a corrupt Java install:Creating keystore for ws://localhost...
- [failed] Creating a CA keypair...
... or ...
java -version
"An error has occurred while processing the shared archive file. Unable to unmap shared space. Error occurred during initialization of VM. Unable to use shared archive."
-
Sometimes custom
JAVA_HOME
environmental variables will prevent QZ Tray from loading. If the software can be launched via the command line this is likely the case. In windows this can be checked by going to System > Advanced system settings > Environment Variables -
Insufficient Java Version
"A Java Exception has occurred"
may appear if attempting to launch against an outdated Java version. For a list of minimum Java requirements see Java Versions. -
Disk Corrupted: Always try
fsck
(Linux),Disk Utility
(MacOS) orchkdsk
(Windows). Physical drives can show strange symptoms when they are beginning to fail however SSDs hard drives are susceptible to a condition called "worn bits" or more properly "SSD Endurance" which is responsible for re-using NAND flash memory. This process should be self-healing but on occasion can cause issues with certain drive firmwares. Make sure to scan your disk for health when encountering launch issues.
-
Images/PDFs cause software to stop working: More commonly
Cannot call method public void qz.ws.PrintSocketClient#onMessage
, this is generally a sign that the JVM has hit an unrecoverable error. The most common cause is large print operations on a 32-bit JVM. A temporary workaround is to specify{ rasterize: false }
in the configuration, but this will only fix PDFs. A permanent solution is to switch to a 64-bit JVM which allocates a larger heap space. If 32-bit is required, additional heap space may be allocated via command-line. -
32-bit vs. 64-bit: Some 64-bit workstations have both 32-bit and 64-bit Java versions installed. If both are needed, make sure both are upgraded, otherwise, removing the 32-bit version is advised to assist with the troubleshooting process.
-
Mac
Due to an upstream bug with Java, printer listings may fail on Mac.
The current workaround is to:
- Open System Preferences
- Printers and Scanners
- Right Click > Reset Printing System
- Re-add all printers
We realize this is not ideal, but have found no another work-around on Mac.
-
Windows
Although rare, there are scenarios of not being able to list printers, only being able to list one printer, or listing printers takes several minutes to complete. This is likely caused by a driver conflict between the offending printer driver and the print spooler, resulting in the entire print subsystem to hang.
The workaround is to remove the offending printer or printer driver.
If your thermal or label printer has undesired results, it may be improperly configured. Here are our tutorials for setting up a printer to receive raw languages on each platform:
Note: Some Windows drivers, such as Zebra's ZDesigner driver for Microsoft Windows, will support raw printing alongside pixel-based/PostScript printing. You may use those drivers or a raw-generic/text-only driver to send raw commands, but the generic driver will not be able to print images/PDF/HTML.
By default, QZ Tray suppresses verbose websocket information from the console, however occasionally this information may be useful for debugging/troubleshooting connectivity issues.
-
2.0 Only - Using the
qz.api.showDebug(...)
API option, verbose connection details will logged to the browser's console.qz.api.showDebug(true); // must be called prior to calling qz.websocket.connect()
-
1.9 Only - Using the
deployQZ(...)
API option, verbose connection details will logged to the browser's console.deployQZ(null, true); // usage: deployQZ(hostname, debug);
- This is often a sign of an incompatible version. Please make sure you are using a build correct for your system (e.g. 1.9, 2.0)
- Error:
typeerror: _qz.tools.hash is not a function
- Cause: Make sure the page is being rendered with UTF-8
<meta charset='utf-8'>
.
- Cause: Make sure the page is being rendered with UTF-8
- Error:
WebSocket connection to 'wss://localhost:8181/' failed: Error in connection establishment: net::ERR_CONNECTION_CLOSED
- Cause: Java 9 (Beta) is known to cause this error. Please downgraded to a supported Java version.