Skip to main content
Code42 Support

Customize your administration console

Applies to:
  • Code42 CrashPlan (previously CrashPlan PROe)

Overview

You can customize these elements of the administration console:

  • Administration console images
  • Administration console labels
  • Button colors on the sign-in screen
  • Account recovery links on the sign-in screen
  • The administration console's welcome widget

This tutorial describes how to make these customizations.

Applies to

  • Customization options are available in Code42 servers version 5.2 and later.
  • The welcome widget only appears in Code42 servers version 5.2.x and earlier.

Considerations

  • Version 5.4.0 of the Code42 server changes the process for customizing administration console labels and button colors. The change means that custom labels and buttons are not automatically preserved when a server upgrades from 5.3.x or earlier to 5.4.x or later.
  • If you use managed appliances, you cannot perform most of these customizations because they require access to your Code42 server's file system. If you use managed appliances, contact your PRO Services representative.
  • Customizing administration console images can be performed by all users with access to the administration console because that process uses the Code42 API.

Customize administration console images

The administration console supports customization of two images:

  • The sign-in screen logo
  • The administration console header

You must use the Code42 API to customize images in your administration console.

Before you begin

Step 1: Prepare your custom images

Your custom images must meet the requirements provided below for file name, file format, and image dimensions.

Image Supported Filenames Supported Formats Supported Vertical Size Supported Horizontal Size
Sign-in screen logo logo-login.png PNG Up to 36 px Up to 160 px
Header logo

logo-header.png

PNG Up to 36 px Any

Step 2: Send your images to your Code42 server with the Code42 API

To send your images to your Code42 server, use the customAsset resource of the Code42 API to send one or both images.

Further uses of customasset
For more information on using this API resource, review the customAsset resource's API documentation using the Code42 API documentation viewer.

In the following examples, replace the following items with information appropriate for your Code42 environment:

  • username
  • password
  • https://master-server.example.com:4285

Examples using curl

  • Sending the sign-in screen logo:
    curl -skvu 'username:password' -X PUT -F "customAsset=@logo-login.png" https://master-server.example.com:4285/api/CustomAsset/logo-login.png?type=image
    
  • Sending the header logo:
    curl -skvu 'username:password' -X PUT -F "customAsset=@logo-header.png" https://master-server.example.com:4285/api/CustomAsset/logo-header.png?type=image
    
  • Excerpt from a successful API request:
    > PUT /api/customAsset/logo-login.png HTTP/1.1
    ...
    < HTTP/1.1 200 OK
    ...
    {"metadata":{"timestamp":"2016-01-28T15:14:00.708-06:00","params":{}},"data":{"file":"logo-login.png","isCustom":true}}
    

Customize administration console labels

Code42 server versions 5.4 and later

  1. On your Code42 server's file system, navigate to, or create, the custom folder:
    • Linux: /opt/proserver/content-custom/Default-custom/shared/custom
    • Windows: C:\Program Files\CrashPlan PROe Server\content-custom\Default-custom\shared\custom
    • Mac: /Applications/PROServer.app/Contents/Resources/Java/content-custom/Default-custom/shared/custom
  2. Open or create the file properties.json
  3. Add name/value pairs for each text string you want to customize. A list of supported names and values is provided below. The name/value pairs should be formatted like this: 
{
  "en": {
    "login_logo_text": "Enter your email address",
    "_placeholder_password": "Enter your password"
  }
}
  1. To customize text for different languages, update the language code (for example en, es, fr, de) . The list of available localizations is provided below. You can add multiple languages to this file. The name/value pairs should be formatted like this: 
{
  "en": {
    "login_logo_text": "email address",
    "_placeholder_password": "Enter your password"
  },
  "es": {
    "login_logo_text": "Dirección de correo electrónico de la universidad",
    "_placeholder_password": "Ponga la contraseña aquí"
  },
}
  1. Save your changes to the file.
  2. Clear your browser's cache, and open the administration console to view your changes.
Upgrading from Code42 server version 5.3 or earlier
When upgrading from Code42 server version 5.3 or earlier, manually copy customization from the old customization file to the new one.

