FAQ

Code Examples

Overview HTML Printing PDF Printing Image Printing Advanced Pixel Printing

Overview Raw Encoding ZPL EPL ESC/POS ESC/P DPL PGL SBPL

Printer Status File Communication HID Communication Serial Communication

Network Information Data Filtering Getting Started Using QZ Tray Signing Messages API Overrides Command Line Usage

Licensing/Renewing

Generate Certificate Certificate Renewal Company Branded Signing Messages General Licensing Information

Printer Emulators

Deployment Options

Print Server Deployment Multiple Instances Windows Service Headless Operation Unattended Deployment Custom Provisioning Client Side Substitutions

Configure Raw Printer

Windows Ubuntu Linux macOS

Compiling

Install Dependencies Compile (QZ Tray)

Distributing

Create a QZ Tray distribution

This assumes Windows signing and macOS package signing have been configured.

Update the version

src/qz/common/Constants.java
js/qz-tray.js (two places)
js/package.json (for npm)

Before publishing make sure to commit the above version changes. We usually just call this Bump version.

Create the builds

Chain all three builds on macOS, following compiling tutorial.

ant pkgbuild && cp out/*.pkg ~/Desktop/ && \
ant makeself && cp out/*.run ~/Desktop/ && \
ant -Dtarget.arch=x86_64 nsis && cp out/*.exe ~/Desktop/ && \
ant -Dtarget.arch=x86_64 pkgbuild && cp out/*.pkg ~/Desktop/ && \
ant -Dtarget.arch=x86_64 makeself && cp out/*.run ~/Desktop/ && \
ant -Djlink.java.version=21.0.7+9 -Dtarget.arch=riscv64 makeself && cp out/*.run ~/Desktop && \ 
echo "Done"

Sign Windows Release

As of QZ Tray 2.2.5, this is done automatically by the build system using Amazon KMS

Click to expand old steps

Sign the .exe using DigiCert EV cert on Windows. Note, if you're on a High DPI screen, the app might look weird. Use this regkey and manifest to fix it.

Insert the USB hardware key (if it's not ready, read this first)
Download the DigiCertUtil.exe
Wait for Windows to setup the hardware key (about 5 minutes)
If it's the first time using the key on this computer, click "Repair cert"
Sign using SHA1, then SHA2
- When prompted for a password, Windows 10 may ask for a PIN, but actually use the full hardware password.

Notarize macOS Release

Send the package to Apple for notarization:
```
   xcrun notarytool submit --wait qz-tray-x.x.x-arm64.pkg --wait --apple-id <developer-id>@qz.io --password <the-secure-password> --team-id <team-id>
```
- apple-id: The email of the apple developer account
- password: The application-specific password (NOT the Apple developer password!)
- team-id: The signing ID, e.g. P5DMU6659X

After a few minutes, it returns:

Processing complete
   id: abcdefgh-abcd-1234-abcd-abcdefghij
+  status: Accepted

Which then can be monitored remotely using:

xcrun notarytool log abcdefgh-abcd-1234-abcd-abcdefghij --apple-id <developer-id>@qz.io --password <the-secure-password> --team-id <team-id>

Finally, staple the installer:

xcrun stapler staple qz-tray-x.x.x-arm64.pkg

Processing: qz-tray-x.x.x-arm64.pkg
Processing: qz-tray-x.x.x-arm64.pkg
+ The staple and validate action worked!

Publish

Upload builds to https://github.com/qzind/tray/releases/new
- Tag: v2.x.x (remember the v)
- Name: 2.x.x

Create simple, effective release notes. e.g.

**201X-01-01**

**Features**

* CP-987 support (#954)

**Fixes**

* Fixes HTTPS connections (#956)
* Better signing example for js (a1b2c3d)

Email premium clients (qz.io (slash) admin)
- Include abridged version of release notes
- Link to download
- Provide any additional information (such as status of 2.x.x beta)
Post to Facebook, Twitter
Update npm Assumes npm is installed (e.g. brew install npm)
- Open a terminal to js (e.g. ~/tray/js)
- Ensure package.json version is up to date
- If not already, call npm adduser
  - User: qzind
  - Public Email: support@qz.io
- Finally, call npm publish

Edit this page