Skip to end of metadata
Go to start of metadata

Hosting Control Panel Add-On Admin Guide

README FIRST

Welcome to the R1Soft - Control Panel Add-On Admin Guide


The purpose of this manual is to provide you with complete instructions on how to use your R1Soft Control Panel Add-On Module and to introduce some key CDP Server functions important for using the Control Panel Add-On Module. When you use Righteous Backup with the Control Panel Add-On Module, all functions found in Righteous Backup are available. Refer to the CDP Server Admin Guide and CDP Server User Guide for more information.

To find a specific topic in 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 your R1Soft Control Panel Add-On. Each set of questions is categorized for you to quickly find what you need. Each question is linked to a document for further information.

Overview

Control Panel Add-On is a special feature added for web hosting providers. The Control Panel Module provides integration with a number of control panels that can be installed on Hosts. With the Control Panel Add-On enabled for the Host, the root administrator can schedule Backups for the Host. Control panel users can access their Backups and Restore Files by themselves. While each control panel user only has access to Backups of their work space, the CDP Server root administrator can access all Backups.

The Control Panel Add-On Module can be activated for CDP Server Stand Alone or CDP Data Centers. The CDP Servers will maintain their original functionality.

Note
The Control Panel Add-On is for Linux only.

Supported Control Panels:

  • cPanel
  • Plesk
  • Ensim Pro
  • DirectAdmin
More Information
What Control Panels Are Supported? (CDP Server 2.0 Knowledge Base)

If you are going to use the Control Panel Add-On Module, start with Enabling Control Panel Module.

Enabling Control Panel Add-On



Step One - Installing the Linux Agent

Install the Linux Agent on the machine where your control panel is installed. During the installation, confirm the integration of the Agent with the Control Panel Add-On. If you have an Agent installed, reinstall the Agent and during the installation process select the necessary option. Depending on your control panel, you can enable the Auto Logon Icon.

Step One is described in detail in:

Step Two - Enabling Control Panel Add-On

The next step is to enable the Control Panel Add-On Module in the CDP Server itself.

First, you should enable the control panel check box for the Volume that you are going to add Hosts to.

Then add the Host. While setting the Host options, you will have an opportunity to select an "Enable" check box under the Agent/Host settings. If you have already added the Host, go to the Host options page in edit mode and select the "Enable Control Panel Module" check box.

Step Two is described in detail in:

Installing the Linux Agent

The Agent installer is a Linux console application. The installer can be run in the remote SSH session or on the text console. Read more in Linux Agent Getting Started Guide.

Note
It is assumed that a control panel is already installed on the machine where you are going to install the Agent. In our example, cPanel is installed.

There are several different installers for the Agent, each for its own distribution of Linux. Download the Agent for the distribution that your control panel is installed on (Red Hat, Fedora, CentOS or Debian). For example, cPanel version 11.x can be installed on Red Hat Enterprise Linux and CentOS only.

To install the Agent, perform the following steps:

1. Establish SSH connection to the Linux Host or log in on the text Linux console. You should either log in as root or obtain root permissions after log in via su or sudo command.

2. Navigate to the directory where you saved the Linux Agent installation file. The installer will be named similar to the following:

For 32-bit system

  • File Name: linux-agent-32-1.62.0-generic.run
  • File Size: from 11.6 MB to 52.2 MB (depends on the selected Linux distribution)

For 64-bit system

  • File Name: linux-agent-64-1.62.0-generic.run
  • File Size: from 11.78 MB MB to 38.29 MB (depends on the selected Linux distribution)

3. Execute the file by typing sh, followed by the file name.

Example:

sh linux-agent-32-1.62.0-generic.run

4. The "Welcome" screen is displayed, select "Next."

5. The "License Agreement" screen is displayed, select "Next" again.

6. This screen displays the "Righteous Software End User License Agreement." Read it to the end and select "Next."

7. The "Acceptance" screen is displayed, select "Yes" to accept the license agreement.

8. If you are installing a pre-built Agent package for your Linux distribution, you will see a message that the Kernel Module for your system has been found. Load the Kernel Module by selecting "Yes."

9. The Kernel Module typically loads without issues. A message that the Kernel Module has been loaded successfully will be displayed. Select "Next."

Notice
The Kernel Module is essential for running the Linux Agent. If the Kernel Module fails to load, the Linux Agent will not work. Read more in Linux Agent Guide to Custom Kernels.



10. The next screen prompts you to select if the CDP Agent will be installed into one (1) directory or split across the Linux file system tree. It is safe to leave it at default value and select "Next."

