Skip to main content
Skip table of contents

Installation

MyQ Desktop Client can also be deployed in managed environments with Intune, learn more here.

MyQ Desktop Client for macOS (MDC) can be manually installed to a single user’s workstation, or remotely installed to multiple workstations using Apple Remote Desktop.

Before the Installation

Parameters in the Installer Name

The Server Address, Server Port, and Security Mode can be set by editing the Installer file name.

The installer can be named following the structure:

(MyQ-)DesktopClient ServerAddress-ServerPort(-Normal|Strict).pkg

A space between MyQ Desktop Client (or any other name you choose to use for the installation), and the server address is required. If a hyphen is used the entire string (for example MyQ-contoso.myq.com-8090) will be interpreted as a valid hostname and an error will prevent installation.

ServerAddress, ServerPort and Normal|Strict are properties that need to be set; content shown in rounded brackets is optional. If the security mode is omitted, Strict is used as default. Examples:

  • MyQ Desktop Client 10.2 contoso.myq.com-443.pkg

  • Desktop Client 10.2 (Patch 2) acme.com-8090-Normal.pkg

    • ServerAddress: acme.com

    • ServerPort: 8090

    • SecurityMode: Normal

Editing the preference.plist File

The preference.plist should be placed next to the installer .pkg file before the installer is run; MyQ Desktop Client will use it to configure itself on the client startup.

The Server Address, Server Port, and Security Mode can be set by editing the preference.plist file which is included in the installation package. The available security modes are Strict and Normal.

image-20241031-114646.png

Edited preference.plist file

Desktop Client Configuration

Creating and Editing Configuration Profiles

Administrators now have the option to save multiple different configurations for MyQ Desktop Client (MDC) in MyQ, so that they can deploy different configurations based on locations; for example, define different fallback printers in each of their offices or enable client spooling only for selected workstations.

It is possible to configure profiles before deploying MyQ Desktop Client 10.2+. Once MyQ Desktop Client connects to the server, it starts automatically using settings from applicable profiles if this feature is enabled.

On the MyQ Desktop Client Settings tab (MyQ, Settings, MyQ Desktop Client), you can configure the MDC settings and deployment.

You can create multiple configuration profiles, assign them to specific locations, and configure the Desktop Client’s features for that particular location.

Clients that are not matched in any of the profiles will use settings from the Default profile. If the client matches multiple profiles, the highest-matched profile in this list will be used.

image-20240807-081807.png

To create a new configuration profile for MDC:

image-20241031-112039.png

General Tab

 

image-20240719-121509.png

