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.

!Policy_detail_view.png|border=1!

4. Click on the "Download Plugin" icon, located in the right column. !Panel_DownLoad_Plugin.png|border=1!

*NOTE:*&nbsp;To download the Paper Lantern or Jupiter plugin directly, access the following address:&nbsp;_https://<SBM IP>/cpplugins/<r1soft-cpanel-plugin-version>.tar.gz&nbsp;_
_Please remember to replace the&nbsp;__<SBM IP> with your actual SBM IP Address and the&nbsp;__<r1soft-cpanel-plugin-version> with the version supported by your SBM.&nbsp;_

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!


&nbsp;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:&nbsp;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:

!R1RedirectV3.png|border=1!

8. Locate the line that contains the following text:
{code}$SBM_URL = "<URL>"{code}
Replace <URL> with the URL of your CDP server, such as "[http://127.0.0.1|http://127.0.0.1_]"&nbsp;.&nbsp; &nbsp; !plugin_replace_URL_3.0.png|border=1!

9. Locate the line that contains the following text:
{code}$CONTROL_PANEL_ID = "<ID>"{code}
Replace <ID> with the ID of your control panel instance, such as&nbsp;_c1568882-3597-4931-84bb-d591eceb63f8_.&nbsp;&nbsp; !plugin_replace_cp_id_3.0.png|border=1!
&nbsp;
10. Copy the&nbsp;*r1redirect.php*&nbsp;file&nbsp; located &nbsp;in&nbsp;*_<r1soft-cpanel-plugin-version>_{*}*/r1redirect.php*&nbsp;into your cPanel Paper Lantern or Jupiter Theme folder depending on the theme you are using.
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:

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:

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.

!plugin_ls_readme.png|border=1!

8. Open the&nbsp;{{r1redirect.php}}&nbsp;file in your favorite Linux text editor (vi, emacs, pico, or mcedit). !plugin_open_editor.png|border=1!

9. Locate the line that contains the following string:
{code}$CDP_SERVER_URL = "..."{code}
Replace the URL with the URL of your Backup Manager (for example,&nbsp;[http://10.230.200.38]).&nbsp;&nbsp; !plugin_replace_URL.png|border=1!

10. Locate the line that contains the following text:
{code}$CONTROL_PANEL_ID = "..."{code}
Replace the ID with the ID of your Control Panel Instance (for example, 8e367b22-0ce5-481c-98ad-2667d50cf48c).&nbsp; !plugin_replace_cp_id.png|border=1!


{info:title=Tip}
The Control Panel Instance ID is located in the "Control panel instance Id" column.&nbsp; !Panel_cp_id.png|border=1!
{info}
11. Copy the&nbsp;{{r1redirect.php}}&nbsp;file to your cPanel theme folder(s). For example:
{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
* For SBM 6.14 and above, please ensure&nbsp;that the version being used is&nbsp;version&nbsp;3.0
* For SBM 6.16 and above, please ensure&nbsp;that the version being used is&nbsp;version 4.0
&nbsp;
{excerpt:hidden=true}
Instructions on how to use the cPanel plugin.{excerpt}