QZ Tray

https://qz.io/docs
Admin
QZ Tray is a cross-browser, cross-platform plugin that enables web applications to print to local...
Tokens:120,821
Snippets:895
Trust Score:9.3
Update:1 week ago
Show doc for...
Tokens:
Raw
### Quick Start: provision.json example

Source: https://qz.io/docs/provisioning

Example provision.json file that configures the log file size. Used in the quick start steps to create a customized installer.

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

--------------------------------

### Full example: setup callback, find printer, listen, and get status

Source: https://qz.io/docs/printer-status

Full example that sets up a callback, finds a printer by name, starts listening, and requests its status. The callback logs severity, eventType, and message. The function getPrintersStatus() demonstrates the complete flow.

```javascript
//setup a callback
qz.printers.setPrinterCallbacks((evt) => { console.log(evt.severity, evt.eventType, evt.message); });

function getPrintersStatus () {
    // get the status of a specific printer
    qz.printers.find("Printer Name").then(printer => {
        // listen to the printer
        qz.printers.startListening(printer).then(() => {
            return qz.printers.getStatus();
        });
    }).catch(function(e) { console.error(e); });
};
```

--------------------------------

### Node Quickstart - Connect and print

Source: https://qz.io/docs/api-overrides

Provide API overrides and start talking to QZ Tray. Connects, gets the default printer, prints its name, disconnects, and exits.

```javascript
var qz = require('qz-tray');
qz.api.setWebSocketType(require('ws'));

qz.websocket.connect()
.then(qz.printers.getDefault)
.then(function(printer) {
   console.log("The default printer is: " + printer);
})
.then(qz.websocket.disconnect)
.then(function() {
   process.exit(0);
})
.catch(function(err) {
   console.error(err);
   process.exit(1);
});
```

--------------------------------

### Node Quickstart - Install dependencies

Source: https://qz.io/docs/api-overrides

Install the required npm packages for the Node.js quickstart.

```bash
npm install qz-tray ws
```

--------------------------------

### Software provisioning example

Source: https://qz.io/docs/provisioning

Runs a software installer during the 'install' phase with deployment arguments. The 'os' and 'arch' fields are optional but recommended, and 'args' are split on whitespace.

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

--------------------------------

### Script provisioning example

Source: https://qz.io/docs/provisioning

Runs a script during 'install' or 'startup' phase. The 'data' field points to a script file, and 'os' is recommended. The script is copied into the installer.

```json
[
   {
      "description": "Python script",
      "os": "linux|mac",
      "type": "script",
      "data": "my_script.py"
   }
]
```

--------------------------------

### AngularJS Quickstart - Install dependencies

Source: https://qz.io/docs/api-overrides

Install the required npm package for the AngularJS quickstart.

```bash
npm install qz-tray
```

--------------------------------

### AngularJS Quickstart - Connect and print

Source: https://qz.io/docs/api-overrides

Provide API overrides and start talking to QZ Tray using AngularJS/TypeScript. Connects, gets the default printer, logs it, disconnects, and catches errors.

```typescript
import * as qz from 'qz-tray';

qz.websocket.connect()
 .then(qz.printers.getDefault)
 .then(printer => console.log("The default printer is: " + printer))
 .then(qz.websocket.disconnect)
 .catch(err => console.error(err));
```

--------------------------------

### Property provisioning example

Source: https://qz.io/docs/provisioning

Installs a property entry during the 'certgen' phase, writing to qz-tray.properties in the installation directory. The 'data' field contains the property key-value pair.

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

--------------------------------

### Start QZ Tray service

Source: https://qz.io/docs/Windows-Service

Starts the QZ Tray service after installation. Run from an Administrator command prompt.

```batch
net start "QZ Tray"
```

--------------------------------

### Preference provisioning example

Source: https://qz.io/docs/provisioning

Installs a preference entry during the 'startup' phase, writing to prefs.properties in the user data directory. The 'data' field contains the preference key-value pair.

