This guide will provide step-by-step instructions on how to set up a mass deployment for the Desktop App using Munki. The instructions provided assume you have a working Munki server and properly configured clients, however, you can achieve the same result using other mass deployment tools by creating the initial_setup.config file that is described under the Installation Settings - Customizing Defaults section. Please also check out our MacOS Command Line Interface for even more advanced scripting capabilities.
Getting Started
Download the Desktop App
Import the Installer Package
Customize the Desktop App Installation
Upgrade
Customize the Desktop App Uninstallation
Set up Unattended Installation, Upgrades, and Uninstallation
End-User Configuration
Getting Started
If you have never used Munki before, we recommend testing the deployment of various types of .app and .pkg installations to familiarize yourself with the general deployment process. You can learn more on the project’s website: https://github.com/munki/munki.
Download the Desktop App for Mac
Download the Desktop App Installer
Import the Installer Package into Munki
You must have the Munki Tools package installed on your machine to complete the steps in this section. The default settings gathered by the munkiimport utility should suffice. You may customize the default settings at your discretion; however, we recommend using a consistent name when importing packages so Munki can properly identify updates to our client. If you are new to Munki, we recommend using the ‘testing’ catalog so you can test the deployment in a lab before pushing it out to all clients. For simplicity, examples in this guide will use the testing catalog.
To import the Desktop App Installer run:
/path/to/munkitools/munkiimport /path/to/EgnyteConnect_3.x.y_zzzzzz.pkg
Customize the Desktop App Installation
You will need to edit an XML configuration information for the Desktop App package if you want to customize default settings and properly handle the installation/removal of the package. On the Munki server, look in the pkgsinfo folder and open the configuration file for the Desktop App package (it is a .plist file if you used the default settings when importing the installer).
Installation Settings – Customizing Defaults
Upon first launch, the Desktop App looks for ~/Library/Application Support/Egnyte Connect/initial_setup.config in each user directory to initialize custom defaults. The following parameters can be optionally configured in the configuration file. If you do not use a parameter, the application will use the default setting from the regular installation. Note that this approach allows you to customize the app with tools other than Munki, as long as you ensure that the initial_setup.config file is placed in the correct location prior to the Desktop App running.
Sample initial_setup.config file syntax:
# Config text file format syntax. [settings] [proxy] |
Drive setting parameters:
Drive Settings [drive_#] |
|||
Settings |
Description |
Sample values |
Required |
userDomainUrl |
Egnyte domain name |
acmeinc |
Yes |
setupAuthType |
Authentication type Egnyte or Single Sign-On |
Egnyte | SSO |
Yes |
driveLabel |
Drive name or label |
MyDrive1 |
Yes |
userName |
Username for authenticating to Egnyte |
jsmith |
Optional. User will be prompted for username during when drive first mounts. |
cloudStartPath |
Cloud start path |
/Shared/ |
Optional. User can go directly to the specified folder without having to traverse your Egnyte file structure. |
Application settings parameters (optional):
Application Settings [settings] |
|||
Settings |
Description |
Sample values |
Required |
setLanguage |
Set DA's default starting language |
de_DE |
Optional. In general, specifying |
Proxy setting parameters (optional):
Web Proxy [proxy] |
|||
Settings |
Description |
Sample values |
Required |
isProxyEnabled |
Enable or disable proxy usage |
YES | NO |
No. Default will be No if not specified. |
proxyServer |
Proxy server URL |
proxy.mycompany.com |
Yes, if isProxyEnabled is enabled. |
proxyServerPort |
Proxy server port number |
80 |
Yes, if isProxyEnabled is enabled. |
proxyType |
Proxy server type |
HTTP | HTTPS | SOCKS |
Yes, bled. |
isProxyAuthenticated |
Enable if proxy requires authentication |
YES | NO |
No. Default will be No if not specified. |
proxyUserName |
Username for proxy server |
jsmith |
No |
proxyPassword |
Password for proxy server |
MyPassword123!@# |
No |
Sample script: This will create and preconfigure a drive for the current user profile on the target Mac.
<key>preinstall_script</key>
<string>#!/bin/sh
configFile=/tmp/initial_setup.config
echo "[drive_1]" > $configFile
echo " userDomainUrl=acmeinc" >> $configFile
echo " setupAuthType=egnyte" >> $configFile
echo " driveLabel=acmeinc" >> $configFile
echo " userName=admin" >> $configFile
userName=$(whoami)
mkdir "/Users/$userName/Library/Application Support/Egnyte Connect"
chown $userName "/Users/$userName/Library/Application Support/Egnyte Connect"
chmod 755 "/Users/$userName/Library/Application Support/Egnyte Connect"
cp "/tmp/initial_setup.config" "/Users/$userName/Library/Application Support/Egnyte Connect/initial_setup.config"
</string>
Remember, if you want to test this now, make sure to save your changes and rebuild your catalogs using the makecatalogs utility.
Upgrading to a New Version
As usual with Munki, you should import the new version of the Desktop App installer. The import utility should recognize the package and use the old installer as a template. If this is not working, make sure you are using the same name for the package as used before and ensure that the version numbers from the previous and updated installers are correct.
Customize Desktop App Uninstallation
Uninstaller App
Removing the software involves running the Egnyte Connect Uninstaller.app that is located in ~/Library/Application Support/Egnyte Connect.
Example:
<key>uninstall_method</key>
<string>uninstall_script</string>
<key>uninstall_script</key>
<string>#!/bin/sh
open ~/Library/Application\ Support/Egnyte\ Connect/Egnyte \Connect\ Uninstaller.app
</string>
Set up Unattended Installation, Upgrades, and Uninstallation
Make sure your pkgsinfo files include the following keys and settings.
<key>unattended_install</key>
<true/>
<key>unattended_uninstall</key>
<true/>
<key>uninstallable</key>
<true/>
End-User Configuration
Once installed, the end-user will need to launch Egnyte Connect from the Applications folder to run it for the first time. They will be prompted to enter their username (if not specified) and password at this step.
You may want to share the training videos provided in the link below with your end-users. Under Cloud Collaboration, they can play the Egnyte Desktop App training video.
http://www.egnyte.com/file-server/videos.html