11. The following screen notifies you that one of the supported control panels is found on the current machine. You need to choose if you are going to allow control panel users to restore their files from Backups. If so, select "Yes."

12. The next screen displays a list of directories that the parts of the CDP Agent will be installed to. Select "Yes."

13. The installation process will start.

14. The next screen will provide information about the Control Panel Integration. You are asked if you would like the Auto-Login Icon to be displayed in the control panel interface. If you want the control panel users to have a direct Icon to Righteous Backups, select "Yes."

Note
The Icon can be enabled or disabled at any time by running scripts located in:
/usr/lib/buagent/control-panels/cpanel/
Note
cPanel allows you to enable Auto-Login. Ensim and Plesk do not allow you to create a link with Auto-Login to the CDP Server.



15. When the process has completed successfully, select "Yes" to start the Linux Agent.

16. The installation program will terminate and display the path where the server Key(s) should be placed as well as the full path to uninstall the program. For the Linux Host to be backed up by the server, the server Public Key should be placed in the following file:

/etc/buagent/server.allow/SERVER_IP

New in Version 1.56
IP Authentication configuration parameter has a "No" value by default. It means the Agent will only do RSA key authentication and will not check the source IP address of the connecting CDP Server.


Note
You can find more information on how to use your Linux Agent and its Command Line Interface (CLI) tools in the Linux Agent CLI Guide.



Enabling Auto-Login Icon

The Auto-Login Icon can be enabled during the Agent installation when the following screen is displayed:

The Auto-Login Icon can also be enabled or disabled at any time by running scripts located in:

/usr/lib/buagent/control-panels/cpanel/

Note
cPanel allows you to enable Auto-Login. Ensim, Plesk, and DirectAdmin do not allow you to create a link with Auto-Login to the CDP Server.
However, you can point your control panel users directly to the CDP Server:
http(s)://CDP-SERVER/cp/
Advice
The Plesk custom button feature gives the option of loading the external page within the control panel window.
Note
If https is enabled for the CDP Server, the URL will be sent as https. If http is enabled on the CDP Server, then the URL will be sent as http. The settings can be found in the Web Interface by going to "Options" > "Server Settings."
Read more in the Server Settings.

Read more in Control Panel Add-On - Accessing Backups.

Adding Volumes

Follow the instructions below to create a Volume with the Control Panel Module enabled in your CDP Server Stand Alone or Data Center.

1. Open the Web browser connecting to the CDP Server Web Interface and log in.

2. Click on "Volumes" in the Main Menu to access the "Volumes" page.

3. Click on "New Volume".

Note
When a new CDP Server is installed, a default Volume is automatically created.
New in Version 2.5
The Volume List Filter allows you to find Volumes in the list by entering parameters.

4. When the "New Volume" form has loaded, define the following settings:

Note
Volume ID - A global unique ID assigned by the Backup System after the Volume is created.
  • Volume Name - Enter a description for the Volume.
  • Max Linux Hosts - The number of Linux Agent licenses or Hosts assigned to the Volume compared with the number allowed.
  • Max Windows Hosts - The number of Windows Agent licenses or Hosts assigned to the Volume compared with the number allowed.
    Note
    Default is unlimited.
  • Max CDP for MySQL Add-ons - The number of CDP for MySQL Add-ons, Agent licenses or Hosts assigned to the Volume compared with the number allowed.
    Note
    Default is unlimited.
    Note
    The Control Panel Add-On Module is usually used with the MySQL Add-On Module.
  • Enable Control Panel Module - Select the check box to enable the control panel module for every assigned Host.
  • Schedule Frequency Allowed (New in Version 2.5)- Ability to define Backup schedules allowed for a specific Volume. You can select one (1) or several options: "Minutely," "Hourly," "Daily," "Weekly," or "Monthly."
  • Max Archiving Add-ons (New in Version 2.9) - You can limit the maximum number of
    used archiving add-ons.  
  • Storage Pool- The Storage Pool to assign this Volume to. The Storage Pool represents the underlying directory or directories where the actual Backup Data will be stored.
    See Storage Pools.
  • Use Quota - Select the check box for a Quota to be applied to this Volume as defined in the "Limit" field.
    Note
    Default is unlimited.
  • Limit - The Quota in bytes. The Quota applies to all Hosts and Disk Safes assigned to the Volume.

5. Click on "OK" to save the new Volume.

Enabling Control Panel Add-On for a Volume

If you have already created a Volume, make sure that the Volume has the Control Panel Module enabled.

