Personal tools
Namespaces

Variants
Actions

R1Soft Backups For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Installation and Configuration)
(→‎Installation and Configuration)
Line 117: Line 117:
 
|}
 
|}
 
{|
 
{|
−
|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;"|'''3. When you install R1Soft Backups 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' ''.
+
File is located in '' 'modules/servers/R1SoftBackups/license_RENAME.php'.'' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'.''
 
|}
 
|}
 
{|
 
{|
Line 134: Line 134:
 
==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;"|'''5. 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 141: Line 141:
 
|}
 
|}
 
{|
 
{|
−
|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;"|'''6. Next, enter your server name, IP address/hostname, username, password and admin tenant ID.'''<br/>
−
Choose '' 'R1SoftBackups' '' from a dropdown menu and press '' 'Save Changes' ''.'''
+
Choose '' 'R1SoftBackups' '' from a dropdown menu and press '' 'Save Changes'.'''''
 
|}
 
|}
 
{|
 
{|
Line 148: Line 148:
 
|}
 
|}
 
{|
 
{|
−
|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;"|'''7. It is time to create a server group. To do so, click on '' 'Create Server Group'.'''''
 
|}
 
|}
 
{|
 
{|
Line 154: Line 154:
 
|}
 
|}
 
{|
 
{|
−
|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;"|'''8. Enter name, click on your previously created server, press '' 'Add' '' and afterwards '' 'Save Changes'.'''''
 
|}
 
|}
 
{|
 
{|
Line 162: Line 162:
 
==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;"|'''9. 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'.''
 
|}
 
|}
 
{|
 
{|
Line 169: Line 169:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''10. Enter product group name and press '' 'Save Changes' ''.'''
+
|style="padding: 0px 0px 20px 15px;"|'''10. Enter product group name and press '' 'Save Changes'.'''''
 
|}
 
|}
 
{|
 
{|
Line 175: Line 175:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''11. When you have a product group, you can create your product.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''11. When you have a product group, you can create your product.'''<br/>
−
To create a product click on '' 'Create a New Product' ''.
+
To create a product click on '' 'Create a New Product'.''
 
|}
 
|}
 
{|
 
{|
Line 182: Line 182:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''12. Afterwards, choose your product group and type from dropdown menus, enter your product name and press '' 'Continue' ''.'''
+
|style="padding: 0px 0px 20px 15px;"|'''12. Afterwards, choose your product group and type from dropdown menus, enter your product name and press '' 'Continue'.'''''
 
|}
 
|}
 
{|
 
{|
Line 188: Line 188:
 
|}
 
|}
 
{|
 
{|
−
|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;"|'''13. Now, go to '' 'Module Settings' '' section, choose both '' 'R1softbackups' '' and your previously created server group from dropdown menus.'''<br/>
 
Save changes.
 
Save changes.
 
|}
 
|}
Line 195: Line 195:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''14. Proceed to setting up module's options: '''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''14. Proceed to setting up module's options: '''<br/>
 
Use '' 'Generate' '' buttons to automatically generate custom fields and configurable options for the product.
 
Use '' 'Generate' '' buttons to automatically generate custom fields and configurable options for the product.
 
Allow options according to your needs:
 
Allow options according to your needs:

Revision as of 12:29, 9 September 2016

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.
Furthermore, the module will allow you to charge accounts payments directly in your WHMCS.

  • 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 WHMCS Templates Five and Six
✔ Supports WHMCS V5 and V6

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 R1Soft Backups For WHMCS.
RSB1.png
2. Upload and extract the module into the main WHMCS directory.

Files in your WHMCS directory should look like on the following screen.

RSB2.png
3. When you install R1Soft Backups 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
4. 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

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

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

RSB5.png
6. 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
7. It is time to create a server group. To do so, click on 'Create Server Group'.
RSB7.png
8. Enter name, click on your previously created server, press 'Add' and afterwards 'Save Changes'.
RSB8.png

Configuration of Product

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

Click on 'Create a New Group'.

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

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

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

Save changes.

RSB13.png
14. 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 you to administer an outside backups management server directly from your WHMCS.

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 WebLink to the server has been entered in Module Settings (look at point 14 for more information).

RSB17.png
Another option available from your client area is '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.
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=R1Soft_Backups_For_WHMCS&oldid=27921"
Navigation
WHMCS Modules
WHMCS Widgets
Tools And Applications
Translations
General
FAQ
Community
R1Soft Backups For WHMCS