Egnyte Help Desk

Egnyte Connect Desktop App for Windows Mass Deployment Guide

Overview

This guide will provide step by step instructions on how to setup a Mass Deployment of the Egnyte Connect Desktop App on Windows. Note that the legacy method of mass deployment used by Egnyte Drive is still supported with the Desktop App's msi installer, however Egnyte recommends using the method below to facilitate smoother and more flexible deployments.

Mass deployment of the desktop app is split into two phases:

  1. Installation - where the app is installed on the machine using an account with admin privileges.
  2. Configuration - where drives are configured on behalf of users after installation by using a new command-line tool that is shipped with the product.

 

Prerequisites

Download Egnyte Connect for Windows.

Please be sure to review the System Requirements.

 

Installation

To install, ensure you run the installation in the context of a user with admin privileges on the machine.

Examples of command-line installation calls that can be used:

  • Standard installation if you want to prompt users to add their own drives:
    msiexec /i EgnyteConnect_v2.x.x.msi /qn

  • Standard silent installation for when you will be adding drives on behalf of users (see 'Configuration' section below):
    msiexec /i EgnyteConnect_v2.x.x.msi ED_SILENT=1 /qn

  • Silent installation where auto-updates are disabled:
    msiexec /i EgnyteConnect_v2.x.x.msi ED_SILENT=1 ED_AUTOUPDATE_DISABLED=1 /qn

  • Silent installation using a non-standard installation directory
    msiexec /i EgnyteConnect_v2.x.x.msi ED_SILENT=1 INSTALLDIR='C:\ProgramData\Egnyte Drive' /qn

Any combination of the following command-line parameters can be used at install:

Property

Values

INSTALLDIR

Installation directory
Default :
32bit Windows - C:\Program Files\ Egnyte Drive\
64bit Windows – C:\Program Files (x86)\ Egnyte Drive\

Silent Installation

ED_SILENT

Defines whether login prompts should be suppressed when the application is started without drives (set to 1 to suppress prompts).

Must be set to 1 if the command-line tool is being used to configure drives on behalf of users.

Value: 0 or 1

Default: 0

Proxy settings

ED_PROXY_SERVER

By default proxy settings are not used. To configure proxy settings by mass configuration proxy server must be defined.

ED_PROXY_PORT

Defines proxy port for connection settings (will be only applied if ED_PROXY_SERVER is defined)

Value: between 0 and 65535

Default: 0

ED_PROXY_PASSWORD_REQUIRED

Proxy setting required password (will be only applied if ED_PROXY_SERVER is defined)

Value: 0 or 1

Default: 0

Disable autoupdate

ED_AUTOUPDATE_DISABLED

Defines if auto update should be enabled or disabled

Value: 0 or 1

Default: 0

 

Configuration

The Desktop App includes a command-line tool that is run from the installation directory. The command-line tool can be used in the second phase of deployment to automatically add and configure drives on behalf of users. If the command-line tool is being used after a mass installation, you must use the ED_SILENT=1 flag to suppress the Desktop App prompting users to log in.

Any calls to the command-line tool should be run in the context of the user for whom drives are being configured. This allows different deployment strategies for different types of users on the same machine. For example a marketing user might be used to seeing an 'M:' drive that is mapped directly to the /Shared/Marketing folder in your organization while an employee from HR might be used to seeing a 'H:' drive that shows all content in the domain.

Egnyte's recommendation is to use mass deployment tools and strategies that allow scripts to run against the command-line tool on user login. Note that multiple commands to the command-line tool must appear on separate lines in configuration scripts.

Documentation

To see more information about what is possible with the command-line tool, run the following command in the installation directory of Egnyte:

  • EgnyteDrive.exe --help

Note that all cloud paths are case sensitive (for example, you must use '/Shared' instead of '/shared').