Follow the instructions below to enable the Control Panel Add-On for the Volume in your CDP Server Stand Alone or Data Center.

1. Open the Web browser connecting to the CDP Server Web Interface and log in.

2. Click on "Volumes" in the Main Menu to access the "Volumes" page.

3. The "Volumes" page will list all existing Volumes. The current settings are displayed in the table.

New in Version 2.5
The Volume List Filter allows you to find Volumes in the list by entering parameters.

To change the existing Volume settings, click on the "Open" link under "Actions" for the corresponding Volume in the list.  Alternatively, you can click on the Volume name.

4. Click on "Change" to view the Volume settings in the edit mode.

5. Select the "Enable Control Panel Module" check box.

6. Verify the "Max CDP for MySQL Add-ons" value.

Note
The Control Panel Add-On Module is usually used with the MySQL Add-On Module.

7. Click on "OK" to save the changes.



Adding Hosts

Hosts are computers and servers that are being backed up.

Notice
It is assumed that you have added Server Keys to the Host. Read more in Activating the Linux Agent.
Notice
Volumes must be added before creating Hosts. See Control Panel Add-On - Adding Volumes.

Follow the instructions below to add a new Host with the Control Panel Module enabled in your CDP Server Stand Alone or Data Center.

1. Open the Web browser connecting to the CDP Server Web Interface and log in.

2. When the page has loaded, you should see the "Hosts" tab in the interface. If the "Hosts" page does not open, click on the "Hosts" tab.

Note
The "Hosts" page typically loads automatically after you log in.

3. Click on "New Host".

4. When the "New Host" form has loaded, define the Backup-related settings specific to each defined Host.

Network Settings
  • Host Name or IP - Enter the Host Name or IP address of the Host.
    Note
    If you have Hosts with same IP addresses but with different ports in your environment, create several DNS names that resolve to the Host IPs. Use Agent port setting (Agent Settings) in the CDP Server.
  • Host Description (New in Version 2) - Enter a Description for the Host. The Description will be displayed in the Host List and used for control panel authentication.
  • Host Type - Specifies the Host's operating system and license type (Linux Control Panels are supported).
  • Remote Port (New in Version 2) - Define a Port to connect to the Agent if different from default value.
  • Timeout (New in Version 2) - Define a Timeout to connect to the Agent if different from default value.
  • Use Default Network Settings (New in Version 2.5.x) - Select this check box to use the default Remote Port and Timeout. Defaults are usually defined by the system admin in Options > Server Settings > Agent Settings. Read more in Agent Settings.
Licensed Add-on Modules
  • Enable Control Panel Module - Select this check box to enable the Control Panel module. 
  • Enable CDP for MySQL Module - Select this check box to restore MySQL databases separately from another Host's information. Available only for Linux hosts. The Control Panel Add-On Module is normally used with the MySQL Add-On Module.
    Note
    You need to buy a license to use this module. Read more in the CDP for MySQL User Guide.
  • Enable Archiving Module (New in Version 2.9.0) - Select this check box to enable the Archiving add-on. Note: You need to buy a license to use this module.
Storage Settings
  • Volume - Select the Volume where Backups will be stored. Read more in Volumes.
  • Enforce Disk Safe Storage Quota - Select this check box to enable a Disk Quota for the Host. Read more in Host Quotas.
  • Hard Limit - Define the Quota for the Host.
Other Options
  • Create Disk Safe Next - Checked by default. For more information on creating a new Disk Safe for storing Backup Data, see Linux CDP Server - Creating Disk Safes (Step 6).
  • Disable Host After Creating - Select this check box to disable the Host.

5. Make sure the Host Description necessary for control panel authentication has been entered.

Make sure the "Enable Control Panel Module" and the "Enable CDP for MySQL Module" options are enabled.

6. Click on "OK" to continue.

7. Create a new Disk Safe for the Host. For more information, see Linux CDP Server - Creating Disk Safes.

Note
After a new Host is added to the system, a Host Discovery Task is automatically run. The Host Discovery Task adds a new Host to the Backup system and discovers Devices available for Backup. Read more in Host Discovery.

8. Click on the "History" tab in the Main Menu to view the status of the Host Discovery Task that was automatically launched when the Host was added.

Note
If the Host Discovery Task was successful, a green icon ( ) will be displayed in the "State" column of the "Task History" page.

Note
If the Host Discovery Task was not successful, an error indicator ( ) will be displayed. You can click on the appropriate Task name to view the error message at the bottom of the page.

