Hosting Control Panel Add-On User Guide

Added by Nata Ramanenka, last edited by Nata Ramanenka on Apr 15, 2009  (view change)

Hosting Control Panel Add-On User Guide

README FIRST

Welcome to the R1Soft – Hosting Control Panel Add-On User Guide

The purpose of this manual is to provide you with complete instructions on how to use your CDP Server for Hosts with a Control Panel installed. This Guide is intended for control panel users who want to restore their files.

To find a specific topic on a particular section, click on the topic name in the Table of Contents.

Common Questions

You might want to view our list of common questions located in the following document:
Common Questions

Table of Contents

Common Questions

Below is a list of common questions specific to CDP Server for Hosts with a Control Panel installed. Each question is linked to a document for further information.

Log In To CDP Server

Log In To CDP Server Using Auto-Login

cPanel users can access their Backups by logging on to the CDP Server by means of the Auto-Login icon. The icon is located in the control panel interface. In this case, the users do not need to enter the Host Name, User Name and Password.

Note
Ensim, Plesk, DirectAdmin users do not have an Auto-Login icon on their control panel interface. These users need to log in to the Righteous CDP Server directly. See Log In To CDP Server Directly.

Follow the instructions below to access the Righteous CDP Server through the cPanel Web Interface.

1. Open the Web browser that is connected to your cPanel. Enter your Username and Password and click on the "Login" button.

2. After the cPanel Interface page loads, a number of icons that provide access to different functions will be displayed. To access the Righteous CDP Server, click on the "R1Soft Restore Backups" icon.

3. You will be redirected to the CDP Server.

If the Internet browser alarms you because of security reasons, confirm your request to proceed. The following example shows the message in Internet Explorer.

4. The Righteous CDP Server Interface will load.

See also:

Log In to CDP Server Directly

Ensim, Plesk, and DirectAdmin users do not have an Auto-Login icon on their control panel interface. Such users need to access their Backups by logging in to the CDP Server directly.

Note
cPanel users can access their Backups by means of the Auto-Login icon. See Log In To CDP Server Using Auto-Login.

Follow the instructions below to log in to the Righteous CDP Server directly.

1. Open the Internet browser and enter the following address:

http(s)://CDP-SERVER/cp/

Note
If you do not know what to enter for the address, please contact your hosting service provider.

2. After the "Login" page has loaded, make sure the "Control Panel Login" option is selected from the drop-down menu.

3. Type in your Host Name. Typically your Host Name is your site domain name or IP address. Your Host Name can be the text description as well.

Note
If you do not know what to enter for Host Name, please contact your hosting service provider.

4. Enter your User Name and Password that you use to log in to your web site control panel. Click on "Login".

Note
cPanel, Plesk, and Direct Admin users should log on using the site administrator User Name and Password. Ensim users should log on using "username@domain.com" ("username" is your User Name and "domain.com" is your site domain) as User Name and use the same Password as you use for logging in to Ensim .

5. After your successful login, the Righteous CDP Server Interface will load.

Troubleshooting

  • Access denied - Wrong User Name and/or Password.
  • Host not found - Wrong Host Name.
  • Host is not configured to allow control panel user login - You can get this error if the control panel module is not enabled for your Host.

See also:

CDP Server Interface

This chapter will help the Control Panel users to get acquainted with the CDP Server interface.

Browse Page

back to Control Panel Add-On - CDP Server Interface

The "Browse" page allows you to browse your Disk Safes, Devices, and Backup Images in a file system tree. You can select combinations of files and directories to Restore.

The "Browse" page consists of two (2) panes:

  • The tree pane at the left lists all available Hosts, Disk Safes, Devices, Disk Images and backed up folders and files.
  • The right pane displays the information about the item selected in the left pane.

See also:

Accessing the Browse Page

back to Control Panel Add-On - CDP Server Interface

The "Browse" page can be accessed by clicking on the "Browse" tab. "Browse" is the default page that is displayed after you log in to the CDP Server.

See also:

History Page

back to Control Panel Add-On - CDP Server Interface

Most work performed by the CDP Server is done as a background or Scheduled Task. The Status and Log records for the Tasks are available for browsing via the History page. The History page displays Tasks specific to the your Host, i.e restore Tasks.

