Customize your Code42 console
Who is this article for?
Instructor, no.
Incydr Professional, Enterprise, Horizon, and Gov F2, no.
Incydr Basic, Advanced, and Gov F1, no.
CrashPlan Cloud, no.
Retired product plans, yes.
CrashPlan for Small Business, no.
Overview
You can customize these elements of the Code42 console:
- Code42 console images
- Code42 console labels
- Button colors on the sign-in screen
- Account recovery links on the sign-in screen
This tutorial describes how to make these customizations.
Considerations
- Custom labels and buttons are not automatically preserved when a server upgrades from 5.3.x or earlier.
- 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 Customer Success Manager (CSM) to engage the Code42 Professional Services team.
- Customizing Code42 console images can be performed by all users with access to the Code42 console because that process uses the Code42 API.
Customize Code42 console images
The Code42 console supports customization of two images:
- The sign-in screen logo
- The Code42 console header
You must use the Code42 API to customize images in your Code42 console.
Before you begin
- If you are not familiar with API usage, we recommend that you familiarize yourself with Code42 API syntax and usage before performing these steps.
- You can choose from many tools to interact with the Code42 API.
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.
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
https://master-server.example.com:4285
When prompted after running the request, enter the password corresponding to the username
.
Examples with curl
- Sending the sign-in screen logo:
curl -skvu 'username' -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' -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 Code42 console labels
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
- Open or create the file properties.json.
- 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" } }
- 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í" }, }
- Save your changes to the file.
- Clear your browser's cache, and open the Code42 console to view your changes.
When upgrading from Code42 server version 5.3 or earlier, manually copy customization from the old customization file to the new one.
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 | |
---|---|---|---|
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 |
Customize sign-in screen button colors
You can customize the colors of buttons on your Code42 console's sign-in screen using custom CSS specifications.
- 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
- Open or create the file properties.json
- Paste the following into that file:
{ "buttonColor": "#5238AF" }
- 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. - Save the file.
- Clear your browser's cache and open your Code42 console's sign-in screen to see your customized button colors.
Show account recovery links
The Code42 console sign-in screen can display two account recovery links:
- Sign up for an account
- Forgot your password?
These links are hidden by default. To show these links:
- 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
- Open or create the file properties.json
- Add the following to properties.json:
{ "showAccountRecoveryLinks": true }
- Save the file.
- Clear your browser's cache and open your Code42 console's sign-in screen to see your account recovery links.
Related topics
Learn more: Code42 Education Pass training videos