Personal tools
Namespaces

Variants
Actions

R1Soft Backups For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Configuration of Product)
(→‎About R1Soft Backups For WHMCS)
 
(88 intermediate revisions by 9 users not shown)
Line 1: Line 1:
−
<meta name="keywords" content="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>
  
−
=About [http://www.modulesgarden.com/products/whmcs/R1Soft_Backups/features R1Soft Backups For WHMCS]=
+
=About [https://www.modulesgarden.com/products/whmcs/r1soft-backups R1Soft Backups For WHMCS]=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 0px;"|'''R1Soft Backups For WHMCS''' is a powerful module which allows you to automatically provision virtual servers to your customers.<br />
+
|style="padding: 10px 0px 10px 0px;"|'''R1Soft Backups For WHMCS''' will let you sell and manage R1Soft Server Backup Manager accounts right in your WHMCS system.<br/>  
−
The great advantage of this module is the fact that customers can manage virtual servers, backups and much more in your own WHMCS client area!<br />
+
Your customers will be able to use different configurable options in order to adjust their products to satisfy all their needs.<br/>
−
Additionally it allows you to conveniently overview and manage all the customers' servers.
+
Moreover, they will be allowed to monitor the disk usage, choose its compression type and access the control panel with a single click.
 
|}
 
|}
−
<!--a comment maybe? -->
 
 
*'''Admin Area Features:'''
 
*'''Admin Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Features
+
|style="padding: 10px 0px 0px 30px;"|✔ Create/Terminate Account
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔  
+
|style="padding: 0px 0px 0px 30px;"|✔ Suspend/Unsuspend User
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔  
+
|style="padding: 0px 0px 0px 30px;"|✔ Change Package
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Change Password
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 30px;"|✔ View Server Details
 
|}
 
|}
 
*'''Client Area Features:'''
 
*'''Client Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Features
+
|style="padding: 10px 0px 0px 30px;"|✔ View Server Details
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔  
+
|style="padding: 0px 0px 0px 30px;"|✔ View Disk Usage Statistics
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔  
+
|style="padding: 0px 0px 0px 30px;"|✔ View And Manage Account Credentials
 
|}
 
|}
 +
{|
 +
|style="padding: 0px 0px 10px 30px;"|✔ Log In To Control Panel
 +
|}
 +
*'''Package Settings:'''
 +
{|
 +
|style="padding: 10px 0px 0px 30px;"|✔ Is Power-User
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Agent Limit
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Soft Quota
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Hard Quota
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Quota Type
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Replication Frequency Limit
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ MySQL Addon Limit
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Archive Point Limit
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Recovery Point Limit
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Allow Archiving
 +
|}
 +
{|
 +
|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:'''
 +
{|
 +
|style="padding: 10px 0px 0px 30px;"|✔ Maximum Number Of Agents
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Maximum Number Of MySQL Addons
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Size (Total Or Divided Into 'Soft Quota' And 'Hard Quota')
 +
|}
 +
{|
 +
|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
 +
|}
 +
 
*'''General Info:'''
 
*'''General Info:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔  
+
|style="padding: 10px 0px 0px 30px;"|✔ Configurable Options Support
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With [https://www.modulesgarden.com/products/whmcs/server-allocator Server Allocator For WHMCS] - Automatic Assignment Of Most Suitable Servers To Products
 
|}
 
|}
 
{|
 
{|
Line 37: Line 118:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Supports WHMCS V5 and Later
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 8.1 Back To PHP 7.3
 
|}
 
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Themes "Six" And "Twenty-One"
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V8.10 Back To WHMCS V8.3
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Requires ionCube Loader V12 Or Later
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 30px;"|✔ Easy [https://www.docs.modulesgarden.com/How_To_Upgrade_WHMCS_Module Module Upgrade] To [https://www.modulesgarden.com/products/whmcs/r1soft-backups#open-source-version Open Source Version]
 +
|}
 +
 
=Installation and Configuration=
 
=Installation and Configuration=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 0px;"|'''This tutorial will show you how to successfully install and configure R1Soft Backups For WHMCS.''' <br />
+
|style="padding: 10px 0px 30px 0px;"|'''This tutorial will show you how to successfully install and configure [https://www.modulesgarden.com/products/whmcs/r1soft-backups R1Soft Backups For WHMCS.]''' <br/>
 
