Skip to main content
Code42 Support

Preparing The SharePlan App For Deployment

Applies to:

    Overview

    When your users first open the SharePlan app, they are prompted to enter your Code42 environment's registration settings. You can prepare deployment packages for Windows and OS X by configuring a SharePlan app installer to pre-populate the registration settings for your Code42 environment. This article explains which settings in the SharePlan app can be pre-populated and how to prepare them.

    Considerations

    • Devices must meet the SharePlan app system requirements.
    • Our Customer Champions can assist you with preparing the SharePlan app for deployment, but assistance with software deployment of the SharePlan app (such as use of Casper Suite or SCCM) is beyond the support scope of our Customer Champion team. For assistance with deployment, please contact sales to engage our PRO Services team.

    Step 1: Download custom template folder

    Download the custom content template by appending /download/SharePlan-Mac_Custom.zip to your master server's protocol, host, and port. For example:

    https://master-server.example.com:4285/download/SharePlan-Mac_Custom.zip

    Windows installers
    The folder SharePlan-Mac_Custom.zip also applies to Windows installers.

    Once you have downloaded the file SharePlan-Mac_Custom.zip, move the file to a convenient location and unzip the file to obtain the custom template folder, Code42_OSX_Custom_Installation_Package-1.0.1.

    Step 2: Prepare customized content

    A template custom.properties file is included in the custom template folder. This custom.properties file governs the general configuration and connection information for the SharePlan app, so by modifying it, you can pre-populate a configuration for your Code42 environment.

    1. Open the custom.properties file in your custom installation package with a plain text editor.
    2. Assign values, as shown below, appropriate to your Code42 environment.
    3. Save the custom.properties file.
    Property Name Example Values Notes
    address master-server.example.com:4282 Your master server's primary network address (hostname or IP address and port).
    Required, not optional, for the SharePlan app for Windows
    secondaryAddress 192.0.2.100:4282

    Your master server's secondary network address (hostname or IP address and port).
    Required, not optional, for the SharePlan app for Windows

    hideAddress true or false Show or hide the server address field during the initial registration.
    lockedAddress true or false Lock the primary and secondary address fields within the SharePlan app.
    registrationKey AAAA-BBBB-CCCC-DDDD??? Specify an organization's registration key for the SharePlan app.
    username ${username} Determined from the CP_USER_NAME command-line argument, the CP_USER_NAME environment variable, or “user.name” system property from the user interface once it launches.
    Unused values
    The template custom.properties file includes other properties that are not listed in this table. These properties are not used by the SharePlan app and have no effect on your SharePlan app deployment.

    Step 3: Generate installers

    After preparing your custom content, you are ready to create customized installers for your devices.

    Windows

    1. Download the standard SharePlan app Windows installer from your master server.
      Example URL: https://master-server.example.com:4285/download/SharePlan_Win.exe
    2. Place the installer in your custom installation package.
    Context-sensitive location
    The installer must reside at the same level in the hierarchy as the folder called custom, which contains custom.properties. You must run the installer from the correct location to install the application with the settings defined in custom.properties.

    OS X

    1. Download the standard SharePlan app OS X installer from your master server.
      Example URL: https://master-server.example.com:4285/download/SharePlan_Mac.dmg
    2. Mount the installer (DMG file).
    3. Copy SharePlan.app to the location of your custom folder.
      Do not use the command-line tool cp to copy SharePlan.app.
      Custom folder location
    4. Open Terminal.
    5. Use the cd command to navigate to the location of SharePlan.app.
      Example: cd /Users/marvin/Desktop
    6. Package the SharePlan app with tar:
      tar -cf SharePlan.app.tar SharePlan.app
      

      SharePlan.app.tar location

    Step 4: Deploy custom installers

    To install the SharePlan app on devices in your Code42 environment, run the installer (Windows) or the install.sh script (OS X) alongside the custom folder.

    Administrators commonly deploy the SharePlan app by running the installer or script using any of these methods:

    • Add your custom installers to a software distribution tool
    • Place the custom installers on a web server or intranet location
    • Copy the custom installers directly to your devices
    Location of custom installers
    In order to deploy the custom installers, you must run the installer (Windows) or install.sh script (OS X) alongside the custom folder, as described above. Simply copying an installer, or running the installers retrieved from the default download interface in the administration console, will not apply your pre-configured settings.

    Advanced topics

    If you are installing the SharePlan app with a software management tool, or installing as a user other than the device owner or end user, you may need to specify the correct username and group during the installation process.

    By default, the SharePlan app is installed with the user information of the user that initiated the install. Additional scripting is required to modify this behavior. For assistance with advanced scripting (a billable service), please contact sales.

    OS X

    Using a text editor, edit the file userInfo.sh located within the custom directory created during the customization process above. Set the following variables:

    Variable Description
    startDesktop Not used for SharePlan.
    CP_USER_HOME Not used for SharePlan.
    user Specify a user to install the SharePlan app with that user's access and file permissions on your device's file system.
    userGroup Specify a user group to install the SharePlan app with that group's access and file permissions on your device's file system.
    CP_USER_NAME Used for the unique ID for the user in your Code42 environment. Leave CP_USER_NAME blank to require the user to enter it. If setting this value, set the username attribute in the ‘custom.properties’ file to:
    username=“${username}”

    Windows

    Create an installation script for use with automated or silent installation tools. An example command-line script is provided below, but you must adapt the information provided for your specific tools and Code42 environment.

    Variable Description
    CP_USER_NAME Used for the unique ID for the user in your Code42 environment. Leave CP_USER_NAME blank to require the user to enter it. If setting this value, set the username attribute in the ‘custom.properties’ file to:
    username=“${username}”

    Windows Batch Script Example

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

    @ECHO OFF
    
    REM The LDAP login user name and the CrashPlan user name.
    SET CP_USER_NAME=%USERNAME%
    Echo UserName: %CP_USER_NAME%
    
    REM You can use any of the msiexec command-line options.
    ECHO Installing SharePlan...
    SharePlan_Win.exe /qn /l* install.log CP_USER_NAME=%CP_USER_NAME%