```json
[
   {
      "description": "Show all notifications",
      "type": "preference",
      "data": "tray.notifications=true"
   }
]
```

--------------------------------

### Cert provisioning example

Source: https://qz.io/docs/provisioning

Example provision.json entry to trust a certificate. Installed during the 'phase': 'startup' and writes an entry to allowed.dat to avoid clicking 'Remember this decision'.

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

--------------------------------

### Conf provisioning example

Source: https://qz.io/docs/provisioning

Example provision.json entry to configure the proxy by setting java.net.useSystemProxies=true in net.properties. Installed during 'phase': 'certgen' and writes to runtime/conf/<path>. Note that OpenJDK help comments in conf files will be removed.

```json
[
   {
      "description": "Configure proxy",
      "type": "conf",
      "data": "java.net.useSystemProxies=true",
      "path": "net.properties"
   }
]
```

--------------------------------

### CA provisioning example

Source: https://qz.io/docs/provisioning

Example provision.json entry to trust a self-signed certificate. Installed during the 'phase': 'certgen' and writes an 'authcert.override=self-signed.crt' entry to qz-tray.properties.

```json
[
   {
      "description": "Trusts a self-signed certificate",
      "type": "ca",
      "data": "self-signed.crt"
   }
]
```

--------------------------------

### Remover provisioning example

Source: https://qz.io/docs/provisioning

Uninstalls other QZ Tray installations. The 'data' field can be 'qz' for QZ branded installers or a comma-separated list for Company Branded builds.

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

--------------------------------

### QZ Tray command-line help (java -jar qz-tray.jar)

Source: https://qz.io/docs/command-line

Displays the full command-line help for the QZ Tray Java jar, listing information, action, option, installer, and build commands. Use this to see all available flags and their usage examples.

```text
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
```

--------------------------------

### Quick Start: Invoke ant with provision file

Source: https://qz.io/docs/provisioning

Command to invoke ant with the provision file to build a customized installer. Requires the provision.json file from the previous step.

```bash
ant -Dprovision.file=provision.json nsis
```

--------------------------------

### Get all adapter information with qz.networking.devices()

Source: https://qz.io/docs/network-information

Returns a promise that resolves to an array of objects, each containing information about a network adapter. The example logs the array to the console, showing multiple adapters with their properties.

```javascript
qz.networking.devices().then(devices => console.log(devices));

// Returns
(3) [...]
▶️ 0: {name: "Local Area Connection", ip: "192.168.1.9", ip4: Array(1), ip6: Array(1), primary: true, up: true, …}
▶️ 1: {name: "Wireless Network Connection", ip: "192.168.1.12", ip6: Array(1), primary: false, up: true, …}
▶️ 2: {name: "Loopback Adapter", ip: "127.0.0.1", ip4: Array(1), ip6: Array(1), primary: false, …}
```

--------------------------------

### Listen for printer status with qz.printers.startListening()

Source: https://qz.io/docs/printer-status

Starts listening for status events on selected printers. The first example listens to a specific printer by name, the second to all printers, and the third uses qz.printers.find() to locate a printer by best-match and then starts listening. Note that the code contains syntax errors (missing closing parentheses) as shown in the source.

```javascript
// Specific printer
qz.printers.startListening("ZDesigner LP2844")
   .catch(err => console.error(err);

// All printers
qz.printers.startListening()
   .catch(err => console.error(err)

// Based on best-match
qz.printers.find("ZDesigner").then(printer => {
   console.log("Listening for printer events", printer));
   return qz.printers.startListening(printerName);
}).catch(err => console.error(err));
```

--------------------------------

### Install Temurin 11 JDK on Ubuntu

Source: https://qz.io/docs/upgrading-java

Installs the necessary packages, downloads the Adoptium GPG key, configures the Adoptium apt repository, and installs the Temurin 11 JDK. Ensure QZ Tray and other Java-dependent software are closed before running.

