Personal tools
Namespaces

Variants
Actions

R1Soft Backups For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
Line 1: Line 1:
 
<meta name="keywords" content="r1soft server backup manager for whmcs, r1soft backups for whmcs, r1soft backups configuration, whmcs r1soft backups management, whmcs r1soft backups installation, whmcs r1soft backups common problems, about whmcs r1soft backups, whmcs r1soft backups documentation, whmcs r1soft backups faq, whmcs r1soft backups help, whmcs r1soft backups guide, whmcs r1soft backups wiki, whmcs r1soft backups tutorial, whmcs r1soft backups tips, whmcs r1soft backups wiki"></meta>
 
<meta name="keywords" content="r1soft server backup manager for whmcs, r1soft backups for whmcs, r1soft backups configuration, whmcs r1soft backups management, whmcs r1soft backups installation, whmcs r1soft backups common problems, about whmcs r1soft backups, whmcs r1soft backups documentation, whmcs r1soft backups faq, whmcs r1soft backups help, whmcs r1soft backups guide, whmcs r1soft backups wiki, whmcs r1soft backups tutorial, whmcs r1soft backups tips, whmcs r1soft backups wiki"></meta>
 
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The R1Soft Backups For WHMCS Module."></meta>
 
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The R1Soft Backups For WHMCS Module."></meta>
−
 
−
<h4 style="color: #ff0000; font-weight:bold; text-align:center;">Article update is ongoing on this page, watch out for broken links, unclear descriptions and images!<br/>
 
−
We are sorry for the inconvenience caused.</h4>
 
  
 
=About [https://www.modulesgarden.com/products/whmcs/r1soft-backups R1Soft Backups For WHMCS]=
 
=About [https://www.modulesgarden.com/products/whmcs/r1soft-backups R1Soft Backups For WHMCS]=
Line 9: Line 6:
 
|style="padding: 10px 0px 10px 0px;"|'''R1Soft Backups For WHMCS''' will let you sell R1Soft Server Backup Manager accounts through your system.<br/>  
 
|style="padding: 10px 0px 10px 0px;"|'''R1Soft Backups For WHMCS''' will let you sell R1Soft Server Backup Manager accounts through your system.<br/>  
 
You will be able to create packages with various sets of limits and privileges depending on the needs of your clients.<br/>
 
You will be able to create packages with various sets of limits and privileges depending on the needs of your clients.<br/>
−
thanks to these, your offer will be vivid and every of your clients will find an adequate product to order.
+
Thanks to these, your offer will be vivid and every of your clients will find an adequate product to order.
 
|}
 
|}
 
*'''Admin Area Features:'''
 
*'''Admin Area Features:'''
Line 30: Line 27:
 
{|
 
{|
 
|style="padding: 10px 0px 0px 30px;"|✔ View Server Details
 
|style="padding: 10px 0px 0px 30px;"|✔ View Server Details
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ View Disk Usage Statistics
 
|}
 
|}
 
{|
 
{|
Line 69: Line 69:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Allow Agents
+
|style="padding: 0px 0px 0px 30px;"|✔ Allow Agents
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Compression Type:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ None
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ QuickLZ
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 45px;"|✔ ZLib (Three Levels Available: Low, Medium, High)
 
|}
 
|}
  
 
*'''Configurable Options:'''
 