You have previously added the Server's Key file on the Host (See Activating the Linux Agent) and your Host has been successfully discovered. Now the Host is ready to be backed up immediately. There is no need to restart any service or execute any command.

Enabling Control Panel Add-On for a Host

If you do not activate the Control Panel Add-On when you add the Host, you can activate it later.

Follow the instructions below to activate the Control Panel Add-On Module for a Host in your CDP Server Stand Alone or Data Center.

1. Open the Web browser connecting to the CDP Server Web Interface and log in.

2. Click on the "Hosts" tab in the Main Menu to access the "Hosts" page.

Note
The "Hosts" page typically loads automatically after you log in.

3. Select the Host by clicking on the appropriate Host Name link in the "Host Name" column. Or you can click on the corresponding "Open" link in the "Actions" column.

New Feature in Version 2
To find a host, you can use the Host List Filter

4. Click on "Change" to view the Host options in edit mode.

5. When the "Edit" page has loaded, select the "Enable Control Panel Module" check box to enable the Control Panel Module.

6. Verify that the "Enable CDP For MySQL Module" check box is selected.

Note
The Control Panel Add-On Module is typically used with the MySQL Add-On Module.

7. Also, verify the "Host Description" as it can be used for Control Panel authentication. The "Host Description" value must match the value entered in the "Host Description" text box for Control Panel User login. If not, you will get the "Host not found" error. If you do not specify a Host Description when adding a Host, its Host Description defaults to the Host Name specified for the Host.

8. When you are finished making the necessary changes, click on "OK".

Scheduling Backups of Control Panel

Important Settings

The following list includes the necessary preparations that must be completed after the Control Panel Module is enabled for the Hosts (see Enabling Control Panel Module) and before any Backup is scheduled.

  • Create Backup Schedules - The root administrator (hosting provider) can schedule Backups for every server where the control panel is installed. Read more in Scheduling Backups
  • Define Rotation Policies - Rotation Policy is defined in the Backup Task properties. User Backups will be removed according to the selected Rotation Policy. Read more in Backup Rotation Policies
  • Switch on automatic Make File Lists (Only for Version 1.x) - Each Scheduled Backup Task has a "Make file list when finished" check box. Select the check box to generate a file index AUTOMATICALLY after running the Backup. In 2.x, the file indexing Task does not exist.

Scheduling Backups

The root administrator (hosting provider) can schedule Backups for every Server where the control panel is installed. The servers must have Agents installed (see Control Panel Add-On - Installing the Linux Agent).

Follow the instructions below to schedule a Backup Task in your CDP Server Stand Alone or Data Center.

1. Open the Web browser connecting to the CDP Server Web Interface and log in.

2. Click on the "Hosts" tab in the Main Menu to access the "Hosts" page.

Note
The "Hosts" page usually loads automatically after you log in.

3. Select the Host by clicking on the appropriate Host Name link in the "Host Name" column. Or you can also click on the corresponding "Open" link in the "Actions" column.

New in Version 2
To find a Host, you can use the Host List Filter.

4. Click on "Backup and Restore" (New in Version 2.5) in the "Host" Menu.

5. On the following page, click on "Schedule Backup".

5. The "Schedule a new Backup task" page will load. Define the following settings specific to the new Backup Task. Read more about Tasks in Tasks.

  • Save Task - Select this check box to save the Backup Task.
  • Enabled - Select this check box to enable the Backup Task.
  • Description - A name you can use to distinguish this Task from other scheduled Backup Tasks.
  • Recurrence - Define the schedule and frequency for the new Backup Task (Now, Minutely, Hourly, Daily, Weekly, or Monthly). If you want to run a Backup immediately, leave the default "Now" selected in the drop-down menu.
    For more information, refer to Recurrence Types.
Backup Task Options:
  • Only keep the last x recovery points - Select this check box to enable and define the Rotation Policy.
    See Control Panel Add-On - Backup Rotation Policies.
  • Defragment data files when finished - Read more in Disk Safe Defragmentation.
  • Verify recovery point when finished - Select this check box to verify Recovery Point upon completion of the Backup.
  • Devices to Backup - Select the Device(s) you would like to Backup.

7. Click on "OK" to save the Backup Task.

Backup Rotation Policies

Each scheduled Backup Task can have an associated Rotation Policy. The Rotation Policy is defined when creating the Task or changed by editing the Backup Task. It is very important to define the Rotation Policy if you have a lot of control panel users in order to economize the space and remove old Backups.

The CDP Server does not have any User specific information. User Backups will be removed according to the selected Rotation Policy. The data remains on the CDP Server for a set period.