Examples of commands

  • Add a single drive (M:) for the ‘acme’ domain via SSO but don't connect the drive immediately (will prompt the user to log in using their SSO account) - note that running this command twice in a row will only add one drive as a single user cannot have two drives with the same label
    EgnyteDrive.exe -command add -l “Acme Drive” -d “acme” -sso use-sso -t M

  • Add a single drive (M:) for the ‘acme’ domain via SSO and connect the drive immediately (will prompt the user to log in using their SSO account)
    EgnyteDrive.exe -command add -l “Acme Drive” -d “acme” -sso use-sso -t M -c connect_immediately

  • Add a single drive (E:) for the ‘acme’ domain which will use Egnyte or AD authentication and connect the drive immediately (will prompt the user to log in using their Egnyte or AD credentials)
    EgnyteDrive.exe -command add -l “Acme Drive” -d “acme” -t E -c connect_immediately

  • Add two drives (M: and E:) connected to the Marketing and Engineering folders in the ‘acme’ domain via SSO and connect both automatically (will prompt the user to login using their SSO account for each drive added this way)
    EgnyteDrive.exe -command add -l “Marketing” -d “acme” -sso use-sso -t M -m “/Shared/Marketing” -c connect_immediately
    EgnyteDrive.exe -command add -l “Engineering” -d “acme” -sso use-sso -t E -m “/Shared/Engineering” -c connect_immediately

  • Disconnect an existing ‘Marketing’ drive and reconnect for remote troubleshooting after installation
    EgnyteDrive.exe -command disconnect -l “Marketing”
    EgnyteDrive.exe -command connect -l “Marketing”

  • Remove an existing drive labelled 'Acme Drive'
    EgnyteDrive.exe -command remove -l “Acme Drive”

  • Modify a drive labelled 'Acme Drive' to use the 'M:' drive letter
    EgnyteDrive.exe -command update -l "Acme Drive" -t M

Note that the command-line tool can be used at any time that the desktop app is running on the machine. Also note that it's important to standardize on a drive label across your organization as the drive label is used as the identifier for all commands.

 

Overview

This guide will provide step by step instructions on how to setup a Mass Deployment of the Egnyte Drive for Windows through a Windows Group Policy. The instructions provided can be augmented to satisfy internal IT standards within an organization.

 

Download Egnyte Drive for Windows

Download Egnyte Drive for Windows

Please be sure to review the System Requirements.

 

Download Orca from Microsoft MSI SDK Kit

Orca is a database table editor for creating and editing Windows Installer packages and merge modules. The tool provides a graphical interface for validation, highlighting the particular entries where validation errors or warnings occur.

This tool is only available in the Windows SDK Components for Windows Installer Developers. It is provided as an Orca.msi file. After installing the Windows SDK Components for Windows Installer Developers, double click Orca.msi to install the Orca.exe file.

  1. Download Microsoft Windows SDK.
  2. Install Microsoft MSI SDK Kit
  3. After installation you will have “ORCA” installed on the system.

 

Egnyte Drive MSI Parameters

Property

Values

INSTALLDIR

Location of the Installation File.
Default :
32bit Windows - C:\Program Files\ Egnyte Drive\
64bit Windows – C:\Program Files (x86)\ Egnyte Drive\

Drive settings

ED_DRIVE_DOMAIN

Default account domain

ED_DRIVE_LABEL

Label that will be show at mounted drive

Forbidden characters: ? < > / , * + = | \ [ ] ”

Maximal characters length: 30

ED_DRIVE_LETTER

Drive letter at which default account drive should be mounted