The History page displays the following "Task History" information for your Host:

  • State - The State of the Task.
    Success - The Task completed successfully and without errors.
    Error - The Task has completed with one (1) or more errors.
    Running - The Task is currently running.
    Queued - The Task has been queued and will run as soon as more resources are available. A Task can be queued either when the Host is locked by another Backup or Restore operation, or if the maximum simultaneous Tasks as configured by the CDP Server administrator have been reached.
    Cancelled - The Task has been cancelled.
  • Host - The name of the Host that the Task will be completed for.
  • Type - The type of Host Task. For example, "CP Restore Files."
  • Progress - Bar that displays the progress of the running Task.
  • Started - Time stamp of the date and time the task was started.
  • Finished - Time stamp of the date and time the task was completed.
  • Scheduled Task - The description of the Scheduled Task.
  • Run By -The User that ran the Task or last edited the Scheduled Task.
  • Task Log Messages - Displayed at the bottom of the "Task History" page. Read more in Task Log Messages.

See also:

Accessing Task History

back to Control Panel Add-On - CDP Server Interface

To access the History page, click on the "History" tab in the Main Menu.

See also:

Filtering Task History

back to Control Panel Add-On - CDP Server Interface

You can customize your History page by applying the Filter to the Tasks and selecting the order in which to sort and display the Tasks.
 

Note
The Task Log Messages pane also has a Filter. See Viewing Task Log Messages.


Time Filter

  • All Times
  • Last Hour
  • Last 12 Hours
  • Last 24 Hours
  • Last 48 Hours
  • Last 7 Days
  • Last 30 Days
  • Date Range - Specify the start and finish date and time.

    You can type the date or select it from the drop-down calendar which is accessible by clicking on the calendar icon.

States Filter - Allows you to only display Tasks of a specified Task State.

  • All States
  • Finished
  • Running
  • Queued
  • Canceled
  • Error
     
    Note
    The Task States are described on the History Page.

Order By

  • State
  • Type
  • Progress
  • Start Time
  • Finish Time
  • Run by
    Read more on the History Page.

Order By

  • Descending
  • Ascending

See also:

Task Log Messages

back to Control Panel Add-On - CDP Server Interface

Tasks can have the following Log Messages:

  • Level - The current State of the Task.
  • Time - The date and time the message was received.
  • Message - The Log Message.

Task Log Message Levels

A Task can be in one (1) of the following States:

  • Info - A Message logged for information purposes only.
  • Error - An error Message.
  • Warning - A warning Message.

You can view the Task Log Messages on the History page.

See also:

Viewing Task Log Messages

back to Control Panel Add-On - CDP Server Interface

Follow the instructions below to view the Task Log Messages.
 

Note
You can also download Task Log Messages. Read more in Downloading Task Log Messages.
  1. Access the History page. Read more in Accessing Task History.
     
  2. To view the Log Messages for a Task, find the Task you want to view the Log Messages for, and click on the corresponding Task Type.
  3. The Log Messages for the selected Task will be displayed at the bottom of the page. The following columns are displayed:
  • Level - The current State of the Task.
    • Info - A Message logged for information purposes only.
    • Error - An error Message.
    • Warning - A warning Message.
  • Time - The date and time the Message was received.
  • Message - The Log Message.

Log Message Filter
 

Notice
The "Log Message Filter" that allows you to manage the Messages that are displayed.

You can select from the following options in the "Log Message Filter" drop-down menu:

  • Show ALL Log Messages
  • WARNINGS and ERROR Messages
  • ERROR Messages ONLY

See also:

Downloading Task Log Messages

back to Control Panel Add-On - CDP Server Interface

Follow the instructions below to download the Task Log Messages.

  1. Access the History page. Read more in Accessing Task History.
     
  2. To download the Task Log Messages as a text file for a specific Task, click on the "Logs" link under "Actions" column corresponding to the appropriate Task on the "History" page.
  3. Alternatively, you can click on the "Disk" icon and download all of the Task Log Messages the Task History Filter (Filtering Task History) matches in one (1) large text file.

See also:

Restoring Files

You can restore either individual or all files from any available Incremental Backup. You have access only to the files in your web space. You can see the same virtual site directory as if using SSH or FTP to access your virtual site. You can only restore files into your virtual site account or directory.

You can restore files from the Browse page.

Follow the instructions below to restore files in your CDP Server.

1. Log in to the CDP Server.

Read more in Log in To CDP Server Directly and in Log In To CDP Server Using Auto-Login.