```bash
# Ensure the necessary packages are present:
sudo apt-get install -y wget apt-transport-https gnupg

# Download the Eclipse Adoptium GPG key:
wget https://packages.adoptium.net/artifactory/api/gpg/key/public && sudo apt-key add public

# Configure the Eclipse Adoptium apt repository
echo "deb https://packages.adoptium.net/artifactory/deb $(awk -F= '/^VERSION_CODENAME/{print$2}' /etc/os-release) main" | sudo tee /etc/apt/sources.list.d/adoptium.list

# Install the Temurin version 11
sudo apt-get update
sudo apt-get install temurin-11-jdk
```

--------------------------------

### Install QZ Tray service with NSSM

Source: https://qz.io/docs/Windows-Service

Installs the QZ Tray service using NSSM and sets its description. Run from an Administrator command prompt.

```batch
nssm install "QZ Tray" "%PROGRAMFILES%\QZ Tray\qz-tray.bat"
nssm set "QZ Tray" Description "Browser printing utility"
```

--------------------------------

### Package installers with Ant

Source: https://qz.io/docs/compiling

Use these Ant targets to create installers for Windows, macOS, and Linux. The installer will be placed in ./out/qz-tray-x.x.x.x.

```bash
ant nsis       # <-- Windows installer
ant pkgbuild   # <-- Apple installer (macOS only)
ant makeself   # <-- Linux installer

```

--------------------------------

### Wget: Install Beta or Tagged Release

Source: https://qz.io/docs/deployment

Advanced installation using wget with parameters to specify a beta or exact tagged release. Note that a beta version may not be available.

```bash
wget -O - qz.sh |bash -s -- "beta"   # latest beta release
wget -O - qz.sh |bash -s -- "2.2.1"  # tagged "v2.2.1" release
```

--------------------------------

### Ubuntu: Install dependencies with apt

Source: https://qz.io/docs/install-dependencies

Installs the remaining dependencies (git, ant, nsis, makeself) on Ubuntu using apt. Requires AdoptOpenJDK11 or OpenJDK 8+ installed first.

```bash
sudo apt-get install git ant nsis makeself

```

--------------------------------

### Linux: Install QZ Tray with wget

Source: https://qz.io/docs/deployment

Downloads and installs the latest stable release of QZ Tray on Linux using wget.

```bash
# Download and install the latest stable release of QZ Tray
wget -O - qz.sh |bash
```

--------------------------------

### Windows: Install QZ Tray with PowerShell

Source: https://qz.io/docs/deployment

Downloads and installs the latest stable release of QZ Tray on Windows using PowerShell's irm and iex.

```powershell
# Download and install the latest stable release of QZ Tray
irm pwsh.sh | iex
```

--------------------------------

### macOS: Install QZ Tray with curl

Source: https://qz.io/docs/deployment

Downloads and installs the latest stable release of QZ Tray on macOS using curl.

```bash
# Download and install the latest stable release of QZ Tray
curl qz.sh |bash
```

--------------------------------

### Curl: Install Beta or Tagged Release

Source: https://qz.io/docs/deployment

Advanced installation using curl with parameters to specify a beta or exact tagged release. Note that a beta version may not be available.

```bash
curl qz.sh |bash -s -- "beta"   # latest beta release
curl qz.sh |bash -s -- "2.2.1"  # tagged "v2.2.1" release
```

--------------------------------

### Policy provisioning example for Chrome and Firefox

Source: https://qz.io/docs/provisioning

Example provision.json entries to disable Local Network Access for qz.io and subdomains in Chrome (chromium) and Firefox. Uses 'array' format for Chrome and 'map' format for Firefox.