Printing Tab

  1. On the MyQ Desktop Client Settings tab, click Add in the top-right corner.

  2. On the General tab enter a Name for your configuration profile.

  3. In the Clients section specify which clients this configuration profile should apply to, either using an IP range or Hostnames regex. You can also add exclusions.

  4. In the Authentication section select a Client mode. In Private mode, the MDC offers a more lenient authentication and session management approach, acknowledging the trust level of a personal or assigned device. Public mode is designed with communal device security in mind, ensuring that print jobs and user sessions are managed to prevent unauthorized access. Read more about Private and Public mode here.

  5. In the Authentication choose the appropriate Login methods, from Sign in with MyQ, ID Card (requires a card reader on the user's device), and Integrated Windows Authentication (read more about Integrated Windows Authentication here).

  6. In Printer Provisioning choose to enable or disable Printer Provisioning. When disabled, printers and drivers on clients using this profile will not be updated, which can be helpful to prevent unwanted changes, while preserving past ones.

  7. On the Printing tab in the Job Processing section select a Processing method from:

    1. Secure print job forwarding: All print jobs received by the Desktop Client are automatically forwarded to the MyQ Print Server over a secure port. Desktop client is only used for authentication and accounting.

    2. Client spooling: The Desktop Client stores the job data on the computer and releases it directly to a printer upon server’s command. This lowers network usage to the server.

  8. Choose if you want to Append domain name to username, if enabled the username will be set as username@domain on the job.

  9. Enable or disable Fallback Printing, which allows users to be given an alternative method of printing during server downtime. Configure how the fallback printer is selected, the printing method, and release conditions.

  10. Enable or disable Local Print Monitoring, which allows the accounting of jobs released on local printers not managed by MyQ.

    1. Local Print Monitoring: If enabled, jobs on printers not managed by MyQ server will be accounted.

    2. Monitored ports: Enter the names of the ports that you want to monitor, separated by comma (,). You can use '*' to monitor all name-related ports (i.e.: USB* for ports USB1USB2, etc.). Leave the field empty to monitor all ports.

    3. Release conditions: Select one of the available options - Always release the job, Only if user has enough credit/quota, Only if print server is online.

  11. Click Save, your configuration profile is created and automatically applied to the MDCs of the specified clients.

Connecting to a Central Server

It is also possible to connect MyQ Desktop Client to a site via a Central Server.

  1. Edit the installer name or config file as described above to correspond to the Server Address and Server Port of the Central Server.

  2. Navigate to Sites, Edit the relevant site, and enter the IP range of the devices to be connected to this location with MDC (it is also possible to create exclusions).

    image-20240816-124806.png
  3. MDC will now connect to the specified Site server.

Manual installation

This option allows users to manually install MDC, preferences are handled by the configuration profile described above.

  1. Download the latest available version of the installation (.pkg) file from the MyQ Community portal.

  2. Double-click on the installation file. The installation wizard opens; click Continue.

  3. The Software License Agreement window opens; click Continue.

  4. In the next prompt, select Agree to agree to the terms of the software license agreement.

    image-20241101-074608.png
  5. The Destination Select window opens and you can select where you would like to install MyQ Desktop Client, and click Continue.

    image-20241101-074813.png
  6. The Installation Type window opens, where you can select the installation destination. Click Change Install Location to browse for a new destination or click Install to start the installation to the predefined destination.

    image-20241101-074637.png
  7. You are redirected to the Installation Type window, where you can click Install to start the installation.

  8. On the Authentication prompt window, enter your MacOS user’s Password and click Install Software.

  9. The Installation window opens where you can see the installation’s progress.

  10. The Summary window opens. It should indicate that the installation was successful. Click Close.

    image-20241101-074657.png
  11. The MyQ Desktop Client app is now installed and open. Check Preferences for the steps to configure it.

If the security mode is set to Normal, not Strict, the following warning is displayed after installation.

image-20241101-075205.png

Remote installation with Apple Remote Desktop

It is highly recommended to go through the manual installation in one workstation before deploying the app to multiple workstations. This way, the administrator can make sure that the installation and configuration is successful. Another advantage is that the administrator can copy the settings file of this manual installation and deploy it to the other workstations before remotely installing MDC. The settings then are applied to all the workstations, without the need to set them up individually after the installation.

The followings options must be enabled in the Mac workstations to allow the remote installation from the Apple Remote Desktop tool:

  1. In OS X, open System Preferences and click Sharing.

  2. In the Service list, select Remote Management and then click Options.

  3. Select the following options: ObserveControlOpen and quit applicationsChange settingsDelete and replace itemsRestart and shut down, Copy items.

  4. Click OK.

Sharing settings

Deploying the settings file

If you have manually installed and setup MDC, you can copy the settings file (available in /Users/<MacOSUserName>/Library/Preferences/cz.myq.mdc.plist) to the System Preferences Folder, and those settings will be applied to all the users in the Mac workstations.

  1. On the administrator Mac, open Finder and click Applications > Remote Desktop to display the main window of Apple Remote Desktop (ARD).

  2. Click All Computers in the left section of the ARD main window. The Mac workstations connected to your network are displayed in the right pane of the window.

  3. Select the desired destination Macs and click Copy in the ARD toolbar (or select Manage > Copy Items menu). The Copy Items window opens.

  4. Click Copy to copy the items to selected Macs. The progress is displayed in the main window. The result of the copy to each Mac is displayed in the Status column.

  5. The settings file is copied in: /Library/Preferences.

Deploying the settings file to multiple workstations

If the settings file is not copied, after the package installation finishes the user can configure MDC from the app’s Preferences option (see Preferences). The settings file will be created under the user’s home folder: ˜/Library/Preferences.

Deploying the Package

To deploy the package to multiple Mac workstations:

  1. On the administrator Mac, open Finder and click Applications > Remote Desktop to display the main window of Apple Remote Desktop (ARD).

  2. Click All Computers in the left section of the ARD main window. The Mac workstations connected to your network are displayed in the right pane of the window.

  3. Select the desired destination Macs and click Install in the ARD toolbar (or select Manage > Install Packages menu). The Install Packages window opens.

  4. Add the MyQ Desktop Client.pkg file (available for download in the MyQ Community portal) to the Packages list either by drag-and-drop or by locating the package using the plus (+) button.

  5. Click Install to distribute the package to the selected Macs. The installation progress is displayed in the main window. The result of the package distribution to each Mac is displayed in the Status column. 

Deploying the MDC package to multiple workstations

Installation by Admin for Normal User on the same Device

After installation of the MyQ Desktop Client, set up the connection to the MyQ server and save it with the admin user. Then navigate to \Library\Preferences and find cz.myq.mdc.plist.

Modify the permissions on the file - either add the other, non-admin MAC user(s) with Read & Write permissions or change rights of everyone from No access to Read & Write. After this, when logging in as the non-admin user, they will be connected to the MyQ server and after authentication, they can use MyQ Desktop Client.

image-20241031-111211.png

Adding Read & Write permissions for non-admin users

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.