*'''Configurable Options:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Agent Limit
+
|style="padding: 10px 0px 0px 30px;"|✔ Maximum Number Of Agents
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ MySQL Addon Limit
+
|style="padding: 0px 0px 0px 30px;"|✔ Maximum Number Of MySQL Addons
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Size - Previously Divided Into 'Soft Quota' And 'Hard Quota'
+
|style="padding: 0px 0px 0px 30px;"|✔ Size (Total Or Divided Into 'Soft Quota' And 'Hard Quota')
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Replication Frequency Limit
+
|style="padding: 0px 0px 0px 30px;"|✔ Compression Type
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Compression Level
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Replication Frequency Limit
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 30px;"|✔ Quota Type
 
|}
 
|}
  
Line 89: Line 110:
 
{|
 
{|
 
|style="padding: 10px 0px 0px 30px;"|✔ Configurable Options Support
 
|style="padding: 10px 0px 0px 30px;"|✔ Configurable Options Support
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With <u>Server Allocator For WHMCS</u> - Automatic Assignment Of Specified Servers To Products [https://www.modulesgarden.com/products/whmcs/server-allocator (read more)]
 
|}
 
|}
 
{|
 
{|
Line 100: Line 124:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V7
+
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V7.2 And Later
 
|}
 
|}
  
Line 117: Line 141:
 
{|
 
{|
 
|style="padding: 0px 0px 10px 15px;"|'''2. In the downloaded file you will find two packages that support different PHP versions.'''<br/>As presented on the screen below, the first one is dedicated to PHP 5.6 up to PHP 7.0, while the second one is aimed at PHP 7.1 up to PHP 7.2.<br/>It does not apply to open source versions.<br/>
 
|style="padding: 0px 0px 10px 15px;"|'''2. In the downloaded file you will find two packages that support different PHP versions.'''<br/>As presented on the screen below, the first one is dedicated to PHP 5.6 up to PHP 7.0, while the second one is aimed at PHP 7.1 up to PHP 7.2.<br/>It does not apply to open source versions.<br/>
−
'' '''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' › 'System' › 'PHP Info'.'''
+
'' '''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' → 'System' → 'PHP Info'.'''
 
|}
 
|}
 
