Skip to main content
Code42 Support

Adding The CrashPlan App To A System Image Install

Applies to:
  • Code42 CrashPlan (previously CrashPlan PROe)

Overview

Using deployment software such as Microsoft Deployment Toolkit, OS X Disk Utility, or many others, you can add the Code42 CrashPlan app to an operating system image installation. This allows you to install the CrashPlan app when deploying your devices to users. This article explains considerations for adding the CrashPlan app into an operating system image installation.

Considerations

  • Adding the CrashPlan app to a system image requires Code42 CrashPlan 4.3 or later.
  • Devices must meet the CrashPlan app system requirements.
  • Our Customer Champions can assist you with the required customizations to the CrashPlan app, but assistance with software deployment of the CrashPlan app (such as use of Casper Suite, SCCM, or Microsoft Deployment Toolkit) is beyond the support scope of our Customer Champion team. For assistance with deployment, please contact sales to engage our PRO Services team.

Non-Code42 products
​Information about products from other manufacturers is intended as a resource to help you get the most out of Code42 products. However, our Customer Champions cannot provide direct assistance for these products. For assistance with products not developed by Code42, contact the product's manufacturer.

Customize your CrashPlan app configuration

If you add a standard CrashPlan app installer to your system image, users must enter their own credentials and the connection information for your master server. Instead, create a CrashPlan app installer with custom settings, such as the primary network address of the enterprise server. You can also pre-populate your registration key, by creating a custom.properties file specific to your Code42 environment.

After packaging your custom installers, you are ready add them to the system image for your Code42 environment.

CrashPlan and software management tools
If you are installing the CrashPlan app with a software management tool or using a separate administrative user, you may need to specify the correct username and home path during the installation process. By default, Code42 CrashPlan sets the backup user owner and home path as the user that initiated the install. For assistance with advanced scripting to modify this behavior (a billable service), please contact sales.

Add the CrashPlan app to a system image installation

During creation of your system image, add the CrashPlan installer to a known location on the file system of the system image. Create a script or task that runs the installer using the operating system or software management tools, such as:

  • Microsoft RunOnce registry key
  • Apple Disk Utility
  • JAMF Casper Suite

The commands required to install from the command-line or terminal vary by installation type.

Choose installation type

When adding the CrashPlan app to your system image, you must decide which installation type to use for your deployment. You can add the CrashPlan app in one of two ways:

These installation types determine security features that the CrashPlan service will have on the deployed device. The table below explains the differences between the default installation and per-user installation.

  Install for everyone (default) Install per user
Username and password Single username and password for all users on the computer Individual username and password for each per-user installation

Encryption key

Single encryption key for all users on the computer

Can have individual encryption key for each per-user installation

Backup permissions

Can back up any file on the computer, aside from those contained in admin exclusions

Can only back up files that the individual user account can access, aside from those in admin exclusions
Backup archive Files included in the backup file selection back up to a single backup archive, regardless of user Each per-user installation backs up to a unique backup archive
Encrypted file system Supports encrypted files, folders, drives, and file systems that are run at a system level (for example, FileVault on OS X Lion and later) Supports encrypted files, folders, drives, and file systems that are run at the user level (for example, Windows Encrypting File System)
Restore

Can restore any files or folders within the backup file selection

Can only restore files and folders the individual user account has backed up

Deploy for everyone

To install one instance of the CrashPlan app for everyone on a device, perform an install for everyone.

Command-line installation on Windows

msiexec /i "<path_to_known_location>\CrashPlanPROe_<version>_Win.msi" /qn CP_SILENT=true /log install_log.txt
Parameter Purpose
/i CrashPlanPROe_<version>_Win.msi The installer for your version of CrashPlan.
/qn Specifies a silent installation.
CP_SILENT=true Prevents the CrashPlan app from opening on the device after installation is complete.
/log install_log.txt Creates an installation log for a given file name.

Command-line installation on OS X

installer -pkg <path_to_known_location>/CrashPlan.pkg
Parameter Purpose
-pkg CrashPlan.pkg The installer for your version of CrashPlan.

Deploy per user

To install separate instances of the CrashPlan app on a single device, perform a per-user installation.

Per-user installation on Windows devices

Run your installer from your software management tool using the following example parameters:

msiexec /i "<path_to_known_location>\<CrashPlan_version>.msi" /qn ALLUSERS=2 MSIINSTALLPERUSER=1 INSTALL_PER_USER=1 CP_SILENT=true /log install_log.txt
Parameter Purpose
msiexec /i Allows the use of Windows Installer from the command line.
<path_to_known_location>

The full directory path to the installer file.

Examples:

  • C:\Users\James\Desktop
  • D:\Downloads
<CrashPlan_version>

Replace with the file name and version of the MSI installer for your version of CrashPlan.

Examples:

  • Code42CrashPlan-x64_5.1.2_Win
  • CrashPlanPROe-x64_4.5.2_Win
