Egnyte Connect Desktop App for Windows Mass Deployment


Mass deployment tools allow organizations to install and update software for multiple users at once. Common examples of tools include Microsoft SCCM (System Center Configuration Manager) or deployments through the use of Group Policy Objects (GPO). For larger customers, mass deployment tools can allow admins to control deployments of software and updates.

This guide will provide step by step instructions on how to set up a Mass Deployment of the Egnyte Connect Desktop App on Windows.

Mass deployment of the Desktop App is split into two phases:

  1. Installation/Upgrade: The app is installed on the machine using an account with admin privileges. If you're only setting up a single drive per user, you can specify command-line options during installation to specify details like the domain being connected to, the drive letter and label to use, and whether SSO is being used for signing the user in.
  2. Configuration: Drives are configured on behalf of users after installation by using a new command-line tool that is shipped with the product. If configuring more than one drive per user, you must use the command-line tool.

Prerequisites

  1. Download Egnyte Connect for Windows.
  2. Review System Requirements.

Installation or Upgrade

To install or upgrade, ensure you run the installation in the context of a user with admin privileges on the machine when using your tool. When upgrading, we recommend you use the same command-line parameters that were used at install to ensure the same user experience. Do not use the msiexec option to prevent restarts, as some updates will force a system restart to ensure certain components properly start up.

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_v3.x.x.msi /qn

  • Standard silent installation for when you will be adding drives using the command-line tool (see Configuration section below).

    msiexec /i EgnyteConnect_v3.x.x.msi ED_SILENT=1 /qn
  • Silent installation using a non-standard installation directory and you will be adding drives using the command-line tool.

    msiexec /i EgnyteConnect_v3.x.x.msi ED_SILENT=1 INSTALLDIR='C:\ProgramData\Egnyte Drive' /qn

  • Installation using the standard install directory where you want to add one drive for each local user account on the machine and force SSO login to the acme.egnyte.com domain.

    msiexec /i EgnyteConnect_v3.x.x.msi ED_DRIVE_DOMAIN=acme ED_DRIVE_LABEL=acme ED_DRIVE_SSO=1 ED_DRIVE_LETTER=Z

    Note: If you want to add multiple drives for each user, install with the standard silent install command above and use the command-line tool detailed in the Configuration section of this article to add drives after installation is complete.

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).

Note: This should not be used if using the install parameters starting with ED_DRIVE_ to configure drives. If using the command-line tool to add drives, this must be set to 1.

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

Drive settings

Note:
These options can be used if you're only adding a single drive for each user. For adding multiple drives for the same user, use the command-line tool detailed in the Configuration section of this article.

ED_DRIVE_DOMAIN

Default account domain.

ED_DRIVE_LABEL

The label that will be shown at the mounted drive.

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

Maximal characters length: 30

ED_DRIVE_LETTER

Drive letter at which default account drive should be mounted.

Value: E:, F:, … X:, Y:, Z:

Note: If the letter is already in use, an available letter will be used.

Default: none

ED_DRIVE_MOUNT

Mounting point for the drive (e.g.,/Shared/). Case sensitive.

ED_DRIVE_SSO

Defines if SSO authentication should be used.

Note: This 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

 

Disabling Updates

You can control whether you want the app to notify and update users to the latest version of the Desktop App with the configuration setting in the web interface.

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 an H: drive that shows all content in the domain.

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: All cloud paths are case sensitive (e.g., You must use /Shared instead of /shared).

Best practices

Egnyte's recommendation is to use mass deployment tools and strategies that allow scripts to run against the command-line tool on user login. If running a command would have no impact (e.g., because it was already run previously), the command will simply be ignored.

Note: Multiple commands to the command-line tool must appear on separate lines in configuration scripts.

To ensure that the app is running at the time of using the tool, we recommend running the following command at the start of any configuration script to force the Desktop App to start before any commands are sent (the example below assumes you are using the default install directory for 64-bit systems at %programfiles(x86)%\Egnyte Connect - if not, replace the full path to EgnyteClient.exe accordingly).

Start "Egnyte Connect" "%programfiles(x86)%\Egnyte Connect\EgnyteClient.exe" --auto-silent

Examples of commands for adding and configuring drives

  • 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).

    EgnyteClient.exe -command add -l “Acme Drive” -d “acme” -sso use_sso -t M

    Note: Running this command twice in a row will only add one drive as a single user cannot have two drives with the same label (this is a good way to ensure that a login script that runs on every login will avoid adding the same drive every time a user logs in).
  • 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).

    EgnyteClient.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).

    EgnyteClient.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).

    EgnyteClient.exe -command add -l “Marketing” -d “acme” -sso use_sso -t M -m “/Shared/Marketing” -c connect_immediately

    EgnyteClient.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.

    EgnyteClient.exe -command disconnect -l “Marketing”

    EgnyteClient.exe -command connect -l “Marketing”
  • Remove an existing drive labeled "Acme Drive".

    EgnyteClient.exe -command remove -l “Acme Drive”

  • Modify a drive labeled "Acme Drive" to use the "M": drive letter.

    EgnyteClient.exe -command update -l "Acme Drive" -t M

  • Force silent mode during drive configuration for drive labeled 'Acme Drive'.

    EgnyteClient.exe -command connect -l "Acme Drive" --auto-silent

  • Add the /Private/<username> folder to the list of folders the user has synchronized for offline access under the drive labeled 'Acme Drive'

    EgnyteClient.exe -command sync -l "Acme Drive" -a "/Private"

    Note: Using '/Private' by itself will automatically resolve to '/Private/username'.
  • Remove the /Shared/Engineering folder from the list of folders the user has synchronized for offline access under the drive labeled 'Acme Drive'.

    EgnyteClient.exe -command sync -l "Acme Drive" -r "/Shared/Engineering"

  • Stop syncing all folders under the drive labeled 'Acme Drive' for offline access.

    EgnyteClient.exe -command sync -l "Acme Drive" -c clear_all

  • Set up a Connected folder with the user's Desktop in the drive laveled 'Acme' (note that ::egnyte_username:: resolves to the Egnyte username of the user who is logged in).

    EgnyteClient.exe -command connect_folder -l acme -a "C:\Users\%username%\Desktop" -r "/Private/::egnyte_username::/Desktop"

  • Disconnect the user's Desktop in the drive laveled 'Acme'.

    EgnyteClient.exe -command connect_folder -l acme -rm "C:\Users\%username%\Desktop"
Note: The command-line tool can be used at any time that the desktop app is running on the machine. 
Note: It's important to use the same drive label for all your users as the drive label is used as the identifier for all commands.

Uninstall the Desktop App

To uninstall, simply run the same command that was run for the upgrade or install but use /x instead of /i.

For example:
msiexec /x EgnyteConnect_v3.x.x.msi /qn

 

Egnyte Community

Egnyte Community

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