Code42 server versions 5.2 and 5.3

  1. On your Code42 server's file system, navigate to the custom folder:
    • Linux: /opt/proserver/web/base/console/custom
    • Windows: C:\Program Files\CrashPlan PROe Server\web\base\console\custom
    • Mac: /Applications/PROServer.app/Contents/Resources/Java/web/base/console/custom
  2. Open the appropriate file for your localization, such as txt.json for US English.
    A list of supported localizations and their .json files is provided below.
  3. Add name/value pairs for each text string you want to customize.
    A list of supported names and values is provided below.
  4. Save your changes to the file.
  5. Clear your browser's cache, and open the administration console to view your changes.

Available localizations

JSON file Language Locale name
txt.json English (US) English (United States)
txt_ca.json Deprecated - this file is not applied.
txt_da.json Deprecated - this file is not applied.
txt_de_CH.json Deprecated - this file is not applied.
txt_de.json German Deutsch
txt_en_GB.json English (GB) English (United Kingdom)
txt_en.json Deprecated - this file is not applied.
txt_es_ES.json Spanish (Spain) Español (España)
txt_es.json Deprecated - this file is not applied.
txt_es_LA.json Spanish (Latin America) Español (América Latina)
txt_fi.json Deprecated - this file is not applied.
txt_fr.json French Français
txt_hu.json Deprecated - this file is not applied.
txt_it.json Italian Italiano
txt_ja.json Japanese ?????????
txt_ko.json Korean ?????????
txt_nl.json Dutch Nederlands
txt_no.json Norwegian Norsk bokmål
txt_pl.json Deprecated - this file is not applied.
txt_pt_BR.json Portuguese (Brazil) Português (Brasil)
txt_pt.json Deprecated - this file is not applied.
txt_sv.json Swedish Svenska
txt_th.json Thai ?????????
txt_tr.json Deprecated - this file is not applied.
txt_zh.json Chinese (Simplified) ??????
txt_zh_TW.json Chinese (Traditional) ?????? - ??????

Supported names and values

You can configure these name/value pairs:

Name Description Original value
Code42 server versions 5.3.x and later
  login_logo_text Additional text shown above the logo on the sign-in screen. No text is displayed by default.
  _placeholder_password Sign-in screen label for the password field Password
  _placeholder_username_or_email Sign-in screen label for the username field Username or email
  _validate_password_required Alert text when password left empty Password is required
  _validate_username_or_email Alert text when username/email left empty Username or email is required
Code42 server version 5.2.x
  login_logo_text Additional text shown above the logo on the sign-in screen. No text is displayed by default.
  _placeholder_password Sign-in screen label for the password field Password
  _placeholder_username Sign-in screen label for the username field Username or email
Code42 server versions 5.2.x and earlier
  welcomebox_enterprise_admin_p1_instructions

Second line of text in welcome widget

(displayed to users with administrative roles)

To get started, select your OS and install Code42 CrashPlan on all of your devices.
  welcomebox_enterprise_admin_p1_title Headline text in welcome widget
(displayed to users with administrative roles)
Welcome to Code42!
  welcomebox_enterprise_user_p1_instructions

Second line of text in welcome widget
(displayed to users with non-administrative roles)

To get started, select your OS and install Code42 CrashPlan on all of your devices.
  welcomebox_enterprise_user_p1_title Headline text in welcome widget
(displayed to users with non-administrative roles)
Welcome to Code42!

Customize sign-in screen button colors

Server versions 5.4 and later 

