– User Panel Documentation

Jb5: Dashboard

Mon, 01 Jan 0001 00:00:00 +0000

Once you open JetBackup 5, you will be greeted with the JetBackup interface and dashboard. The dashboard shows an overview of statistics, alerts and recent activities of JetBackup associated with your account.

Please note that the available sections shown here may differ from your interface depending on the permissions granted by your service provider.

JetBackup Admin Panel interface sections:

For instructions on installing JetBackup 5, please visit our Installation guide.

For first time users, check out our Getting Started guide to help you set up JetBackup.

The navigation sidebar provides access to the following sections and features in JetBackup:

Dashboard: get an overview of JetBackup's statistics, alerts and recent activites on your server.
Restore & Download: manage and execute restores and downloads for account and directory backups.
Downloads: view and access generated downloads.
Alerts: view alerts generated by JetBackup processes associated to your account.
Queue: view the progress/status and cancel queued JetBackup processes associated to your account.

Statistics

Get an overview of JetBackup's usage statistics associated with your account.

New Alerts

The total number of JetBackup alerts within the last 24 hours.

Total Backups

The total number of backups for all accounts you have ownership of.

Total Accounts Usage

The amount of disk usage for all accounts you have ownership of on the server.

Restore & Download Quick Actions

Quickly restore specific backup items/categories. Each action will navigate you to the Item Specific Restore and Download Page.

Action	Permission
Full Backups	Can Manage Full Backups, Can Manage Configuration Backups
Home Directory	Can Manage File Backups
Cron Jobs	Can Manage Cron Job Backups
Databases	Can Manage Database Backups
Database Users	Can Manage Database Backups
DNS Zones	Can Manage DNS Zone Backups
Certificates	Can Manage SSL Certificate Backups
Email Accounts	Can Manage Email Account Backups
FTP Accounts	Can Manage FTP Account Backups

JetBackup Account Quick Actions

Manage Account

The Manage Account page allows you to manage and modify your account's JetBackup settings and preferences.

Create Backup On Demand

Backup on Demand gives you the ability to create a point-in-time full accountsnapshot of your account. On-demand backups are useful right beforemaking any upgrades/changes to your account. If necessary, you can conveniently roll back to the recent on-demand backup instead of restoring the last scheduled backup.

In order to enable Backup on Demand for the End User, please ensure Backup on Demand is enabled in the Admin Settings -> Backup on Demand.

View Downloads

View and access generated backup downloads.

Queue

View and manage queued JetBackup processes(restores and downloads) associated with your account along with the status (Completed, Failed Cancelled, Pending, Processing). For resellers, this includes accounts under your ownership as well.

JetBackup 5 Version Information

This shows you the JetBackup 5 Base and Panel Version, Current TIER, and JetApps Copyright Information.

Jb5: My Account

Mon, 01 Jan 0001 00:00:00 +0000

Click on the My Account button at either the top right corner of the JetBackup User interface or on the User Dashboard to manage your account's JetBackup settings and preferences.

NOTE: Account Encryption Selection must be enabled in the Admin Panel.

Email Address

Specify the email address that JetBackup notifications associated with the account will be sent to.

Backup Type

Choose the backup type you prefer for your hosting provider to generate from your account.

Any Backups

Allows your hosting provider to generate any backup for your account.

Only Encrypted Backups

Restrict your hosting provider to exclusively generate encrypted backups for your account. This option will automatically exclude your account from all backup jobs that creates unencrypted backups.

No Backups

No Backups will be generated for your account.

Encryption Key

When selecting Only Encrypted Backups, a unique encryption key is generated for your account and you are required to specify how you prefer to store your encryption key.

Local Encryption Key

Your encryption key will be store locally on the server. Choose this option if you TRUST your hosting provider with your encryption key. Your hosting provider will be able to access your backups and perform actions on your behalf (restore and download from backups).

Since the Local Encryption Key is tied to the Local Server's JetBackup 5 Configuration. Only the local server or a server restored using the Disaster Recovery will be able to access the encrypted backups.

Remote Encryption Key

Your encyption key will only be shown once through this interface and you would need to manually copy and store this key in a safe remote place. With this option selected, you would need to provide this key to restore and download your encrypted backups and to modify your backup type preference.

Choose this option if you DON'T TRUST your hosting provider with your encryption key. Your hosting provider will NOT be able to access or perform any action with your backups on your behalf(download/restore backups) without this key.

In case of LOST KEYS, please reach out to you hosting provider to RESET your encryption key. Please note that resetting your encryption key will set ALL existing encrypted backups associated to your account INACESSIBLE and subsequently DELETED.

Privacy Options

The Right To Be Forgotten

With this option enabled, ALL JetBackup DATA associated with your TERMINATED account will be permentantly deleted after the specified number of days set by your hosting provider.

Jb5: Restore & Download

Mon, 01 Jan 0001 00:00:00 +0000

In this section, you can view, restore and download your Account backups or choose to restore specific Backup Items.

Items to Restore/Download

Each Backup Item has a specific tab for Restore or Download. The Full Account tab, by default, will include all Backup Items if available in your backup.