```json
[
   {
      "description": "Chrome: Disable LNA for qz.io and subdomains",
      "type": "policy",
      "app": "chromium",
      "name": "LocalNetworkAccessAllowedForUrls",
      "format": "array",
      "data": "[*.]qz.io"
   },
   {
      "description": "Chrome: Disable LNA for qz.io and subdomains",
      "type": "policy",
      "app": "firefox",
      "name": "LocalNetworkAccess",
      "format": "map",
      "data": "{\"SkipDomains\": [\"*.qz.io\"] }"
   },
]
```

--------------------------------

### PowerShell: Install Beta or Tagged Release

Source: https://qz.io/docs/deployment

Advanced installation using PowerShell with parameters to specify a beta or exact tagged release. Note that a beta version may not be available.

```powershell
& ([scriptblock]::Create((irm pwsh.sh))) beta   # latest beta release
& ([scriptblock]::Create((irm pwsh.sh))) 2.2.1  # tagged "v2.2.1" release
```

--------------------------------

### Linux: Run Installer with Debug Logs

Source: https://qz.io/docs/deployment

Runs the installer on Linux with the DEBUG environment variable set to output detailed logs to the terminal.

```bash
sudo bash # or su
export DEBUG=true
./qz-tray-x.x.x.run
# Detailed logs should appear in the console
```

--------------------------------

### Start listening with jobData option

Source: https://qz.io/docs/printer-status

Start listening for printer job data by passing the jobData option to startListening. The null argument listens to all printers. This is required in addition to enabling the feature in qz-tray.properties.

```javascript
var options = {
    jobData: true,      // toggle job data
};

qz.printers.startListening(null /* all printers */, options);
```

--------------------------------

### Script variables example

Source: https://qz.io/docs/provisioning

Example Python script that uses environment variables provided by the installer, such as APP_TITLE and APP_VERSION, to display a notification.

```python
#!/usr/bin/env python3

import os

title=os.getenv('APP_TITLE')
version=os.getenv('APP_VERSION')

def notify(title, message):
  os.system(f"notify-send '{title}' '{message}'")

notify(title, "Hello from {} {}".format(title, version))
```

--------------------------------

### Sideload provision.json example

Source: https://qz.io/docs/provisioning

Example provision.json file that defines two policy steps: one for Chromium (LocalNetworkAccessAllowedForUrls) and one for Firefox (LocalNetworkAccess). The file should be placed in the provision directory inside the QZ Tray app directory. Use "phase": "certgen" for post-install tasks.

```json
[
    {
        "description": "Chromium LNA Policy",
        "type": "policy",
        "phase": "certgen",
        "os": "*",
        "app": "chromium",
        "name": "LocalNetworkAccessAllowedForUrls",
        "format": "array",
        "data": "[*.]example.com"
    },
    {
        "description": "Firefox LNA Policy",
        "type": "policy",
        "phase": "certgen",
        "os": "*",
        "app": "firefox",
        "name": "LocalNetworkAccess",
        "format": "map",
        "data": "{\"SkipDomains\":[\"*.example.com\"]}"
    }
]
```

--------------------------------

### Provisioning invocation log output

Source: https://qz.io/docs/provisioning

Example log output showing the provisioning step being invoked. The log line includes the timestamp, class, and a message indicating the step description.

```text
[INFO] 2026-04-17T15:35:15,053 @ qz.installer.provision.ProvisionInstaller:100
 [PROVISION] Invoking step 'Step { description='Chromium LNA Policy', ... }'
```

--------------------------------

### qz.file.startListening

Source: https://qz.io/docs/file

Starts listening for file change events in a specified folder, with optional filtering and listener configuration.

