Set up cPanel plugin

Follow the instructions below to set up the cPanel Integration plugin. The installed plugin will activate an icon within the cPanel interface so that customers can go directly to their backups via the Server Backup Manager Web Interface for Hosting Control Panel users.
{info:title=Note}
With the latest release, a new cPanel plugin has been made available. To know more about version support for plugins, Please [click here|http://wiki.r1soft.com/display/ServerBackupManager/Set+up+cPanel+plugin#SetupcPanelplugin-Pluginsupportversion]{info}

h3. Set Up the cPanel Plugin using the Paper Lantern or Jupiter Theme
{info:title=Note}
Installing this plugin in a non-Paper Lantern theme or cPanel version earlier than 11.44 will result in unexpected behavior and may not function properly. 
If you are using a non-Paper Lantern theme, please [click here|http://wiki.r1soft.com/display/ServerBackupManager/Set+up+cPanel+plugin#SetupcPanelplugin-SetUpcPanelPlugin1.x].{info}
1. From the Main menu, under *Settings*, select the *Policies* option. The Server Backup Manager will display a list of all available policies.

2.Find the necessary Policy to which the Control Panel Instance has been added. Click the ">" icon visible on the Left side of the Policy, to view the policy details.
\\ !Policy_detail.png|border=1!

3. Click on the "Control Panels" tab in the "Policy Details" window.

5. Upload the file to the server.

6. Extract the cPanel plugin archive using the following command:

For example, If you have downloaded the 2.0 version of the plugin, then you would use:
{code}tar -xzf r1soft-cpanel-plugin-2.0.tar.gz{code}
!plugin_extract_tar_2.0.png|border=1!


 If you have downloaded the 4.0 version of the plugin, then you would use:

{code}tar -xzf r1soft-cpanel-plugin-4.0.tar.gz
{code}
NOTE: Inside the extracted archive, there is a "README" file. This file also has directions on how to set up the cPanel plugin.

7. Open the&nbsp;*r1redirect.php*&nbsp;file located in&nbsp;*_<r1soft-cpanel-plugin-version>_{*}*/r1redirect.php*&nbsp;in a text editor.

For example,&nbsp;If you have downloaded the 3.0 version of the plugin, then you would use:
{code}vi r1soft-cpanel-plugin-3.0/r1redirect.php{code}

If you have downloaded the 4.0 version of the plugin, then you would use:


{code}
vi r1soft-cpanel-plugin-4.0/r1redirect.php
{code}

!R1RedirectV3.png|border=1!

For example,&nbsp;If you have downloaded the 3.0 version of the plugin, then you would use:
{code}cp r1soft-cpanel-plugin-3.0/r1redirect.php /usr/local/cpanel/base/frontend/paper_lantern/{code}

If you have downloaded the 4.0 version of the plugin, then you would use:


{code}
cp r1soft-cpanel-plugin-4.0/r1redirect.php /usr/local/cpanel/base/frontend/jupiter/

{code}
11. Install the cPanel plugin into the Paper Lantern or Jupiter Theme.

For example,&nbsp;If you have downloaded the 3.0 version of the plugin, then you would use:
{code}/usr/local/cpanel/scripts/install_plugin r1soft-cpanel-plugin-3.0 --theme paper_lantern{code}

If you have downloaded the 4.0 version of the plugin, then you would use:


{code}
/usr/local/cpanel/scripts/install_plugin r1soft-cpanel-plugin-4.0 --theme jupiter{code}

The&nbsp;R1Soft Restore Backups&nbsp;link should now appear in the cPanel using the Paper Lantern or Jupiter Theme.

!cp-icon.png|border=1!

h3. Set Up cPanel Plugin 1.x
{info:title=Note}
Follow the instructions below to install the cPanel plugin if you are using a&nbsp;non-Paper Lantern theme or cPanel version earlier than 11.44{info}
1. To download the cPanel plugin from the SBM web interface, follow steps 1 through 5 in the previous procedure.

6. Extract the file using the following command:
{code}tar -vzxf r1soft-cpanel-plugin-1.1.tar.gz{code}
!plugin_extract_tar.png|border=1!

7. Inside the archive, there is a "README" file with directions on how to set it up.

{code}cp r1redirect.php /usr/local/cpanel/base/frontend/default/{code}
12. Run the following command to integrate the plugin with cPanel:
{code}/usr/local/cpanel/bin/register_cpanelplugin r1soft-cdp.cpanelplugin{code}
13. The Backup Manager link should now appear inside of cPanel.

!cp-icon.png|border=1!

h3. Plugin support version

1. If you are using a&nbsp;non-Paper Lantern theme or cPanel version earlier than 11.44, please ensure that you are using a cPanel plugin version lower than&nbsp;r1soft-cpanel-plugin-2.0

2. If you are using Paper Lantern (version 11.44 or higher), please check your SBM release version.&nbsp;
* For SBM 6.12 and below, please ensure that the version being used is version&nbsp;2.0