2. Select the "Browse" tab in the "Host" Menu.

Note
By default, the "Browse" page typically loads automatically after you log in.

Read more in Browse Page.

3. Select a Disk Safe from the file system tree on the left.

Read more in Disk Safe.

4. Select a Device from the file system tree on the left.

Read more in Device.

5. Select a Recovery Disk Image from the file system tree on the left to begin restoring files.

Read more in Disk Image.

6. Check any combination of files and directories in the file system tree on the left.

7. To restore all files, select the check box corresponding to the Disk Image.

8. When you are finished selecting the files and directories, click on "Restore Selected Files".

9. The following settings are available when restoring files:

Restore Files Task Options:

  • Overwrite Existing Files - When enabled, any existing files or directories on your Host with the same name will be overwritten even if they are newer.
  • Encrypt file data over network - Encrypts all data in an encrypted tunnel over the network during the Restore. Enabled by default. Disabling this option can provide a small increase in the File Restore speed.
  • Restore to Alternate Location - Specify a path on the Host to restore the files to. The complete path and directory structure of all files selected will be created under the path specified here. If the specified path does not exist, it will be created.

10. After completing the settings, click on "OK" to start the Files Restore.

11. You will be redirected to the "History" page where you can track the progress and view the Task Log Messages. When the progress bar has reached 100%, your files are restored. Read more about this page in History Page.


Vocabulary

Host | Disk Safe | Device | Disk Image

Host

A Host is your server that is being backed up. Hard Disks, Partitions, and other Volumes of a Host are mounted as Devices. See Device.
You can access the backed up Devices on the Browse page. Read more in Browse Page.

Disk Safe

A Disk Safe is a Differential Block Storage Container. This technology was invented by Righteous Software to support the storage of Incremental Disk Images (see Disk Image) at the sector level for encryption and/or compression of variable length block sizes. The system delivers fast access to any Incremental as if it were a complete Disk Image with performance comparable to the native file system.

New Backups can only be stored in the most recent Disk Safe.

You can restore from any available Disk Image in any Disk Safe.

The Disk Safes of your Host are listed on the Browse page. Read more in Browse Page.

Device

A Device is the source that has been backed up. Typically a Device in your Righteous Backup consists of Hard Disks, Partitions, and other Volumes of a Host, where file systems can be mounted as Devices. Righteous Backup can back up any Device with a supported file system.

In our case, a Device includes the files in your web space. You can see the same virtual site directory as if using SSH or FTP to access your virtual site.

Disk Image

An Incremental Disk Image or Incremental is Backup Data created by one (1) Backup Task. You can restore from any Disk Image available on the Browse page. See Browse Page .

An Incremental Image contains data only from Hard Disk sectors that have changed since the previous Disk Image (complete or incremental). Incremental Backups can be up to ten (10) times smaller and quicker to complete than full Backups. If you restore an Image from an Incremental Backup, you must have the current Image as well as the last Image. Preferably, both the previous Incremental Image and the initial complete Image are available. Righteous Software delivers fast access to any Incremental as if it were a complete Disk Image with performance comparable to the native file system.

Using The R1Soft Support Portal

Getting Support

Getting support is easy at R1Soft. We are here to ensure you get the most out of your Continuous Data Backup software.

Go to our customer support portal http://support.r1soft.com

  • R1Soft tech support is staffed 6 AM - Midnight CST/CDT (GMT-6) Monday - Friday
  • Live Chat Tech Support on www.r1soft.com 6AM - 5PM CST/CDT (GMT-6) Monday - Friday
  • Nights/Weekends support staff are on-call for restore/system down emergencies
  • Telephone call-back for restore and system down emergencies

Creating a Support Portal Login

To create a login to the technical support portal go to http://support.r1soft.com and click on Signup

Creating a New Issue

First login into the technical support portal then click Create New Issue

When you create an issue you will be presented with the following issue types. Selecting the appropriate issue type will help us get you the help you need quicker:

Tech Support
Standard tech support issues.

Licensing and Billing
License key and billing help.

Restore Emergency
System down restore emergency.

Getting Emergency After Hours Support

To get help after hours for system down or restore emergencies use the online support portal at http://support.r1soft.com   Create an issue type of "Restore Emergency" or set a priority of "System Down Emergency" on a tech support issue and on-call support staff will automatically be paged after hours.



Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.