Skip to main content

This article applies to Cloud.

Other available versions:

Version 6icon.qnmark.png

Available in:

StandardPremiumEnterprise
Small Business
Code42 Support

Deployment policies reference

Overview

Configure deployment packages that install Code42 apps on your users' devices according to your specifications. Integrate your apps with SSO, for example, and install silently, without user intervention. This article describes each element of the Deployment Policies interface.

Considerations

This article assumes you understand the introduction to deployment provided by the article Prepare to deploy Code42 client apps.

These instructions apply to the Code42 cloud. If you work in an on-premises Code42 environment, see Manage app installations in your Code42 environment

To use these deployment tools, you need to sign in to your administration console as a user with the role:

Deployment policies

To view and manage deployment policies:

  1. Sign in to the administration console.
  2. Select Administration > Client Management > Deployment.

If your Code42 environment does not yet have any deployment policies, you see the option to Create New Deployment Policy. If your environment already has one or more policies, you see the Deployment Policies list.

Deployment policies list

Item Description
a Create New Policy Open the interface for defining a new Code42 app deployment policy.
b Policy name The name of the policy. Click to see policy details.
c Created On The date the policy was created.
d Created By The username of the administrator who created the policy.
e Registration Org

Code42 apps deployed with this policy register with this organization

 

The organization determines the authentication method and optional proxy address for the policy.

 

If you deactivate an organization, the associated policy will not work. The policy list displays an alert to say so.

f Edit Policy

Allows you to view and change details of the policy.

g Delete Policy

Removes the policy from your Code42 environment. Code42 apps deployed to use that policy, but not yet run and installed, will fail to install.

Policy details

In the Deployment Policies list, click a policy name to see details about the policy.

Deployment policy details

Item Description
a Policy name The name of the policy.
b Edit Policy

Change details of the policy.

c Registration Org

Code42 apps deployed with this policy register with this organization

 

The organization determines the authentication method and optional proxy address for the policy.

d Authentication

The method the registration organization uses to validate the usernames and passwords entered by users in the Code42 app.

  • Local: Username and passwords are defined in the Code42 administration console
  • SSO (<provider name>): Usernames and passwords are defined in SSO provider data.
e Auto Register Users
  • Yes: The deployment's detection script (item f below) acquires the username from the operating system. The Code42 app authenticates and backups begin automatically, provided the destination is set to auto-start.
  • No: Users must manually sign in to the Code42 app before back up starts. You have two options:
    • Advise users to self-register by clicking Sign up in the Code42 app.
    • Create user accounts and provide the credentials to users.
  •  
f

Windows Script

 

Mac Script

 

Linux Script

When the Code42 app installs, it uses a "detection script" to determine a username and home directory for its device. Scripts differ by operating systems.

  • Use default script: The default script is not an option in the Code42 cloud. You must customize the default script to provide usernames in the form of email addresses.
  • Use a custom bash/batch script: Use this option. Provide a custom script that provides a username in the form of an email address.

See Deployment script and command reference for more details.

g

Use Org Proxy URL to connect?

h Launch desktop app after install?
  • Yes: After installation on a Windows or Mac device, the Code42 app opens for the user to see and use. Not applicable on Linux.
  • No: The Code42 app does not show until the user manually opens the app.
i Last Modified The date the policy was last saved.
j

Created On

Created By

The date the policy was created.

The username of the administrator who created the policy.

k Installation properties

These strings provide arguments for a command that installs a Code42 app. Use them in your device management tool or installation scripts. See Deployment script and command reference for more details.

l Generate new token

Give the policy a new identifier string.

  • Generate a new token if you suspect unauthorized use of the deployment policy.
  • Any Code42 apps previously deployed with the policy, and not yet installed, will fail to install. You will need to install them with the new, active, deployment token.

Create or edit deployment policy

In the Deployment Policy view, select Create New Policy or Edit Policy.

Deployment policy, create

Item Description
a Policy Name Enter a name to describe and identify this policy.
b How should new users register?

Select an organization.

The configuration of the organization determines how new Code42 apps register with their Code42 environment, create accounts, and start backups.

A greyed out name is for an organization that already has a policy. For that organization, edit the existing policy.

c Authentication Method

Newly deployed Code42 apps use the authentication method defined for their organization.

  • Local: Username and passwords are defined in the Code42 administration console.
  • SSO (<provider name>): Usernames and passwords are defined in SSO provider data.
d Do you want to automatically register users?
  • No: Users must manually sign in to the Code42 app before back up starts. You have two options:
    • Advise users to self-register by clicking Sign up in the Code42 app interface.
    • Create user accounts and provide the credentials to users.
  • For local authentication, No is the only option.
  • Yes: The deployment's detection script (items f and g, below) acquires the username from the operating system. The Code42 app authenticates with SSO. Backups begin automatically, provided the destination is set to auto-start.
e Which operating systems should use this policy when installing the client?

Select which operating system you deploy Code42 apps to.

Select how Code42 apps will detect their username and home directory.

f

g

Add a custom script

When the Code42 app installs, it uses a "detection script" to determine a username and home directory for its device. For the Code42 cloud, you must provide a custom script that defines a username in the form of an email address. Custom scripts must end by writing two variables to standard output:

echo C42_USERNAME=<value>;
echo C42_USER_HOME=<value>;

For details, see Deployment script and command reference

h Do your clients need a proxy URL?
i Launch desktop app after initial install?
  • Yes: After installation on a Windows or Mac device, the Code42 app opens for the user to see and use. Not applicable on Linux.
  • No: The Code42 app does not show until the user manually opens it.

Policy saved

When you save a newly defined or edited policy, the Policy Saved dialog appears.

Deployment policy saved

Item Description
a Installation properties

Use these strings as arguments to a command that installs a Code42 app.

 

Click to copy and download the properties now, or access them later from the policy details view.

b Done Close the dialog and return to the Deployment Policies list.

Authentication mismatch

Authentication mismatch message

Mismatches occur when you:

  1. Define an organization to use SSO authentication.
  2. Assign that organization a deployment policy with auto-registration.
  3. Edit the organization to use local authentication.

The policy becomes invalid because the organization can no longer support auto-registration.

The solution is to reconfigure the organization or edit the policy.

  • Was this article helpful?