/qn Specifies a silent installation.
ALLUSERS=2 MSIINSTALLPERUSER=1 INSTALL_PER_USER=1 Specifies the per-user installation context.
CP_SILENT=true Prevents the CrashPlan app from opening on the device after installation is complete.
/log install_log.txt Creates an installation log for a given file name.

Per-user installation on OS X devices

Run your installer from your software management tool using the following example parameters:

installer -pkg "<path_to_known_location>/<CrashPlan_version>.pkg" -target CurrentUserHomeDirectory
Parameter Purpose
installer -pkg Allows OS X installer packages to be run from terminal
<path_to_known_location>

The full directory path to the installer file.
Do not use the tilde character to enter a relative path.

Examples:

  • /Users/James/Desktop
  • /Users/Blaine/Downloads
<CrashPlan_version>

Replace with the file name and version of the package (PKG) file installer for your version of CrashPlan.

Example: Install CrashPlan PROe

-target CurrentUserHomeDirectory Specifies the per-user installation context.
CurrentUserHomeDirectory is an OS X domain, not an example. Do not replace this text with a path or folder on your device.

Upgrade the CrashPlan app

As you upgrade your Code42 environment to later versions, we recommend enabling the administration console's auto-upgrade devices option to keep your devices up-to-date. For more information on upgrading the CrashPlan app, refer to the Upgrading Your Environment instructions for each version.

Advanced topics

If you are installing the CrashPlan app with a software management tool, or installing from a user account other than the one who will use the CrashPlan app, you may need to specify the correct username and home path during the installation process. By default, the CrashPlan app sets its user and home path to match the device user who initiates the install. Additional scripting is required to modify this behavior. For assistance with advanced scripting (a billable service), please contact sales.

OS X

Specify User And Home Directory

Specify the installer's runtime behavior in the file userInfo.sh.

Variable

Default Values Description
startDesktop

true

If false, the CrashPlan app does not display after installation.
CP_USER_HOME $HOME The user's home directory. The CrashPlan app scans and backs up this directory immediately after installation.
user the last directory name in $HOME Used to properly set file permissions. Comments in the file describe other methods for identifying an endpoint's user.
userGroup id -gn "$user" Used to properly set file permissions.
CP_USER_NAME $user

Specifies the username in your Code42 environment.

  • If you leave CP_USER_NAME blank, the CrashPlan app prompts the user to enter it after installation.
  • If you set this value, you must also set the username attribute in the custom.properties file to:
    username=${username}

Windows

Specify User And Home Directory

For automated or silent installation using third-party management tools, an advanced script may be required.

Set the following variables as command-line options in a batch or PowerShell script that passes those values to the CrashPlan app installer:

Variable Example Values Description
CP_SILENT true or false
Default is false
If true, the CrashPlan app does not display after installation.
CP_USER_HOME C:\Users\username Specifies the user's home directory. The CrashPlan app scans and backs up this directory immediately after installation.
CP_USER_NAME username

Specifies the username in your Code42 environment.

  • If you leave CP_USER_NAME blank, the CrashPlan app prompts the user to enter it after installation.
  • If you set this value, you must also set the username attribute in the custom.properties file to:
    username=${username}
CP_REG_KEY
Optional
AAAA-BBBB-CCCC-DDDD

The registration key for an organization in your Code42 environment.

Use this variable only if the custom.properties file does not provide a registration key.

Windows Batch Script Example

This script is an example and is not guaranteed or supported.

@ECHO OFF

REM Script grabs currently logged in user and user home; installs silently. Compatible with running the installer as administrator or another user.

REM Determine which user lauched explorer.exe, presumes that this is a domain account user
for /f "TOKENS=1,2,*" %%a in ('%systemroot%\system32\tasklist.exe /FI "IMAGENAME eq explorer.exe" /FI "STATUS eq running" /FO LIST /V') do if /i "%%a %%b"=="User Name:" set _currdomain_user=%%c
REM in the case of no domain account, change "currdomain_user" to "curruser", otherwise you need the line, below, to trim out the domain and wind up with "curruser"
for /f "TOKENS=1,2 DELIMS=\" %%a in ("%_currdomain_user%") do set _currdomain=%%a & set _curruser=%%b

SET CP_USER_NAME=%_curruser%
ECHO UserName: %CP_USER_NAME%
REM The user's home directory (Windows Vista and newer), used in backup selection path variables.
SET CP_USER_HOME=C:\Users\%_curruser%
 
ECHO UserHome: %CP_USER_HOME%
REM Tells the installer not to run CrashPlan client interface following the installation.
SET CP_SILENT=true
ECHO Silent: %CP_SILENT%
SET CP_ARGS="CP_USER_NAME=%CP_USER_NAME%&CP_USER_HOME=%CP_USER_HOME%"
ECHO Arguments: %CP_ARGS%
 
REM 64-bit Windows installer. You can use any of the msiexec command-line options.
ECHO Installing CrashPlan...
"%~dp0Code42CrashPlan.msi" /qn /l* install.log CP_ARGS=%CP_ARGS% CP_SILENT=%CP_SILENT%

Linux

On Linux systems, control deployment by changing the .Custom/custom.properties before running the install script.