R1Soft Backups For WHMCS

From ModulesGarden Wiki
Jump to: navigation, search

Contents

About R1Soft Backups For WHMCS

R1Soft Backups For WHMCS will let you sell R1Soft Server Backup Manager accounts through your system.

You will be able to create packages with various sets of limits and privileges depending on the needs of your clients.
thanks to these, your offer will be vivid and every of your clients will find an adequate product to order.

  • Admin Area Features:
✔ Create/Terminate Account
✔ Suspend/Unsuspend User
✔ Change Package
✔ Change Password
✔ View Server Details
  • Client Area Features:
✔ View Server Details
✔ View And Manage Account Credentials
✔ Log In To Control Panel
  • Package Settings:
✔ Is Power-User
✔ Agent Limit
✔ Soft Quota
✔ Hard Quota
✔ Quota Type
✔ Replication Frequency Limit
✔ MySQL Addon Limit
✔ Archive Point Limit
✔ Recovery Point Limit
✔ Allow Archiving
✔ Allow Agents
  • Configurable Options:
✔ Agent Limit
✔ MySQL Addon Limit
✔ Size - Previously Divided Into 'Soft Quota' And 'Hard Quota'
✔ Replication Frequency Limit
  • General Info:
✔ Configurable Options Support
✔ Multi-Language Support
✔ Supports PHP 5.3 Up To PHP 7
✔ Supports WHMCS Templates Five and Six
✔ Supports WHMCS V6 and V7

Installation and Configuration

This tutorial will show you how to successfully install and configure R1Soft Backups For WHMCS.

We will guide you step by step through the whole installation and configuration process.

Installation

1. Log in to your client area and download the module.
RSB1.png
2. In the downloaded file you will find two packages that support different PHP versions.
As presented on the screen below, the first one is dedicated to PHP 7, while the second one is aimed at PHP 5.3 up to PHP 5.6.
It does not apply to open source versions.

Note: You can check current PHP version in your WHMCS. To do so proceed to 'Utilities' → 'System' → 'PHP Info'.

RSB2.png
3. Extract the downloaded file and choose the one with the right PHP version. Upload and extract the PHP file into the main WHMCS directory.

The content of PHP version files should look like this.

Yhujt.png
4. When you install R1Soft Backups For WHMCS for the first time you have to rename 'license_RENAME.php' file.

File is located in 'modules/servers/R1SoftBackups/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

RSB3.png
5. In order to configure your license key, you have to edit a previously renamed 'license.php' file.

Enter your license key between quotation marks as presented on the following screen.
You can find your license key in your client area → 'My Products'.

RSB4.png

Configuration of Server

6. Now, we will show you how to configure a new product.

Go to 'Setup' 'Products/Services' 'Servers' and press 'Add New Server'.

RSB5.png
7. Next, enter your server name, IP address/hostname, username, password and admin tenant ID.

Choose 'R1SoftBackups' from a dropdown menu and press 'Save Changes'.

RSB6.png
8. It is time to create a server group. To do so, click on 'Create Server Group'.
RSB7.png
9. Enter name, click on your previously created server, press 'Add' and afterwards 'Save Changes'.
RSB8.png

Configuration of Product

10. In order to create and configure a product, go to 'Setup' 'Products/Services' 'Products/Services'.

Click on 'Create a New Group'.

RSB9.png
11. Enter product group name and press 'Save Changes'.
RSB10.png
12. When you have a product group, you can create your product.

To create a product click on 'Create a New Product'.

RSB11.png
13. Afterwards, choose your product group and type from dropdown menus, enter your product name and press 'Continue'.
RSB12.png
14. Now, go to 'Module Settings' section, choose both 'R1softbackups' and your previously created server group from dropdown menus.

Save changes.

RSB13.png
15. Proceed to setting up module's options:

Use 'Generate' buttons to automatically generate custom fields and configurable options for the product. Allow options according to your needs:

  • enable Power-User (only then you will be able to manage Module Settings fully)
  • enter volume path prefix
  • state a maximum number of agents - enter '0' or leave empty to disable this option (can be replaced by configurable option)
  • state a maximum number of MySQL addon - enter '0' or leave empty to disable this option (can be replaced by configurable option)
  • enter soft quota in GB - it is a warning level when users are informed that they are close to reach their effective limit (can be replaced by configurable option)
  • enter hard quota in GB - maximum resources allowed to be occupied by data (can be replaced by configurable option)
  • allow user to create and administer agents
  • enable archiving
  • state the limit of archive points - enter '0' or leave empty to set no limits
  • state the limit of recovery points - enter '0' or leave empty to set no limits
  • state replication frequency: 'Hourly,' 'Daily,' 'Weekly,' or 'Monthly' (can be replaced by configurable option)
  • state quota type: 'On Disk Size' or 'Deltas in Disk Safe'
  • enter WebLogin link, remember to use whole http:// address - if left empty, the button will not be available

Remember to save changes in the end. You may come back and alter the settings whenever needed.
Note: It is recommended to edit configurable options to suit your needs, more about management of configurable options can be found here.

RSB14.png

Management

R1Soft Backups For WHMCS allows reselling and accessing an external backups management server directly from your WHMCS.

Reade the below section to find out how contributing the product can be to your business.

Ordering

R1Soft Backups For WHMCS is ordered by clients as any other product. However, there is one thing to pay attention to.

While completing the order for the product, a client needs to fill in Additional Required Information, which is:

  1. Server IP - this is an IP address of Backup Manager agent's server.
  2. Server Port - defined port number used to connect to server of Backup Manager agent.

Additionally, depending on configurable option, client can define account limits.

RSB15.png
From the admin area you can order actions such as:

'Create', 'Suspend', 'Unsuspend', 'Terminate', 'Change Package' and 'Change Password'.
Underneath the buttons, there are also 'Server IP' and 'Server Port' details available.

RSB16.png

Client Area

Your client can log in to the outside R1Soft account from your WHMCS client area.

Provided link to the server must have been entered in Module Settings (look at point 14 for more information).

RSB17.png
Apart from the direct login button, there are also 'Login Details'.

View your R1Soft server login and show/hide password.

RSB18.png

Tips

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
Personal tools
Namespaces

Variants
Actions
Navigation
WHMCS Modules
cPanel Modules
Magento Extensions
Magento Themes
PrestaShop Modules
Blesta Extensions
General
Social
R1Soft Backups For WHMCS