```APIDOC
## qz.file.startListening

### Description
Starts listening for file change events within the specified folder. The path must be a folder and can be relative or absolute (if part of approved local storage locations).

### Method
startListening

### Endpoint
qz.file.startListening(path, params)

### Parameters
- **path** (string) - Required - The folder path to listen to.
- **params** (object) - Optional - Configuration object.
  - **include** (string|array) - Optional - Files to include when listening (since 2.1.1).
  - **exclude** (string|array) - Optional - Files to exclude when listening (since 2.1.1).
  - **caseSensitive** (boolean) - Optional - Whether to use case-sensitive file matching (since 2.1.1).
  - **listener** (object) - Optional - Listener configuration. Set to `null` to prevent file data from being returned.
    - **lines** (number) - Optional - Max number of lines to read at a time. `-1` to disable.
    - **bytes** (number) - Optional - Max number of bytes to read at a time. `-1` to disable.
    - **reverse** (boolean) - Optional - Toggles whether to read from the bottom of the file.

### Request Example
```javascript
var params = { sandbox: false, shared: true, listener: { lines: 10, reverse: true } };
qz.file.startListening('.', params).then(function() {
   console.log('OK');
}).catch(function(err) {
   console.error(err);
});
```

### Response
#### Success Response
- Resolves with no value on success.

#### Error Response
- Rejects with an error object on failure.
```

--------------------------------

### Get current status of all listened printers with qz.printers.getStatus()

Source: https://qz.io/docs/printer-status

Requests the most recent status of all printers that are currently being listened to. Assumes a listener has already been added. Useful for retrieving a status that arrived before listening started.

```javascript
// Request the current status of all printers
qz.printers.getStatus().then(() => console.log("Requesting all printer statuses for listened printers"))
   .catch(err => console.error(err));
```

--------------------------------

### Get primary adapter information with qz.networking.device()

Source: https://qz.io/docs/network-information

Returns a promise that resolves to an object containing details of the primary network adapter, including hostname, IP, MAC, and more. The example logs the device object to the console.

```javascript
// Get information about a single device
qz.networking.device().then(device => console.log(device));

// Returns
▶️ {
   hostname: "inspiron",
   id: "Local Area Connection",
   ip: "192.168.1.9",
   ip4: (1) ["192.168.1.9"],
   ip6: (1) ["2001:0db8:85a3:0000:0000:8a2e:0370:7334"],
   mac: "C4910CB0B9A7",
   name: "Local Area Connection",
   primary: true,
   up: true,
   username: "Administrator"
}
```

--------------------------------

### Get USB printer port with lpinfo

Source: https://qz.io/docs/setting-up-a-raw-printer-in-osx

Use this command to list USB printer ports. The output includes the port string needed for the CUPS printer setup, such as 'usb://Zebra/LP2844'. The '?location=...' part is not needed.

```bash
lpinfo -v |grep usb
```

--------------------------------

### Linux: Silent install to default location

Source: https://qz.io/docs/deployment

Installs QZ Tray silently using the Makeself installer. Requires sudo.

```bash
sudo bash qz-tray-2.x.x.run
```

--------------------------------

### Listen for file changes with qz.file.startListening

Source: https://qz.io/docs/file

Sets up a callback for file change events and starts listening on the current folder. The listener reads up to 10 lines from the bottom of the file (reverse: true). The sandbox and shared flags are set to false and true respectively. The callback logs the event type, file path, and optional file data, or logs an error message if the event type is 'ERROR'.

```javascript
// Setup our callback for when an event occurs
qz.file.setFileCallbacks(function(streamEvent) {
   if (streamEvent.type !== 'ERROR') {
      console.log("Type: " + streamEvent.eventType);
      console.log("File: " + streamEvent.file);
      // Data is optional, toggled off by setting params to null
      console.log("Data: " + streamEvent.fileData ? streamEvent.fileData : "<none>");
   } else {
      console.error(streamEvent.message);
   }
});

// Fetch up to 10 line changes at a time, reading from the bottom
var params = { sandbox: false, shared: true, listener: { lines: 10, reverse: true } };

qz.file.startListening('.', params).then(function() {
   console.log('OK');
}).catch(function(err) {
   console.error(err);
});
```

--------------------------------

### Launch QZ Tray headless on Linux

Source: https://qz.io/docs/headless

Run the QZ Tray binary with the --headless flag to start in headless mode.