Full Account *
Home Directory Files
Databases **
Database Users **
Email Accounts
FTP Accounts
Cron Jobs
DNS Zones
SSL Certificates

* The Full Account restore will only restore the Backup Items the user has permission to manage. If permission to some backup items are not granted, they will not be included on the Full Backup Restore.

* NOTE: When selecting a Database for restore or download without selecting Database Users, ONLY the selected database(s) will be included. If you’re performing a “Databases” restore or download from the Databases (DB) Tab, please ensure the proper Database Users (DB Users) assigned to that Database are also selected BEFORE proceeding with the restore or download.

Restore and Download Buttons

Restore - Restore selected backups and add them to the queue. On this step, you can remove backup items from the Restore. If you'd like to remove a backup item from the Restore, click "Remove items" under the category to remove it from the Restore.
Download - Download selected backups and add them to the queue. On this step, you can remove backup items from the Download. If you'd like to remove a backup item from the download, click "Remove items" under the category to remove it from the Download.

Both options allow you to customize the items you'd like to restore or download prior to queueing it on your server.

Restore Options:

The "Restore Options" category will only show when restoring from the User Panel.

Merge live account data with backup data

This option will merge your backup data with the existing data on your account. Live data takes precedence over restore data.

Restore Conditions:

Conditions specified under the Restore Settings that would need to be accepted in order to proceed with the restoration. Restore conditions are created by your hosting provider. You will only need to acknowledge them if this section is displayed.

Restore Summary

Restore Selected Items

Now you're ready to restore! Clicking the "Restore Selected Items" button will queue the restore on your server. The restore will be added to the queue as Processing, and the status will automatically update when it's Completed.

Download Selected Items

Clicking the "Download Selected Items" will add the selected items to the queue for download. The download will be available under downloads after it has been completed. You can go to "Downloads" using the JetBackup menu and download the file.

Files/Directories

You can choose files or directories to Restore/Download on Home Directory Backup Items only.

From the "Home Directory" tab, you can change the files selected by clicking "Change Files Selection" on the selected Incremental Backup and navigating to your specific file in the file browser.

After checking the box to the left or any files/directories, make sure to click "Select Files" at the bottom to save your selection.

Then, continue by clicking the "Restore" or "Download" buttons at the bottom of the page.

Please note that you can only select files/folders to restore and download on an Incremental Backup Type. Archived/Compressed Home Directory Backups do NOT allow File Selection prior to Restore and Download.

Jb5: Downloads

Mon, 01 Jan 0001 00:00:00 +0000

In the Downloads section, you can view all downloads completed for your account from the queue.

Completed downloads are stored in the Downloads Directory. Downloads can be accessed via terminal by a user with root access.

Downloads are created with the following format: download_XXX_XXX.tar.gz

The Direct Download button in the far right column will download the .tar.gz file to your local machine.

Jb5: Alerts

Mon, 01 Jan 0001 00:00:00 +0000

This section is disabled by default and is set by your hosting provider. Please visit Permissions for more information.

In the Alerts section, you can view all alerts for the user account generated from JetBackup processes.

Alert Types

Information Alerts - Minor alerts that does not affect any JetBackup processes. You will be notified when a Backup Job starts, .
Warning Alerts - Major alerts that might affect JetBackup processes. You will be notified when backup jobs finished with status partially completed, unable to reach your destination, etc.
Critical Alerts - Major alerts that will affect JetBackup features. You will be notified when backup jobs, restore, and download processes has failed, the backup job hasn't run for a few days etc.

Days to keep alerts

Under General Settings, you're hosting provider sets the number of days to keep Alerts in JetBackup. JetBackup automatically deletes the alert(s) once it reaches the specified number of Days.

Jb5: Queue

Mon, 01 Jan 0001 00:00:00 +0000

In the queue section, you will be able to view all JetBackup processes (backups, restores and downloads) that are executed manually by you and users you have ownership of, as well as view their status(Completed, Failed, Cancelled, Pending, Processing).

By default, JetBackup will run 2 items simultaneously. You can change the number of concurrent processes that JetBackup will execute under the Performance Settings. Please note that JetBackup Settings can only be modified by your hosting provider.

Queue Types

Backup
Restore
Download

Queue Actions

View Group Items

View the individual items processed within the queued task.

Stop Items

Terminate pending or processing items from the queue.

– User Panel Documentation

Jb5: Dashboard

Navigation Sidebar

Statistics

New Alerts

Total Backups

Total Accounts Usage

Restore & Download Quick Actions

JetBackup Account Quick Actions

Manage Account

Create Backup On Demand

View Downloads

Queue

JetBackup 5 Version Information

Jb5: My Account

Email Address

Backup Type

Any Backups

Only Encrypted Backups

No Backups

Encryption Key

Local Encryption Key

Remote Encryption Key

Privacy Options

The Right To Be Forgotten

Jb5: Restore & Download

Items to Restore/Download

Restore and Download Buttons

Restore Summary

Restore Selected Items

Download Selected Items

Files/Directories

Jb5: Downloads

Jb5: Alerts

Alert Types

Days to keep alerts

Jb5: Queue

Queue Types

Queue Actions

View Group Items

Stop Items