Localization / Translation Guide

Getting Started

JetBackup supports multiple languages, and you can localize and translate our language files to your desired language.

The process to translate JetBackup will depend on your panel version, cPanel/WHM or DirectAdmin. Please pay special attention and ensure you're copying files to the paths that correspond with your Panel.

Language File Structure

The translation structure for the .json files in cPanel and DirectAdmin panels is 'key':'value'. You only need to change the value to your translation. JetBackup uses these .json files for each UI text element.
For example, to translate the word "And" to German, you would edit "And":"And", to the German the translation of: 'And':'Und'

cPanel & WHM

WHM Interface Translation

These are the paths you will need to begin translating:
/usr/local/jetapps/var/www/jetbackup5/docroot/app/lang/en/{SECTION.json}

/usr/local/jetapps/var/www/jetbackup5/docroot/app/lang/override/xx/

Step 1 - Copying the Language Files

The "en" folder contains the default English language files for JetBackup and each file corresponds to a section in the JetBackup WHM interface. These files will be used as a starting point for translating JetBackup.

  • To begin translating JetBackup, copy all the files inside the English folder to the "/override/xx" folder.
  • Rename "xx" with your preferred language code.

The "override" folder does not exist by default. You may need to create the override folder if it doesn't exist.

For all WHM sections available for translation, please check the following directory: /usr/local/jetapps/var/www/jetbackup5/docroot/app/lang/en

For a list of language codes, please refer to http://www.lingoes.net/en/translator/langcode.htm.

Step 2 - Start Translating

  • Once you have your override folder set up, you may start translating each section in your language folder by editing the associated {SECTION}.json file.

For example, to translate the JetBackup Dashboard to Spanish:

1. Create the "es" folder inside the "override" folder (/usr/local/jetapps/var/www/jetbackup5/docroot/app/lang/override/es)
2. Copy /usr/local/jetapps/var/www/jetbackup5/docroot/app/lang/en/dashboard.json to /usr/local/jetapps/var/www/jetbackup5/docroot/app/lang/override/es/dashboard.json
3. Edit the override/es/dashboard.json file in your preferred text editor and begin translating.

Here is an example snippet:

{
   "Total Accounts" : "Cuentas Totales",
   "Total Jobs" : "Trabajos Totales",
   "Total Backups" : "Copias de Seguridad Totales",
   "Jobs Running" : "Trabajos en EjecuciĆ³n",
   "New Alerts" : "Nuevas Alertas",
   "Total Accounts Usage (%s)" : "Uso Total de Cuentas (%s)"
}

Translation Example WHM

Date & Time Format

You can change the date format showing on the WHM GUI. To view the available format click on https://momentjs.com/docs/#/displaying/

date: {
            /** See the moment date format documentation: https://momentjs.com/docs/#/displaying/ **/
            short: "D MMM YYYY",
            shorttime: "D MMM YYYY hh:mm A",
            long: "ddd, MMM D, YYYY",
            longtime: "ddd, MMM D, YYYY, hh:mm A"
         }



DirectAdmin

JetBackup can be translated in DirectAdmin using the guide below. Please note that this guide only goes into detail on translating JetBackup. If you'd like to translate other areas of the DirectAdmin interface, you will need to follow their documentation here: https://help.directadmin.com/item.php?id=704

DirectAdmin has a community forum for 3rd Party Language packs on the default Evolution Skin at: https://forum.directadmin.com/forums/evolution-skin.96/

** Please exercise caution when downloading external files!

DirectAdmin Panel Translation

These are the paths you will need to begin translating for the DirectAdmin Panel:
/usr/local/jetapps/var/www/jetbackup5/docroot/app/lang/en/{SECTION.json}
/usr/local/jetapps/var/www/jetbackup5/docroot/app/lang/override/xx/
/usr/local/directadmin/plugins/jetbackup5/images/app/lang/en/{SECTION.json}
/usr/local/directadmin/plugins/jetbackup5/images/app/lang/override/xx/

Step 1 - Copying the Language Files

The "en" folder contains the default English language files for JetBackup and each file corresponds to a section in the JetBackup DirectAdmin interface.

  • To begin translating JetBackup, copy all the files inside the English folder to the "/override/xx" folder.
  • Rename "xx" with your preferred language code.

You may need to create the override folder if it doesn't exist. Please note that for DirectAdmin, you will need to create an override folder in the 2 file paths listed above.

For all sections available for translation, please check the following directory: /usr/local/directadmin/plugins/jetbackup5/images/app/lang/en/

For a list of language codes, please refer to http://www.lingoes.net/en/translator/langcode.htm.

Step 2 - Setting Permissions

Once you have your override folder set up, you will need to set the file ownership and permissions.
  • Your override folder in /usr/local/jetapps/var/www/jetbackup5/docroot/app/lang/ should be owned by root:root and permissions should be 644 for files, 755 for Directories.
  • Your override folder in /usr/local/directadmin/plugins/jetbackup5/images/app/lang/ should be owned by diradmin:diradmin and permissions should be 644 for files, 755 for Directories.

If the file ownership and permissions are not set properly, the interface will revert to the default English version regardless of any translated files.

Step 3 - Start Translating

Once permissions have been set, you may start translating each section in your language folder by editing the associated {SECTION}.json file.

For example, to translate the JetBackup Dashboard to Spanish:

1. Create the "es" folder inside the "override" folder
(/usr/local/directadmin/plugins/jetbackup5/images/app/lang/override/es/)
2. Copy /usr/local/directadmin/plugins/jetbackup5/images/app/lang/en/dashboard.json to /usr/local/directadmin/plugins/jetbackup5/images/app/lang/override/es/dashboard.json
3. Edit the override/es/dashboard.json file in your preferred text editor and begin translating.

Step 4 - Changing the Language in DirectAdmin

After translating the files, you will need to ensure the panel language for DirectAdmin is set properly. This can be done on a per-user or global basis.

  • To change the language on a per-user basis, perform the following steps:

** You may replace the "admin" text in the below path with the user account you'd like to edit.

  1. Depending on the user type, edit these configuration files.
    • Users: /usr/local/directadmin/data/users/admin/user.conf
    • Resellers: /usr/local/directadmin/data/users/admin/reseller.conf
  2. Add language=xx to the conf file and save your changes.
  3. Restart the JetBackup5 and DirectAdmin services.
  • To change the language on a global basis, perform the following steps:
  1. Open the file /usr/local/directadmin/conf/directadmin.conf in your preferred text editor.
  2. Add language=xx to the file and save your changes.
  3. Restart the JetBackup5 and DirectAdmin services.

NOTE: This will not translate the DirectAdmin UI, only JetBackup 5 will be translated globally. To add a language in DirectAdmin, click here.

Here is an example snippet from dashboard.json after translating to Spanish:

{
   "Total Accounts" : "Cuentas Totales",
   "Total Jobs" : "Trabajos Totales",
   "Total Backups" : "Copias de Seguridad Totales",
   "Jobs Running" : "Trabajos en EjecuciĆ³n",
   "New Alerts" : "Nuevas Alertas",
   "Total Accounts Usage (%s)" : "Uso Total de Cuentas (%s)"
}

Translation Example DA AdminReseller