We will guide you step by step through the whole installation and configuration process.
 
We will guide you step by step through the whole installation and configuration process.
 
|}
 
|}
 
==Installation==
 
==Installation==
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to your client area and download R1Soft Backups For WHMCS.'''
+
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to our client area and download the module.'''
 
|}
 
|}
 
{|
 
{|
Line 52: Line 146:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''2. Upload and extract the module into the main WHMCS directory.'''
+
|style="padding: 0px 0px 15px 15px;"|'''2. In the downloaded file you might find one or two packages that support different PHP versions.'''<br/>
 +
In the most recent versions of the module, you will find only one package that supports PHP 7.2 and later.<br/> <!-- If you need a package for the previous versions of PHP, please [https://www.modulesgarden.com/support/ticket/general-support contact our support]. -->
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RSB2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PHP72_74.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''3. When you install R1Soft Backups for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''Previous updates of the module may contain two packages dedicated to various PHP versions.'''<br/>
−
File is located in '' 'modules/servers/R1SoftBackups/license_RENAME.php' ''. Rename it from '' 'license_RENAME.php' '' to '' 'license.php' ''.
+
The first one that supports PHP 5.6 up to PHP 7.1, and the second one addressed to PHP 7.2 up to PHP 7.4.<br/>
 +
'''''Note:''' Keep in mind that PHP versions 5.6 up to 7.1 are no longer officially supported and their security issues are not fixed or released any more. Find more info [http://php.net/supported-versions.php here].''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PHP56_74.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 15px;"| <!-- '' '''Important''': This situation does not affect [https://www.modulesgarden.com/products/whmcs/r1soft-backups#open-source-version '''the open source version'''] of this module which can be applied to any PHP from version 5.6 and later.''<br/>'' --> '''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' → 'System' → 'PHP Info'.'''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''3.  Extract the package and upload its content into the main WHMCS directory. <br/>
 +
The content of the package to upload should look like this.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:RSB2_1.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''4. When you install R1Soft Backups For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br/>
 +
File is located in '' 'modules/servers/R1SoftBackups/license_RENAME.php'.'' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'.''
 
|}
 
|}
 
{|
 
{|
Line 65: Line 178:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''4. In order to configure your license key, you have to edit a previously renamed '' 'license.php' '' file.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''5. In order to configure your license key, you have to edit a previously renamed '' 'license.php' '' file.'''<br/>
−
Enter your license key between quotation marks as presented on the following screen.<br />
+
Enter your license key between quotation marks as presented on the following screen.<br/>
−
You can find your license key in your client area → '' 'My Products' ''.
+
You can find your license key in our client area → '' 'My Products'.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RSB4.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:RSB4.png]]
 
|}
 
|}
  
 
==Configuration of Server==
 
==Configuration of Server==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''5. Now, we will show you how to configure a new product.'''<br />
+
|style="padding: 10px 0px 15px 15px;"|'''6. Now, we will show you how to configure a new product.'''<br/>
−
Go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Servers' '' and press '' 'Add New Server' ''.
+
Go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Servers' '' and press '' 'Add New Server'.''
 
|}
 
|}
 
{|
 
{|
Line 82: Line 195:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''6. 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 89: Line 203:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''7. It is time to create a server group. To do so, click on '' 'Create Server Group' ''.'''
+
|style="padding: 0px 0px 20px 15px;"|'''8. It is time to create a server group. To do so, click on '' 'Create Server Group'.'''''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RSB8.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:RSB7.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''8. Enter name, click on your previously created server, press '' 'Add' '' and afterwards '' 'Save Changes' ''.'''
+
|style="padding: 0px 0px 20px 15px;"|'''9. Enter name, click on your previously created server, press '' 'Add' '' and afterwards '' 'Save Changes'.'''''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:RSB9.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:RSB8.png]]
 
|}
 
|}
  
 
==Configuration of Product==
 
