Documentation

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

• Create a custom build with your company's logo and information (also known as "white labeling").

• Purchase Company Branded + Premium Support

  • Company Branded + Premium Support is not included in standard support. Please purchase here.

• Artwork

  • SVG desktop icon
  • PNG about banner
  • PNG green, yellow, red and mask tray icons

Log in to the Company Branded section of the website

1. Navigate to https://qz.io/login/
2. Enter in the product key and click Sign In
3. Once logged in, select Company Branded

1. Fill in your company's information. These fields will be used to replace all references to "QZ" for use in files, directories, and the GUI.

   Field	Example	Description
   Application Name	QZ Tray	Main application name appears Control Panel, desktop shortcuts, etc.
   Application Abbreviation	qz-tray	Abbreviated version of your application name (qz-tray.exe, qz-tray.jar, etc.)
   Vendor Abbreviation	qz	Short name used for the local data directory (%APPDATA%\qz)
   Company Name	QZ Industries, LLC	Full company name for security dialogues, About Dialogues, and SSL Certificate
   Website URL	https://qz.io	Company website, shows in the About Dialogue
   Support Email	support@qz.io	email address that appears in the Control Panel, About Dialogue, SSL Certificate
   City	Canastota	City of business
   State/Province	NY	State/province of business
   Country	US	Country of business

2. Provide your brand's images. You will need to upload 5 images for the build process.

   Image	Format	Example	Description
   Desktop Icon	SVG		Used for the desktop shortcut
   System Tray - Mask	PNG	(48px x 48px)	Must be black and transparent only. Used for system tray icon on modern desktops
   System Tray - Default	PNG	(48px x 48px)	Used for the system tray icon on older desktops
   System Tray - Warning	PNG	(48px x 48px)	Shows in tray when the software is loading
   System Tray - Danger	PNG	(48px x 48px)	Shows in tray when the software is in an error state
   About Dialog Banner	PNG		Shows in the About Dialog

3. Provide your brand's color. This color will be applied to buttons and menu icons.
   

4. Provide any custom provisioning options. Provisioning options may include:

   • Automatic trusting of signing certificate ("Remember this decision")
   • Automatic uninstall "QZ Tray" branded versions
   • Custom Websocket Ports (e.g. change port 8181)
   • Additional provisioning features will be added as-needed/requested.

5. Request your build.

• Optional: input your email address if you would like an alert when the build is complete.
• Click "Run Build" - this process takes around 5 minutes to complete

  • This will create three installers, one for Windows(*.exe), Mac(*.pkg), and Linux(*.run)

  • All builds will be stored in this portal and can be downloaded at any time

    

For a feature of QZ Tray that HAS landed on master branch but has not yet been tagged and published in a dedicated release, perform the following steps:

1. Navigate to the Company Branded section of the portal
2. Click the version dropdown, scroll to the very top ⬆️
   
3. Locate the "+NN" build. For example, if 2.3.0 is the current release, select 2.3.0+7 or similar.
4. Configure any remaining options and click "Request the build"

For a feature of QZ Tray that has NOT YET landed on master branch but has a dedicated branch that is still pending approval (waiting on peer review, code quality, testing or other QA items), you may still build a branded version by performing the following steps:

1. Ensure the fork exists at the the qzind/tray repo: https://github.com/qzind/tray/branches/all (if it doesn't, please ask the QZ team to clone it there)
2. Locate the commit hash of the latest commit to this fork. e.g. (https://github.com/qzind/tray/commits/<branch_name>/)
3. Click the version dropdown, scroll to the very bottom ⬇️
   
4. Paste the commit hash (e.g. a1b2c3d) into the Custom Version field.
   

By request only. On occasion, QZ Support staff may build a local copy of a Company Branded using a custom Java Runtime (a custom BellSoft Liberica OpenJDK). This may happen if a particular Java fix or feature has not yet landed in Java's public general availability downloads.

Requirements by QZ Support Staff:

• Elevated access to the QZ Portal
• An API key into the BellSoft downloads (#1425)

Please contact support@qz.io to request a locally branded build. Note that not all provisioning options are available with local branded builds.