Integrating CDP with a Custom Control Panel

The Control Panel Add-On scripts are written in Perl and distributed under an Apache open source license, allowing you to modify the code. You can adapt the Control Panel integration feature for Control Panels that are not presented in the [list|CDP for Hosting Control Panels] of supported Control Panels.

The Control Panel integration scripts are open source, and there are many options to make the integration work in different ways. We hope it encourages people to enhance the scripts and share the new scripts with other users.

You can modify the existing Control Panel integration scripts in a number of ways.


*Example 1.* By default, only Control Panel users can see the same virtual site directory as if they were using SSH or FTP to access their virtual site. They can only Restore files into their virtual site account or directory. By modifying the Control Panel scripts in addition to the web content, other directories on the same server can be linked into the Control Panel account for file Restores.

{info:title=Note} The existing Parallels Plesk Panel script uses this functionality to allow users to restore email. {info}

*Example 2.* Another option is to make the script check the username against an allowed list of users. File Restores could be an option only given to Control Panel accounts that paid for this option or have a premium account.


----
{toc:maxLevel=3|minLevel=3|type=flat|separator=pipe|style=border:1}
----
To integrate your custom Control Panel with R1Soft Backup software, complete the following two (2) steps:

h3. Step 1 - Creating Custom Perl Scripts


1. On a system where the Linux Agent is installed, go to the {{/usr/sbin/r1soft/lib/controlpanel}} directory.

!Controlpanel folder.png!

3. Once you have adapted Perl scripts to your needs, place them in the {{/usr/sbin/r1soft/lib/controlpanel/custom}} folder. So, as a result, there will be two (2) files with a {{.pl}} extension in the {{custom}} folder:

----
h3. Step 2 - Adding Custom Control Panel Instance to a Policy



Follow the instructions below to enable your integration scripts. First, create a new "Custom" Control Panel instance in a Policy. For more information, see [Adding Control Panel Instances].

1. On the "Control Panels" tab of the "Edit Policy" window, click on the "Add Control Panel Instance" button.

!http://wiki.r1soft.com/download/attachments/22184411/Add+Control+Panel+Instance+button_English.png!

2. The "Add Control Panel Instance" window will appear. Familiarize yourself with the introductory information, and click "Next" to proceed with adding the Instance.

!http://wiki.r1soft.com/download/attachments/22184411/Add+Control+Panel+Instance_Introduction_English.png!

3. On the following "Instance Details" screen, select the "Custom" type in the drop-down menu.




!Custom Type selection.png!

Having selected the "Custom" type, specify the custom Perl scripts you have created in the first step.The scripts must be located in the {{/usr/sbin/r1soft/lib/controlpanel/custom}} directory on the Agent machine. Default names are as follows:
* {{custom-auth.pl}}
* {{custom-listusers.pl}}


!Script's name selection.png!

4. Specify other options in the "Add Control Panel Instance" wizard and save the Instance.


3. Verify the created Instance by clicking on the "Verify" button in the "Control Panels" tab. This will verify that the Instance actually exists on the specified Agent.

!Edit Policy_Verify icon.png!

Alternatively, you can verify the Instance be clicking on the "Verify Instance" button in the "Add Control Panel Instance" wizard.

5. Click "Save" in the Policy window to save the changes.



!Edit Policy_Save button.png!

{excerpt:hidden=true}Instructions on how to configure integration of CDP with a custom Control Panel.
{excerpt}