Value: A:, B:, … X: (if letter is already in use available letter will be used

Default: none

ED_DRIVE_MOUNT

Mounting point for default drive i.e. “/Shared/”

ED_DRIVE_SSO

Defines if SSO authentication should be used (will be only used if one of ED_DRIVE_DOMAIN, ED_DRIVE_LABEL, ED_DRIVE_LETTER, ED_DRIVE_MOUNT is defined)

Value: 0 or 1

Default: 0

Proxy settings

ED_PROXY_SERVER

By default proxy settings are not used. To configure proxy settings by mass configuration proxy server must be defined.

ED_PROXY_PORT

Defines proxy port for connection settings (will be only applied if ED_PROXY_SERVER is defined)

Value: between 0 and 65535

Default: 0

ED_PROXY_PASSWORD_REQUIRED

Proxy setting required password (will be only applied if ED_PROXY_SERVER is defined)

Value: 0 or 1

Default: 0

Disable autoupdate

ED_AUTOUPDATE_DISABLED

Defines if auto update should be enabled or disabled

Value: 0 or 1

Default: 0

 

Create MSI Transform File using ORCA

  1. Launch Orca software
  2. Click on File and Open
  3. Select the Egnyte Drive MSI file and click open
  4. Click on the Properties on the Tables Section
  5. Select Transform on the top and click on New Transform
  6. Click on Table on the top and click on Add Row
  7. Insert the following Properties and values that pertain to your environment.
  8. Click on Transform and click on Generate Transform
  9. Create a name for the Transform File and save the file to \\domain\netlogon

 

Deploy Egnyte Drive with Group Policy Object (GPO)

1. Create Group Policy Object

  1. Log into your Domain Controller
  2. Launch Group Policy Management
  3. Create Group Policy Object
    Right click on Group Policy Objects and click on New
  4. Enter a new for your GPO and click OK.
          

2. Add Software Installation

  1. Launch Group Policy Management
  2. Edit the GPO for Egnyte
  3. Navigate to Computer Configuration/Policies/Software Settings/Software Installations
  4. Click on Action, click on New, click on Package                                          
  5. Select the Egnyte Drive MSI file and click Open
  6. On the Deploy Software Window select Advanced and click Ok                            
  7. Select Modifications on the top tab and click Add                                        
  8. Select the MSI Transform File and click open
  9. Click OK to save the Software Installation

3.Attach GPO to OU

In order for the GPO to be enforced, please drag and drop the newly created GPO into an OU that contain Computer Objects so the script will be enforced.

            

4. Upgrade MSI Software

Please follow the steps from Add Software Installation. After adding in new Software Installation, you may choose to delete the old Software Installation package.

 

5. End User Configuration

After GPO policy has been pushed out to computers, upon reboot the script will install Egnyte Drive for Windows into the local machine. After user logs into the machine, they’ll be brought into the Configuration Window. Please have users configure the settings. Please click on the link below to our online training video.

http://www.egnyte.com/file-server/videos.html

 

Deploy Egnyte Drive via command line (PsExec)

The following instructions are for customers who prefer to deploy Egnyte Drive via a command line (i.e. to use with SCCM). These steps are NOT REQUIRED if you've completed the deployment using a GPO Policy.

  1. Download PStools https://technet.microsoft.com/en-us/sysinternals/pstools.aspx
  2. Run command prompt with administrator rights. Change directory to where you extract the PSTools.
  3. Example command:
    psexec \\{targetPC} -u {domain\user} -p {userPassword} msiexec /i {\\server\share\egnytedrive.msi} TRANSFORMS={customfile.mst} /qn /L*V "C:\ED-install.log"
    Replace the following parameters with the ones for your environment.
Parameter Description
targetPC IP or hostname for PC on which you wish to deploy Egnyte Drive
domain\user domain credentials with elevate rights to deploy software packages
userPassword user password
\\server\share\egnytedrive.msi path to Egnyte Drive MSI
customfile.mst name of MST file (Note: MSI and MST are located in the same directory)
Review log under C:\ labeled ED-install.log.
Egnyte Community

Egnyte Community

Want to connect with other Egnyte users and our Egnyte team? Share ideas and ask questions in our Community.

Help Improve Egnyte

Every day we work hard to make Egnyte better with feedback from users to improve our products. Sign up to participate in Egnyte User Studies.