Example: Rotation Policies can include a "Daily" rotation that expires after 14 days, a "Weekly" that expires after 8 weeks, and a "Monthly" that expires after 2 months. Depending on when the client is removed, it could take up to 2 full months before the User is removed from all Backup Rotations.

When defining a Backup Task, you can specify how many Recovery Points to keep. If enabled, a Rotation Policy Task will launch when the Backup Task finishes. The Rotation Policy Task will look at all other Incremental Backups created by the same Scheduled Task and delete the oldest Recovery Points until only the last x Recovery Points remain as defined in the Backup Task.

Rotation Policies can be defined based on the following Recurrence Types:

  • Minutely
  • Hourly
  • Daily
  • Weekly
  • Monthly

Backup Rotation Policy Examples

  • Hourly- If you define a Backup Task with a Hourly Recurrence called "Hourly" and specify only the last 24 Recovery Points to be kept, then every time a Backup is taken the oldest Recovery Points will be deleted until there are only 24 left. Only Recovery Points created by the Scheduled Task described as "Hourly" will be counted in the 24 and be eligible to be deleted.
  • Daily - If you define a Backup Task with a Daily Recurrence called "Daily" and specify only the last 7 Recovery Points to be kept, then every time a Backup is taken the oldest Recovery Points will be deleted until there are only 7 left. Only Recovery Points created by the Scheduled Task described as "Daily" will be counted in the 7 and be eligible to be deleted.

Accessing Backups

The root administrator (hosting provider) can access all Backups via the CDP Server Web Interface (for Stand Alone CDP Server) or via Control Server Web Interface (for CDP Data Centers). Read more in the corresponding User Guides (Disk Safe Browser, Linux Control Server - The Disk Safe Browser, Windows Control Server - The Disk Safe Browser).

Control panel users can access their Backups by logging on to the CDP Server using the Auto-Login Icon in their control panel interface. In this case, they do not need to enter Host Name, Login Name, and Password. Read more in Control Panel Add-On - Enabling Auto-Login IconControl Panel Add-On - Log In To CDP Server Using Auto-Login.

Users can also access their Backups by logging on to the CDP Server Interface directly with their control panel Login Name and Password.

Follow the instructions below to log in to your Linux CDP Server system directly.

1. Open the Web browser connecting to the CDP Server Web Interface. Enter the following address into the address bar of your browser:

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

Note
If https is enabled for the CDP Server, the URL will be sent as https. If http is enabled on the CDP Server, then the URL will be sent as http. The settings can be found on the Web Interface by going to "Options" > "Server Settings." Read more in Server Settings.
Note
If you use the CDP Server Data Centers, the address will look like:
http(s)://Control-SERVER/cp/

2. Make sure the "Control Panel Login" option is selected in the Welcome screen.

3. Type in your Host Name.

Note
Your Host Name must match the value entered in the "Host Description" text box for the Hosts where your control panel is installed.

4. Enter the "User Name" and "Password" and click "Login".

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

5. After your successful log-in, the "Host" page will load. Read more in the Hosting Control Panel Add-On User Guide.

Troubleshooting

  • "Access denied" - Wrong User Name and Password.
  • "Host not found" - You may get this error when trying to log in as a control panel user. Check the Host List in the CDP Server to make sure there is a Host with the Host Description you are using to log in.
  • "Host is not configured to allow control panel user login" - You may get this error if the Volume and/or Host do not have the Control Panel Module enabled.

Read more in:

Users



Root Administrator

The root administrator can administrate all User Backups from a single Web Interface - CDP Server Web Interface (for CDP Server Stand Alone) or Control Server Web Interface (for CDP Data Centers).

Control Panel Users

The Control Panel Add-on Module allows virtual hosting users to restore their files. The users can restore individual or all files from any available Incremental Backup. Control panel users have access only to the files within their web space. Users can view the virtual site directory as if using SSH or FTP to access their site and can restore files into their virtual site account or directory.

You do not need to create new accounts for control panel users in the CDP Server. Authentication is handled using the control panel. Disabling a control panel account or changing a Password instantly affects log-in to the CDP Server.

cPanel users can have a link with Auto-Login to the CDP Server displayed in the control panel interface. Read more in Control Panel Add-On - Enabling Auto-Login Icon.

The other control panel users log in directly to the CDP Server using their control panel login and Password. Read more in Control Panel Add-On - Accessing Backups.

Refer to the Hosting Control Panel Add-On User Guide for more information.

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