==Configuration of Product==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''9. In order to create and configure a product, go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' ''.'''<br />
+
|style="padding: 10px 0px 15px 15px;"|'''10. In order to create and configure a product, go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services'.'''''<br/>
−
Click on '' 'Create a New Group' ''.
+
Click on '' 'Create a New Group'.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:RSB9.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|'''11. Enter product group name and press '' 'Save Changes'.'''''
 
|}
 
|}
 
{|
 
{|
Line 110: Line 230:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''10. Enter product group name and press '' 'Save Changes' ''.'''
+
|style="padding: 0px 0px 15px 15px;"|'''12. When you have a product group, you can create your product.'''<br/>
 +
To create a product click on '' 'Create a New Product'.''
 
|}
 
|}
 
{|
 
{|
Line 116: Line 237:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''11. When you have a product group, you can create your product.'''<br />
+
|style="padding: 0px 0px 20px 15px;"|'''13. Afterwards, choose your product group and type from dropdown menus, enter your product name and press '' 'Continue'.'''''
−
To create a product click on '' 'Create a New Product' ''.
+
 
|}
 
|}
 
{|
 
{|
Line 123: Line 243:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''12. Afterwards, choose your product group and type from dropdown menus, enter your product name and press '' 'Continue' ''.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''14. Now, go to '' 'Module Settings' '' section, choose both '' 'R1softbackups' '' and your previously created server group from dropdown menus.'''<br/>
−
'' 'Product Type' '' should be set to '' 'Hosting Account' ''.
+
Save changes.
 
|}
 
|}
 
{|
 
{|
Line 130: Line 250:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''13. Now, go to '' 'Module Settings' '' section, choose both '' 'R1softbackups' '' and your previously created server group from dropdown menus.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''15. Take a moment to set up all the available module's options: '''<br/>
−
Next, click on '' 'Save Changes' ''.'''
+
First of all, you need to enable '''Power-User''' as only then you will be able to manage Module Settings fully.<br/>
 +
 
 +
*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 instead 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/>
 +
* '''R1Soft's SMB Version''' - choose the preferred version from the dropdown menu <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 [https://www.docs.modulesgarden.com/General#How_To_Use_Configurable_Options here].''
 +
 
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RSB14.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:RSB14.png]]
 
|}
 
|}
  
 
=Management=
 