{|
 
{|
Line 154: Line 178:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''7. Next, enter your server name, IP address/hostname, username, password and admin tenant ID.'''<br/>
+
|style="padding: 0px 0px 15px 15px;"|'''7. Next, enter your server name, IP address/hostname, username and password.'''<br/>
−
Choose '' 'R1SoftBackups' '' from a dropdown menu and press '' 'Save Changes'.'''''
+
Choose '' 'R1softbackup' '' from a dropdown menu and press '' 'Save Changes'.'''''<br/>
 +
'''''Note:''' Here you may also provide your custom port to connect with your server.''
 
|}
 
|}
 
{|
 
{|
Line 208: Line 233:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''15. Proceed to setting up module's options: '''<br/>
+
|style="padding: 0px 0px 15px 15px;"|'''15. Take a moment to set up all the available module's options: '''<br/>
−
Use '' 'Generate' '' buttons to automatically generate custom fields and configurable options for the product.
+
First of all, you need to enable '''Power-User''' as only then you will be able to manage Module Settings fully.<br/>
−
Allow options according to your needs:
+
 
−
*enable Power-User (only then you will be able to manage Module Settings fully)
+
 
*enter volume path prefix
 
*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)'''
+
*define the '''Maximum Number of Agents''' - can be overwritten by a configurable option
−
*state a maximum number of MySQL addon - enter '0' or leave empty to disable this option '''(can be replaced by configurable option)'''
+
*define the '''Maximum Number of MySQL Addons''' - can be replaced by a 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)'''
+
*'''Soft Quota''' - a warning level when users are informed that they are close to reach their effective limit
−
*enter hard quota in GB - maximum resources allowed to be occupied by data '''(can be replaced by configurable option)'''
+
*'''Hard Quota''' - maximum resources allowed to be occupied by data, its value should exceed the soft quota value
−
*allow user to create and administer agents
+
**'' 'Soft Quota' '' and '' 'Hard Quota' '' can be overwritten by a configurable option '' 'Size' '' which defines the general range of usage
−
*enable archiving
+
*allow the user to create and '''Administer Agents'''
−
*state the limit of archive points - enter '0' or leave empty to set no limits
+
*enable '''Archiving'''
−
*state the limit of recovery points - enter '0' or leave empty to set no limits
+
*define the '''Limit of Archive Points'''  
−
*state replication frequency: '' 'Hourly,' '' '' 'Daily,' '' '' 'Weekly,' '' or '' 'Monthly' '' '''(can be replaced by configurable option)'''
+
*define the '''Limit of Recovery Points'''  
−
*state quota type: '' 'On Disk Size' '' or '' 'Deltas in Disk Safe' ''
+
*select '''Replication Frequency Limit''': '' 'Hourly,' '' '' 'Daily,' '' '' 'Weekly,' '' or '' 'Monthly' '' - can be replaced by a configurable option
−
*enter WebLogin link, remember to use whole '' http:// '' address - if left empty, the button will not be available
+
*choose '''Quota Type''': '' 'On Disk Size' '' or '' 'Deltas in Disk Safe' '' - can be replaced by a configurable option
−
Remember to save changes in the end. You may come back and alter the settings whenever needed.<br/>
+
*enter '''WebLogin Server''' link, remember to use a whole '' http:// '' address - if left empty, the button will not be available
 +
**'''WebLogin With Server Hostname''' - if checked, server hostname will be used in stead of the '' 'WebLogin Server' '' link
 +
*select '''Compression Type''' to save space: '' 'ZLib', ''QuickLZ' '' or set to '' 'None' '' to disable this option
 +
**if '' 'ZLib' '' has been selected, then choose '''Compression Level''': '' 'Low', 'Medium' '' or '' 'High' ''
 +
*Default Port - define default port to communicate with Backup Server Agent - can be replaced by a custom field<br/>
 +
 
 +
Remember to save the changes in the end.<br/>
 +
 
 +
Use '' 'Generate' '' buttons to automatically generate custom fields and configurable options for the product.<br/>
 
''Note: It is recommended to edit configurable options to suit your needs, more about management of configurable options can be found [http://www.docs.modulesgarden.com/General#How_To_Use_Configurable_Options here].''
 
''Note: It is recommended to edit configurable options to suit your needs, more about management of configurable options can be found [http://www.docs.modulesgarden.com/General#How_To_Use_Configurable_Options here].''
 +
 
|}
 
|}
 
{|
 
{|
Line 234: Line 267:
 
{|
 
{|
 
|style="padding: 10px 0px 30px 15px;"|''' R1Soft Backups For WHMCS allows reselling and accessing an external backups management server directly from your WHMCS.'''<br/>
 
|style="padding: 10px 0px 30px 15px;"|''' R1Soft Backups For WHMCS allows reselling and accessing an external backups management server directly from your WHMCS.'''<br/>
−
Reade the below section to find out how contributing the product can be to your business.
+
Read the below section to find out how contributing the product can be to your business.
 
|}
 
|}
 
==Ordering==
 
==Ordering==
Line 241: Line 274:
 
While completing the order for the product, a client needs to fill in Additional Required Information, which is:
 
While completing the order for the product, a client needs to fill in Additional Required Information, which is:
 
#Server IP - this is an IP address of Backup Manager agent's server.
 
#Server IP - this is an IP address of Backup Manager agent's server.
−
#Server Port - defined port number used to connect to server of Backup Manager agent.
+
#Server Port - defined port number used to connect to server of Backup Manager agent - ''unless otherwise configured by the administrator.''
 
Additionally, depending on configurable option, client can define account limits.
 
Additionally, depending on configurable option, client can define account limits.
 
|}
 
|}
Line 259: Line 292:
 
{|
 
{|
 
|style="padding: 10px 0px 15px 10px;"|Your client can log in to the outside R1Soft account from your WHMCS client area.<br/>
 
|style="padding: 10px 0px 15px 10px;"|Your client can log in to the outside R1Soft account from your WHMCS client area.<br/>
−
Provided link to the server must have been entered in Module Settings (look at point 14 for more information).  
+
Link to the server must have been entered in Module Settings (look at point 14 for more information).  
 
|}
 
|}
 
{|
 
{|
Line 269: Line 302:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:RSB18.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:RSB18.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 10px;"|Quick look at your product details, as stated while placing an order at ''Configurable Options'' section.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:RSB19.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 10px;"|In Additional Information section, you may preview defined Server IP and Port.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:RSB19_1.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 10px;"|Resource Usage includes two graphs with information on currently used disk space and bandwidth.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:RSB20.png]]
 +
|}
 +
 
 +
=Tips=
 +
{|
 +
|style="padding: 10px 0px 30px 15px;"|1. If you do not want your clients to provide a backup agent port, then modify according custom field and define default port to communicate with agent in Module Settings.
 
|}
 
|}
  

Revision as of 14:42, 18 July 2018

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 Disk Usage Statistics
✔ 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
✔ Compression Type:
✔ None
✔ QuickLZ
✔ ZLib (Three Levels Available: Low, Medium, High)
  • Configurable Options:
✔ Maximum Number Of Agents
✔ Maximum Number Of MySQL Addons
✔ Size (Total Or Divided Into 'Soft Quota' And 'Hard Quota')
✔ Compression Type
✔ Compression Level
✔ Replication Frequency Limit
✔ Quota Type
  • General Info:
✔ Configurable Options Support
✔ Integrated With Server Allocator For WHMCS - Automatic Assignment Of Specified Servers To Products (read more)
✔ Multi-Language Support
✔ Supports PHP 5.6 Up To PHP 7.2
✔ Supports WHMCS Template Six
✔ Supports WHMCS V7.2 And Later

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 our 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 5.6 up to PHP 7.0, while the second one is aimed at PHP 7.1 up to PHP 7.2.
It does not apply to open source versions.

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

PHP56 72.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 our 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 and password.

Choose 'R1softbackup' from a dropdown menu and press 'Save Changes'.
 Note: Here you may also provide your custom port to connect with your server.

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. Take a moment to set up all the available module's options:

First of all, you need to enable Power-User as only then you will be able to manage Module Settings fully.

  • enter volume path prefix
  • define the Maximum Number of Agents - can be overwritten by a configurable option
  • define the Maximum Number of MySQL Addons - can be replaced by a configurable option
  • Soft Quota - a warning level when users are informed that they are close to reach their effective limit
  • Hard Quota - maximum resources allowed to be occupied by data, its value should exceed the soft quota value
    • 'Soft Quota' and 'Hard Quota' can be overwritten by a configurable option 'Size' which defines the general range of usage
  • allow the user to create and Administer Agents
  • enable Archiving
  • define the Limit of Archive Points
  • define the Limit of Recovery Points
  • select Replication Frequency Limit: 'Hourly,' 'Daily,' 'Weekly,' or 'Monthly' - can be replaced by a configurable option
  • choose Quota Type: 'On Disk Size' or 'Deltas in Disk Safe' - can be replaced by a configurable option
  • enter WebLogin Server link, remember to use a whole http:// address - if left empty, the button will not be available
    • WebLogin With Server Hostname - if checked, server hostname will be used in stead of the 'WebLogin Server' link
  • select Compression Type to save space: 'ZLib', QuickLZ' or set to 'None' to disable this option
    • if 'ZLib' has been selected, then choose Compression Level: 'Low', 'Medium' or 'High'
  • Default Port - define default port to communicate with Backup Server Agent - can be replaced by a custom field

Remember to save the changes in the end.

Use 'Generate' buttons to automatically generate custom fields and configurable options for the product.
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.

Read 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 - unless otherwise configured by the administrator.

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.

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
Quick look at your product details, as stated while placing an order at Configurable Options section.
RSB19.png
In Additional Information section, you may preview defined Server IP and Port.
RSB19 1.png
Resource Usage includes two graphs with information on currently used disk space and bandwidth.
RSB20.png

Tips

1. If you do not want your clients to provide a backup agent port, then modify according custom field and define default port to communicate with agent in Module Settings.

Update Instructions

Essential guidance through the process of updating the module is offered here.

Keep in mind there is a quick and easy option in our client area that will let you upgrade the license of your module to an open source version at any time - and at a lower price!
To take advantage of it, simply use the License Upgrade button located on the product's page and a discounted invoice will be generated automatically.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=R1Soft_Backups_For_WHMCS&oldid=40042"
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
R1Soft Backups For WHMCS