Installing SAFEQ Cloud Client on macOS
For macOS, the pkg installer is provided.
Installation types
Quick installation
Limitations
- The client can only be installed in local storage mode.
- Only OIDC Client authentication is supported.
- The allowConfiguration option cannot be set to true.
Prerequisites
Modify the installer name to contain your domain name in square brackets. Otherwise, the option to install the client in the quick mode will not be visible, and the installer will default to the advanced mode.
Example:safeq-cloud-client-x.x.x-setup[acme.eu.ysoft.cloud].pkg
You must enable the Allow untrusted endpoints option in the SAFEQ Cloud Web UI > Security > API access keys.
To improve your level of security, we recommend you to disable the Automatically trust new clients/servers option in Security > PKI and encryption. For regular (advanced) installation, you must create a non-default API key, as advanced installation will not work with the API settings for Quick installation.
How to
During the installation process, select Quick installation on the Installation type screen.
Advanced installation
After installation, the application will start automatically. The users don't need to restart their workstations. After initial installation, SAFEQ Cloud Client must be configured manually using the configuration dialog and the Service setup button. When pressing this button, the user will be asked for the password for the privilege elevation.
Unattended installation of the SAFEQ Cloud Client on Mac devices:
For further information, you can refer to these Jamf guides -
Jamf – deploying custom configuration profiles
Jamf – installing packages
Download this sample .plist file to update it with desired SAFEQ Cloud Client configuration parameters. Make sure the file is named as com.ysoft.safeqclient.plist
Below is a description of each of the parameters:
accountDomain
– account domain nameauthType
– User authentication type: 0 = session user, 1 = custom login, 2 = Microsoft Entra OAuth2, 5 = OpenID ConnectgatewayAddress
– SAFEQ Cloud gateway addressloginPopupType
– specify the type of the login popup: 0=no popup, 1=informational bubble, 2=dialogrefreshPeriod
– automatic synchronization period in minutes.allowLocalStorage
– true = turn on, false = turn off local storage mode of SAFEQ Cloud Client. In this mode, the jobs will be stored on Mac. This mode requires SAFEQ Cloud Client registration and authorization on SAFEQ Cloud server.storageType
– 0 = send jobs to gateway, 1 = store jobs locally. This option is only applicable when local storage mode is activated. It corresponds to the tray menu item which can select the job destination.allowConfiguration
– true = enable configuration menu item, false = disable configuration menu item.allowRememberLogin
– true = show the “Remember login” option when showing a prompt to enter a custom username and password, false = do not show this option.directOfflinePrint
– true = enable direct offline printingapiKey
– custom API key to use instead of the default one.offline
– if set to true, it will install the SAFEQ Cloud Client in offline mode, without registration or server connectivity check. See this section for details.
Example of a .plist
file:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>accountDomain</key>
<string>
acme.local</string>
<key>authType</key>
<integer>1</integer>
<key>gatewayAddress</key>
<string>server.acme.local</string>
<key>loginPopupType</key>
<integer>2</integer>
<key>refreshPeriod</key>
<integer>60</integer>
<key>allowLocalStorage</key>
<false/>
<key>offline</key>
<true/>
</dict>
</plist>
Jamf best practices
For Jamf deployment, it is recommended to use a script that runs before the pkg file is installed and copies the .plist
file to the proper location.
SAFEQ Cloud Client supports two locations for the .plist
file: /Library/Preferences
and /Library/Managed Preferences
. The latter can be used by Jamf deployment tool to deploy the preferences automatically without the custom script.
Script example:
#!/bin/bash
PLIST=/Library/Preferences/com.ysoft.safeqclient.plist
cat << EOF >$PLIST
[xml plist content]
EOF
defaults read $PLIST
Replace [xml plist context]
with the actual .plist
file.
Steps for silent installation
/Library/Preferences
if the configuration is to be shared by all users. This requires a restart of Mac devices or running the defaults read /Library/Preferences/com.ysoft.safeqclient.plist
command.
1. Copy the updated .plist
file at /Users/[username]/Library/Preferences
on Mac device
sudo cp <from path> /Library/Preferences
2. Install SAFEQ Cloud Client
sudo installer -pkg safeqclient-3.15.0-release-setup.pkg -target /
sudo installer -store -pkg safeqclient-3.15.0-release-setup.pkg -target /
3. Uninstall SAFEQ Cloud Client
sudo /Applications/safeqclient.app/Contents/MacOS/uninstall