```shell
/opt/qz-tray/qz-tray --headless
```

--------------------------------

### macOS: Silent install to default location

Source: https://qz.io/docs/deployment

Installs QZ Tray silently using the macOS installer command. Requires sudo.

```bash
sudo installer -pkg qz-tray-2.x.x.pkg -target /
```

--------------------------------

### macOS: Silent install to non-standard location

Source: https://qz.io/docs/deployment

Installs QZ Tray silently to an alternate volume. Use at your own risk; non-standard install locations are currently not supported.

```bash
sudo installer -pkg qz-tray-2.x.x.pkg -target /Alternate/Volume
```

--------------------------------

### Fedora: Install dependencies with yum

Source: https://qz.io/docs/install-dependencies

Installs the remaining dependencies (git, ant, nsis, makeself) on Fedora using yum. Requires AdoptOpenJDK11 or OpenJDK 8+ installed first.

```bash
sudo yum install git ant nsis makeself

```

--------------------------------

### qz.printers.startListening

Source: https://qz.io/docs/printer-status

Documentation for the qz.printers.startListening method, which allows monitoring printer status and receiving raw job data on Windows.

```APIDOC
## [POST] qz.printers.startListening

### Description
Starts listening for printer status changes and optionally receives raw job data (e.g., .PRN file content) from the spooler. This feature is Windows-only and requires the `printer.status.jobdata=true` property in `qz-tray.properties` to be enabled.

### Method
POST

### Endpoint
qz.printers.startListening

### Parameters
#### Query Parameters
- **printer** (string) - Optional - The printer name to listen to, or `null` for all printers.

#### Request Body
- **options** (object) - Optional - Configuration options for the listener.
  - **jobData** (boolean) - Optional - Toggle to receive raw job data. Default is `false`.
  - **flavor** (string) - Optional - Format of the job data: `'base64'` or `'plain'` (default). Only applicable when `jobData` is `true`.
  - **maxJobData** (number) - Optional - Maximum size in bytes of job data to return. Default is `-1` (no limit). Only applicable when `jobData` is `true`.

### Request Example
```javascript
var options = {
    jobData: true,      // toggle job data
    flavor: 'base64',   // return spool file content as 'base64' (default is 'plain')
    maxJobData: 64      // only return data less than or equal to 64 bytes (default is -1)
};

qz.printers.startListening(null /* all printers */, options);
```

### Response
#### Success Response (200)
No explicit response body is documented. The method initiates a listener; subsequent events may be delivered asynchronously.

#### Response Example
No explicit response example is provided in the source.

### Error Handling
- If the `printer.status.jobdata` property is not set to `true` in `qz-tray.properties`, the error `Job data listeners are currently disabled` is returned when attempting to use job data.
```

--------------------------------

### Linux: Silent install as non-root user (Since 2.2.6)

Source: https://qz.io/docs/deployment

Installs QZ Tray silently without root privileges by passing the --user flag to the Makeself installer.

```bash
bash qz-tray-2.x.x.run -- --user
```

--------------------------------

### Install js-sha256

Source: https://qz.io/docs/api-overrides

Install the js-sha256 npm package for use in overriding SHA256.

```bash
npm install js-sha256
```

--------------------------------

### Mac: Install brew dependencies

Source: https://qz.io/docs/install-dependencies

Installs the required build dependencies (git, ant, makeself, nsis) via Homebrew on macOS. Optionally, use 'brew install ant --ignore-dependencies' to use a system-installed Java.

```bash
brew install git ant makeself nsis

```

--------------------------------

### Whitelist certificate on Linux

Source: https://qz.io/docs/headless

Run the QZ Tray binary with the --whitelist flag to whitelist the certificate. Verify the log entry 'Successfully added YOUR COMPANY to allowed list'.

```shell
/opt/qz-tray/qz-tray --whitelist "path/to/digital-certificate.txt"
```
Tokens:
Raw