You can customize the colors of buttons on your administration console's sign-in screen using  custom CSS specifications.

  1. On your Code42 server's file system, navigate to or create the custom folder:
    • Linux: /opt/proserver/content-custom/Default-custom/shared/custom
    • Windows: C:\Program Files\CrashPlan PROe Server\content-custom\Default-custom\shared\custom
  2. Open or create the file properties.json
  3. Paste the following into that file:
    {
      "buttonColor": "#5238AF"
    }
  4. Replace the hex color code (#5238AF in the above example) with the hex color code of your desired color.
    Several online tools can help you identify a hex color code, such as W3Schools's HTML Color Picker.
  5. Save the file.
  6. Clear your browser's cache and open your administration console's sign-in screen to see your customized button colors.

Server versions 5.2 and 5.3

You can customize the colors of buttons on your administration console's sign-in screen using custom CSS specifications.

  1. On your Code42 server's file system, navigate to or create the custom folder:
    • Linux: /opt/proserver/content-custom/Default-custom/shared/custom
    • Windows: C:\Program Files\CrashPlan PROe Server\content-custom\Default-custom\shared\custom
    • Mac: /Applications/PROServer.app/Contents/Resources/Java/content-custom/Default-custom/shared/custom
  2. Open or create the file:
    • properties.json (Code42 server versions 5.4.x and later)
    • config.css (Code42 server versions 5.2.x and 5.3.x)
  3. Paste the following into that file:
    /* ============ Primary button color =========== */
    .btn.btn-flat.btn-default.c42-orange,
    .btn.btn-flat.btn-default.c42-orange:hover,
    .btn.btn-flat.btn-default[disabled],
    .btn.btn-flat.btn-default:hover[disabled] {
        background: #878787;
    }
    
  4. Replace the hex color code (#878787 in the above example) with the hex color code of your desired color.
    Several online tools can help you identify a hex color code, such as W3Schools's HTML Color Picker.
  5. Save the file.
  6. Clear your browser's cache and open your administration console's sign-in screen to see your customized button colors.

Show account recovery links

The administration console sign-in screen can display two account recovery links:

  • Sign up for an account
  • Forgot your password?

These links are hidden by default on Code42 servers version 5.2 and later. To display these links:

  1. On your Code42 server's file system, navigate to, or create, the custom folder:
    • Linux: /opt/proserver/content-custom/Default-custom/shared/custom
    • Windows: C:\Program Files\CrashPlan PROe Server\content-custom\Default-custom\shared\custom
    • Mac: /Applications/PROServer.app/Contents/Resources/Java/content-custom/Default-custom/shared/custom
  2. Open or create the file properties.json
  3. Add the following to properties.json:
    {
    "showAccountRecoveryLinks": true
    }
    
  4. Save the file.
  5. Clear your browser's cache and open your administration console's sign-in screen to see your account recovery links.

Remove the welcome widget

Code42 server version 5.2.x and earlier only. In version Code42 server 5.3.x and later, the welcome widget no longer displays.

You can temporarily prevent the welcome widget from appearing for any users when signing in to your administration console.

Considerations

  • Although removing the welcome widget is an unsupported process, this article provides information that some administrators have found useful.
    Nonstandard process
    The information presented here describes a configuration that some users have successfully implemented, but that are outside the scope of normal support. Our Customer Champions cannot assist you with tasks outside normal support, so you assume all risk of unintended behavior. However, you might find additional support from other users in our forum.
    Enterprise customers can contact sales about engaging our PRO Services team.
  • This change is not saved when you upgrade your Code42 servers to a newer version. You must repeat this process each time you upgrade.

Steps

To remove the welcome widget:

  1. On your Code42 server's file system, navigate to the custom folder:
    • Linux: /opt/proserver/content-custom/Default-custom/shared/custom
      • Versions 5.2.x and 5.3.x (custom label text): /opt/proserver/web/base/console/custom
      • Applies to servers installed as root on Ubuntu
    • Windows: C:\Program Files\CrashPlan PROe Server\content-custom\Default-custom\shared\custom
      • Versions 5.2.x and 5.3.x (custom label text): C:\Program Files\CrashPlan PROe Server\web\base\console\custom
    • OS X: /Applications/PROServer.app/Contents/Resources/Java/content-custom/Default-custom/shared/custom
      • Versions 5.2.x and 5.3.x (custom label text): /Applications/PROServer.app/Contents/Resources/Java/web/base/console/custom
  2. Open config.css in a plain text editor.
  3. Uncomment the section for the Welcome widget/ wizard to disable the welcome box widget.
  4. Save your changes to the file.

After removing the welcome widget, you can no longer use it to download CrashPlan app installers. The installers are still available from Devices > Add a new device.