Installing Plugins

When you are ready with the configuration of your backup plugin, you can integrate it to your OnApp Control Panel. This document also provides information on installing the default plugins for R1Soft 6.4 and Veeam 9.5.  

The following procedure presupposes that you have an SSH key added to your CP. For more information on SSH configuration, see Edit Defaults Configuration.



Install Custom Plugin


Follow the next procedure to install your plugin to CP: 

  1. Connect to the Control Panel server via SSH.
  2. Navigate to the vendor/backups/plugins directory and create here a new directory named as your backup plugin. 

    # cd vendor/backups/plugins
    # mkdir plugin_name
  3. Navigate to the new directory and create (or upload) your config.xml and plugin.rb files.

    # cd plugin_name
    # touch config.xml
    # touch plugin.rb
  4. Restart your Apache daemon, using the following command: 

    # service httpd restart
  5. Restart OnApp services, using the following command: 

    # service onapp restart


Install Plugin for R1Soft


Follow the next procedure to install the plugin for R1Soft 6.4 to CP: 

  1. Connect to the Control Panel server via SSH.
  2. Install the backup plugin for R1Soft by running the following command: 

    # yum install onapp-cp-backups-r1soft
  3. Restart your Apache daemon, using the following command: 

    # service httpd restart
  4. Restart OnApp services, using the following command: 

    # service onapp restart


Install Plugin for Veeam


Before you install a plugin for Veeam, make sure that you accomplish Prerequisites.

Follow the next procedure to install the plugin for Veeam 9.5 to CP: 

  1. Connect to the Control Panel server via SSH.
  2. Install the backup plugin for Veeam by running the following command: 

    # yum install onapp-cp-backups-veeam
  3. Restart your Apache daemon, using the following command: 

    # service httpd restart
  4. Restart OnApp services, using the following command: 

    # service onapp restart


What's Next? 


After you completed the procedure, you can create backup resources that will use your plugin. For more information on how to manage backup resources and zones, see the following documents: 

After you install your backup plugin and create backup resources, by default users cannot access these resources on your Control Panel. To enable users to access and manage backup resources, add zones to Access Control of a bucket and enable the corresponding permissions for the User role.