=Management=
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|''' R1Soft Backups For WHMCS allows you
+
|style="padding: 10px 0px 30px 15px;"|''' R1Soft Backups For WHMCS allows reselling and accessing an external backups management server directly from your WHMCS.'''<br/>
 +
Read the below section to find out how contributing the product can be to your business.
 
|}
 
|}
 
==Ordering==
 
==Ordering==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|
+
|style="padding: 10px 0px 15px 15px;"|R1Soft Backups For WHMCS is ordered by clients as any other product. However, there is one thing to pay attention to.<br/>
 +
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 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.
 
|}
 
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:RSB15.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|From the admin area you can order actions such as:<br/>
 +
'' 'Create', 'Suspend', 'Unsuspend', 'Terminate', 'Change Package' '' and '' 'Change Password'.''<br/>
 +
Underneath the buttons, there are also '' 'Server IP' '' and '' 'Server Port' '' details available.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:RSB16.png]]
 +
|}
 +
 
==Client Area==
 
==Client Area==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|
+
|style="padding: 10px 0px 15px 10px;"|Your client can log in to the outside R1Soft account from your WHMCS client area.<br/>
 +
Link to the server must have been entered in Module Settings (look at point 14 for more information).
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:RSB17.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 10px;"|Apart from the direct login button, there are also '' 'Login Details'.''<br/>
 +
View your R1Soft server login and show/hide password.
 +
|}
 +
{|
 +
|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 15px 10px;"|Resource Usage includes a graph that displays information on the currently used disk space.<br/>
 +
'''''Note:''' Bandwitdh graph is a WHMCS option and is not managed by the module.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:RSB20.png]]
 +
|}
 +
 
 
=Tips=
 
=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.
 +
|}
 +
 +
=Update Instructions=
 +
{|
 +
|style="padding: 10px 0px 30px 15px;"|An essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.<br/>
 +
Ensure successful completion of the module update by carefully following each step, thereby preventing data loss or any unforeseen issues.<br/> Additionally, you will find a current list of supplementary actions necessary for a smooth update process there.
 +
|}
 +
=Upgrade Guide=
 +
{|
 +
|style="padding: 10px 0px 30px 15px;"|Seeking a solution that offers greater flexibility, customization tailored to your precise needs, and unrestricted availability?<br/> There is an option that not only proves to be cost-effective in the long run but also includes prioritized support services, making it a truly valuable investment.<br/>
 +
 +
Opt for the [https://www.modulesgarden.com/products/whmcs/r1soft-backups#open-source-version Open Source version] of your R1Soft Backups For WHMCS module to unlock these benefits.<br/> Simply click on either the '''Get Source Code''' or '''Upgrade To Lifetime''' button found on the product's page in our client area to complete the one-step upgrade process, with a '''dedicated discount''' already applied.<br/>
 +
 +
Follow a [https://www.docs.modulesgarden.com/How_To_Upgrade_WHMCS_Module comprehensive guide] covering the transition process, the advantages it brings, and step-by-step instructions on what to do next after the order has been successfully finalized.
 +
|}
  
 
=Common Problems=
 
=Common Problems=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
+
|style="padding: 10px 0px 30px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
 
|}
 
|}

Latest revision as of 14:04, 26 April 2024

Contents

[edit] About R1Soft Backups For WHMCS

R1Soft Backups For WHMCS will let you sell and manage R1Soft Server Backup Manager accounts right in your WHMCS system.

Your customers will be able to use different configurable options in order to adjust their products to satisfy all their needs.
Moreover, they will be allowed to monitor the disk usage, choose its compression type and access the control panel with a single click.

  • 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 Most Suitable Servers To Products
✔ Multi-Language Support
✔ Supports PHP 8.1 Back To PHP 7.3
✔ Supports WHMCS Themes "Six" And "Twenty-One"
✔ Supports WHMCS V8.10 Back To WHMCS V8.3
✔ Requires ionCube Loader V12 Or Later
✔ Easy Module Upgrade To Open Source Version

[edit] 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.

[edit] Installation

1. Log in to our client area and download the module.
RSB1.png
2. In the downloaded file you might find one or two packages that support different PHP versions.

In the most recent versions of the module, you will find only one package that supports PHP 7.2 and later.

PHP72 74.png
Previous updates of the module may contain two packages dedicated to various PHP versions.

The first one that supports PHP 5.6 up to PHP 7.1, and the second one addressed to PHP 7.2 up to PHP 7.4.
Note: Keep in mind that PHP versions 5.6 up to 7.1 are no longer officially supported and their security issues are not fixed or released any more. Find more info here.

PHP56 74.png
Note: You can check the current PHP version in your WHMCS. To do so, proceed to 'Utilities' → 'System' → 'PHP Info'.
3. Extract the package and upload its content into the main WHMCS directory.

The content of the package to upload should look like this.

RSB2 1.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

[edit] 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

[edit] 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 instead 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
  • R1Soft's SMB Version - choose the preferred version from the dropdown menu

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

[edit] 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.

[edit] 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

[edit] 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 a graph that displays information on the currently used disk space.

Note: Bandwitdh graph is a WHMCS option and is not managed by the module.

RSB20.png

[edit] 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.

[edit] Update Instructions

An essential guidance through the process of updating the module is offered here.

Ensure successful completion of the module update by carefully following each step, thereby preventing data loss or any unforeseen issues.
Additionally, you will find a current list of supplementary actions necessary for a smooth update process there.

[edit] Upgrade Guide

Seeking a solution that offers greater flexibility, customization tailored to your precise needs, and unrestricted availability?
There is an option that not only proves to be cost-effective in the long run but also includes prioritized support services, making it a truly valuable investment.

Opt for the Open Source version of your R1Soft Backups For WHMCS module to unlock these benefits.
Simply click on either the Get Source Code or Upgrade To Lifetime button found on the product's page in our client area to complete the one-step upgrade process, with a dedicated discount already applied.

Follow a comprehensive guide covering the transition process, the advantages it brings, and step-by-step instructions on what to do next after the order has been successfully finalized.

[edit] 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=66737"
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
R1Soft Backups For WHMCS