Skip to main content

Who is this article for?

Incydr
Code42 for Enterprise
CrashPlan for Enterprise
CrashPlan for Small Business

Incydr, no.

CrashPlan for Enterprise, yes.

Code42 for Enterprise, yes.

CrashPlan for Small Business, no.

This article applies to on-premises authority servers.

Other available versions:

Cloud

HOME
GETTING STARTED
RELEASE NOTES
FAQS
SYSTEM STATUS
Code42 Support

Add the Code42 app installer to a gold image

Who is this article for?

Incydr
Code42 for Enterprise
CrashPlan for Enterprise
CrashPlan for Small Business

Incydr, no.

CrashPlan for Enterprise, yes.

Code42 for Enterprise, yes.

CrashPlan for Small Business, no.

This article applies to on-premises authority servers.

Other available versions:

Cloud

Overview

There are two methods for including the Code42 app in a gold image and deploying it to user devices:

  1. Use a deployment policy with a custom user detection script that excludes the usernames of administrators deploying the Code42 app. 
  2. Include only the installer files. Do not run the installer or otherwise install the app until after you deploy the gold image to a user device. The sequence is critical:
    1. Get installer files for Code42 apps.
    2. Copy your installer files to your gold image.
    3. Deploy your gold image to your devices.
    4. Run the Code42 app installers on your devices.

Considerations

  • This article uses the term gold image to describe a template for imaging user devices that includes pre-configured operating system files, settings, and applications. Other names for this concept include base image, clone image, system image, desktop image, master image, or gold master.
  • Gold images and devices must meet Code42 app system requirements.
  • Code42 Customer Champions can assist you with customization and scripts for Code42 app installers, but cannot assist you with building and deploying gold images, or with software management tools such as Jamf Pro, OS X Disk Utility, SCCM, or Microsoft Deployment Toolkit.

Method 1: Exclude administrators in your custom user detection script

Excluding specific administrator users in the custom user detection script ensures the Code42 app waits to perform the installation until the end user signs in to the device.

Sample excerpts of customer user detection scripts with excluded administrator users are listed below. See Deployment script and command reference for complete details, and contact our Customer Champions for support if you need help customizing a script for your Code42 environment.

Windows script excerpt

Copied!
REM List of Excluded users that shouldn't be used for Code42 install.
FOR %%G IN ("user1"
            "user2"
            "user3"
            "admin"
            "Administrator") DO (
            IF /I "%currentuser%"=="%%~G" GOTO NOMATCH
)

:NOMATCH
echo Excluded or null user detected (%currentuser%).  Will retry user detection in 60 minutes, or when reboot occurs.
GOTO :EOF

Mac script excerpt

Copied!
if [[ "$user" =~ ^(admin1|admin2|admin3)$ ]] || [[ -z "$user" ]]; then
    writeLog "Excluded or null username detected ($user). Will retry user detection in 60 minutes, or when reboot occurs."
    exit

Method 2: Deploy only the installer package

Code42 server version 6.0 and earlier: duplicating the installed app overwrites backup data
Do not run the Code42 app installer package before duplicating a gold image. Duplicating an installed, running instance of the Code42 app creates multiple devices with same Code42 identity, which can cause these devices to attempt to back up data to the same archive. This effectively means the most recent device to connect deletes data backed up from other devices. 

Beginning with Code42 server version 6.5, any device with a duplicate GUID is automatically detected and assigned a new GUID.

Step 1: Get installer files for Code42 apps

There are multiple ways to install Code42 apps, depending on how you wish to authenticate users and devices when the app installs and connects to a Code42 authority server.

The article Manage app installations in your Code42 environment describes four options for authority servers and Code42 apps version 6.5 and later. Select one option, and follow the instructions. But stop short of the final steps: Do not run any install command or installer executable. Instead, proceed to Step 2: Copy your installer files to your gold image.

If either your authority server or Code42 apps are older than 6.5, see the instructions "before version 6.5."

Option 1: Deploy Code42 apps silently with LDAP

For a Code42 environment that uses LDAP authentication, customize Code42 installers
to connect and authenticate automatically. No user intervention is necessary.

Option 2: Deploy Code42 apps silently with SSO

For a Code42 environment that uses SSO authentication, customize Code42 installers
to connect and authenticate automatically. No user intervention is necessary.

Option 3: Deploy Code42 apps for manual sign on

Customize Code42 installers to prompt users to sign in.

  • The app automatically connects to the Code42 authority server.
  • The app takes its username from the device and operating system.
  • The user defines the app's Code42 password.

Option 4: Install the default Code42 app

Use the default Code42 installer executable, with no customization. The app opens a desktop interface and prompts the user for:

  • Username and password
  • Registration key (the identifier for for your Code42 organization)
  • Server address (the domain and port number for the Code42 authority server)

Step 2: Copy your installer files to your gold image

How you copy your Code42 installer files onto your gold image depends on your software management tool.

How many and which files you copy also depends on your situation:

  • Installer executables are *.msi, *.dmg, or *.tgz files, depending on the image's operating system.
  • Mac installations include a plain-text configuration file, deploy.properties.
  • Installers are typically invoked with scripts that provide your custom command arguments.

Step 3: Deploy your gold image to your devices

How you deploy a gold image to devices is entirely outside the scope of this article.

Just understand that you must deploy the image before invoking the installer for the Code42 app.

Step 4: Run the Code42 app installers on your devices

Use a software management tool or the device operating system to launch a script or task that runs the Code42 app installer.

For LDAP, SSO, and manual sign on (options 1, 2, and 3 above), the installer needs to run after a user logs in to the device, because the most recently logged in username becomes the Code42 app's username.

Related topics