|
|
| (199 intermediate revisions by 4 users not shown) |
| Line 1: |
Line 1: |
| − | <meta name="keywords" content="multibrand for whmcs, multibrand configuration, whmcs multibrand management, whmcs multibrand installation, whmcs multibrand common problems, about whmcs multibrand, whmcs multibrand documentation, whmcs multibrand faq, whmcs multibrand help, whmcs multibrand guide, whmcs multibrand wiki, whmcs multibrand tutorial, whmcs multibrand tips, whmcs multibrand wiki"></meta> | + | <meta name="keywords" content="hosting quota notifications for whmcs, hosting quota notifications configuration, whmcs hosting quota notifications management, whmcs hosting quota notifications installation, whmcs hosting quota notifications common problems, about whmcs hosting quota notifications, whmcs hosting quota notifications documentation, whmcs hosting quota notifications faq, whmcs hosting quota notifications help, whmcs hosting quota notifications guide, whmcs hosting quota notifications wiki, whmcs hosting quota notifications tutorial, whmcs hosting quota notifications tips, whmcs hosting quota notifications wiki"></meta> |
| − | <meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Multibrand For WHMCS Module."></meta> | + | <meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Hosting Quota Notifications For WHMCS Module."></meta> |
| | | | |
| − | =About [https://www.modulesgarden.com/products/whmcs/multibrand Multibrand For WHMCS]= | + | =About [https://www.modulesgarden.com/products/whmcs/hosting-quota-notifications Hosting Quota Notifications For WHMCS]= |
| | {| | | {| |
| − | |style="padding: 10px 0px 10px 0px;"|'''Multibrand For WHMCS''' To Do To Do To Do To Do To Do To Do To Do To Do To Do To Do To Do To Do To Do To Do To Do To Do | + | |style="padding: 10px 0px 10px 0px;"|'''Hosting Quota Notifications For WHMCS''' allows you to send automatic notifications to your clients whenever they exceed previously set bandwidth or disk usage. |
| − | To Do To Do To Do To Do To Do To Do To Do To Do To Do To Do To Do To Do To Do To Do To Do To Do
| + | Notifications can be sent in two ways: upon exceeding given resource tier or after exceeding given resource limit in a specified time period.<br /> |
| − | To Do To Do To Do To Do To Do To Do To Do To Do To Do To Do To Do To Do To Do To Do To Do To Do
| + | You can also define email templates and view details of each sent notification owing to logs. |
| − | To Do To Do To Do To Do To Do To Do To Do To Do To Do To Do To Do To Do To Do To Do To Do To Do
| + | |
| − | To Do To Do To Do To Do To Do To Do To Do To Do To Do To Do To Do To Do To Do To Do To Do To Do
| + | |
| − | To Do To Do To Do To Do To Do To Do To Do To Do To Do To Do To Do To Do To Do To Do To Do To Do
| + | |
| − | | + | |
| | |} | | |} |
| | <!--a comment maybe? --> | | <!--a comment maybe? --> |
| − | *'''Addon Features:'''
| |
| − | {|
| |
| − | |style="padding: 10px 0px 0px 30px;"|✔ User-Friendly Management Of Multiple Brands
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Easy Modification Of Existing Brands
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Assign Ticket Departments To Brands
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Configure Payment Gateways For Each Brand
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Configure Email Templates For Each Brand
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Configure SMTP Mailboxes For Each Brand
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Set Up Products, Addons And Domain Pricing For Each Brand
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Display And Migrate Clients Between Brands
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Display And Manage Relations Of Services, Invoices, Tickets, Knowledgebase, Downloads And Announcements Assigned To Brands
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Toggle Invoice Branding
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Toggle Brand Status On Click
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Toggle Auto Client Assign
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Monthly And Total Sale Amount Per Brand
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ View Dynamic Statistics On Each Brand
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 10px 30px;"|✔ View Logs
| |
| − | |}
| |
| | *'''Admin Area Features:''' | | *'''Admin Area Features:''' |
| | {| | | {| |
| − | |style="padding: 10px 0px 0px 30px;"|✔ Order Branded Products | + | |style="padding: 10px 0px 0px 30px;"|✔ Automatically Notify Your Clients Upon Exceeding Defined Limits Of Bandwidth And Disk Usage |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 10px 30px;"|✔ Create Branded Invoices | + | |style="padding: 0px 0px 0px 30px;"|✔ Configure Notification Groups |
| | |} | | |} |
| − | *'''Client Area Features:'''
| |
| | {| | | {| |
| − | |style="padding: 10px 0px 0px 30px;"|✔ Display Client Area Template And Default Language Depending On Brand | + | |style="padding: 0px 0px 0px 30px;"|✔ Choose Between Two Types Of Group Counting: |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Access Services, Invoices, Downloads, Ticket Departments and Payment Gateways Assigned To Brand | + | |style="padding: 0px 0px 0px 45px;"|✔ Tiered - Define Tiers Of Usage |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ View Knowledgebase Articles And Announcements Assigned To Brand | + | |style="padding: 0px 0px 0px 45px;"|✔ Fixed - Define Usage Grow Over Time |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Receive Branded Emails And Invoices | + | |style="padding: 0px 0px 0px 30px;"|✔ Assign Multiple Products To Single Notification Group |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Clients Registering Into A Brand May Be Automatically Assigned To It | + | |style="padding: 0px 0px 0px 30px;"|✔ Assign Email Templates Per Notification Group |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 10px 30px;"|✔ Clients Logging Into Another Brand May Be Automatically Assigned To It With The Same Access Details | + | |style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable Notification Groups |
| | |} | | |} |
| − | *'''Brand Configuration:'''
| |
| | {| | | {| |
| − | |style="padding: 10px 0px 0px 30px;"|✔ Set Up Brand Name | + | |style="padding: 0px 0px 10px 30px;"|✔ View Logs Of Sent Notifications |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Brand Company Name
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Brand Domain Address
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Brand Logo
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Brand Default Language
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Brand Template
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Brand Order Template
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Brand Address
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Brand Signature
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Brand Email Address
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Brand Ticket Departments
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Brand Graph Color
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Brand Terms Of Service URL
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Brand Invoice Sequential Number, Format And Pay To Text
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Set Up Branded Or Normal Payment Gateways
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Brand Email CSS Styling And Content
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 10px 30px;"|✔ Brand Email Templates In Various Languages
| + | |
| − | |}
| + | |
| − | *'''Branded Payment Gateways:'''
| + | |
| − | {|
| + | |
| − | |style="padding: 10px 0px 0px 30px;"|✔ 2Checkout
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Authorize.Net
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Authorize.Net CIM
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Checkout.com
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ PayPal REST
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 10px 30px;"|✔ Stripe
| + | |
| | |} | | |} |
| | *'''General Info:''' | | *'''General Info:''' |
| Line 161: |
Line 42: |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.4 Up To PHP 7 | + | |style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.6 Up To PHP 7.2 |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Template Six | + | |style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V7 |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 10px 30px;"|✔ Supports WHMCS V7
| + | |
| | |} | | |} |
| | | | |
| | =Installation= | | =Installation= |
| | {| | | {| |
| − | |style="padding: 10px 0px 30px 15px;"|'''This tutorial will show you how to successfully install and configure Multibrand For WHMCS.''' <br /> | + | |style="padding: 10px 0px 30px 15px;"|'''This tutorial will show you how to successfully install and configure Hosting Quota Notifications For WHMCS.''' <br /> |
| − | We will guide you step by step through the whole installation and configuration process.<br/><br/> | + | We will guide you step by step through the whole installation and configuration process. |
| − | '' '''Note:''' If you are still using any of Multibrand For WHMCS previous versions '''prior to v2.x''', [https://www.docs.modulesgarden.com/Multibrand_1.X_For_WHMCS read about it here].''
| + | |
| | |} | | |} |
| | ==Installation== | | ==Installation== |
| | {| | | {| |
| − | |style="padding: 10px 0px 20px 15px;"|'''1. Log in to your client area and download the module.''' | + | |style="padding: 10px 0px 20px 15px;"|'''1. Log in to our client area and download the module.''' |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:MB2_1.png]] | + | |style="padding: 0px 0px 20px 25px;"|[[File:HQN_1.png]] |
| | |} | | |} |
| | {| | | {| |
| − | |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 7, while the second one is aimed at PHP 5.4 up to PHP 5.6.<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 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'.''' |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:MB2_2.png]] | + | |style="padding: 0px 0px 20px 25px;"|[[File:PHP56_72.png]] |
| | |} | | |} |
| | {| | | {| |
| Line 195: |
Line 72: |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:MB2_2_2.png]] | + | |style="padding: 0px 0px 20px 25px;"|[[File:drfere.png]] |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 15px 15px;"|'''4. When you install Multibrand For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br /> | + | |style="padding: 0px 0px 15px 15px;"|'''4. When you install Hosting Quota Notifications For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br /> |
| − | File is located in '' 'modules/addons/MultibrandFunctionality/license_RENAME.php'.'' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'.'' | + | File is located in '' 'modules/addons/hosting_quota_notifications/license_RENAME.php' '' . Rename it from '' 'license_RENAME.php' '' to '' 'license.php' '' . |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:MB2_3.png]] | + | |style="padding: 0px 0px 20px 25px;"|[[File:HQN_3.png]] |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 15px 15px;"|'''5. In order to configure your license key, you have to edit the 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. You can find your license key in your client area'' → 'My Products'.'' | + | 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' ''. |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:MB2_4.png]] | + | |style="padding: 0px 0px 30px 25px;"|[[File:HQN_4.png]] |
| | |} | | |} |
| | | | |
| − | ==Activating Addon Module== | + | ==Configuration of Addon== |
| | {| | | {| |
| | |style="padding: 10px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system.'''<br /> | | |style="padding: 10px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system.'''<br /> |
| − | Log in to your WHMCS admin area. Go to '' 'Setup' '' → '' 'Addon Modules'. '' Afterwards, find '' 'Multibrand' '' and press '' 'Activate' '' button. | + | Log in to your WHMCS admin area. Go to '' 'Setup' '' → '' 'Addon Modules' ''. Afterwards, find '' 'Hosting Quota Notifications' '' and press '' 'Activate' '' button. |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:MB2_5.png]] | + | |style="padding: 0px 0px 20px 25px;"|[[File:HQN_5.png]] |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 15px 15px;"|'''7. In the next step you need to enable the hooks and grant access to this module.'''<br /> | + | |style="padding: 0px 0px 15px 15px;"|'''7. In the next step you need to permit access to this module.'''<br /> |
| − | To do so, click on '' 'Configure' '' button, go to '' 'Access Control' '' area and check the required group of administrators. Press '' 'Save Changes'.'' | + | To do so click on '' 'Configure' '' button, tick '' 'Access Control' '' near required admin role groups and press '' 'Save Changes' ''. |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:MB2_6.png]] | + | |style="padding: 0px 0px 30px 25px;"|[[File:HQN_6.png]] |
| | |} | | |} |
| | | | |
| − | ==Additional Settings==
| |
| | {| | | {| |
| − | |style="padding: 10px 0px 15px 15px;"|'''8. Now, set up the '' 'storage' '' folder with its subfolders as recursively writable.'''<br /> | + | |style="padding: 0px 0px 15px 15px;"|'''8. You have just successfully installed Hosting Quota Notifications For WHMCS!'''<br /> |
| − | This folder are located in '' 'your_whmcs/modules/addons/Multibrand/' '' location.
| + | You can access your module in '' 'Addons' '' → '' 'Hosting Quota Notifications' ''. |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:MB2_7.png]] | + | |style="padding: 0px 0px 30px 25px;"|[[File:HQN_7.png]] |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 10px 0px 15px 15px;"|'''9. You will also need to set up '' 'gateways' '' and '' 'callback' '' folders as writable.'''<br />
| + | |
| − | The '' 'gateways' '' folder is located in '' 'your_whmcs/modules/' '' and the '' 'callback' '' folder in '' 'your_whmcs/modules/gateways' '' (do '''NOT''' mistake the folders with those in the Multibrand addon location)''
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:MB2_7_0.png]]
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 15px 15px;"|'''10. The next step is replacing '' 'invoicepdf.tpl' '' file with '' 'invoicepdf_rename.tpl' '' for each of the templates used.'''<br />
| + | |
| − | The '' 'invoicepdf_rename.tpl' '' file is located in the '' 'your_whmcs/templates/six/' '' folder.<br />
| + | |
| − | Just remove the default '' 'invoicepdf.tpl' '' file from the template folder and rename the'' 'invoicepdf_rename.tpl' '' file to '' 'invoicepdf.tpl' '' in the same folder.
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:MB2_7_1.png]]
| + | |
| − | |}
| + | |
| − | | + | |
| − | ==Integration Code==
| + | |
| − | {|
| + | |
| − | |style="padding: 10px 0px 15px 15px;"|'''11. Now you can access your Multibrand For WHMCS module.'''<br />
| + | |
| − | Simply go to '' 'Addons' '' → '' 'Multibrand'.'' But, before you can start using the module, you still need to set up the '' 'Integration Code'. '' It is required for the correct logo branding and it should be done for all brand templates that you want to use.<br/>
| + | |
| − | It is very easy. Go to '' 'Utilities' '' → '' 'Integration Code' ''and follow the instructions given there, depending on the version of your WHMCS and the templates you are using.
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:MB2_8.png]]
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 30px 15px;"|'''12. And that is all! You have now completed the installation of the module.'''<br />
| + | |
| − | |}
| + | |
| − | | + | |
| − | ==Migration==
| + | |
| − | {|
| + | |
| − | |style="padding: 10px 0px 30px 15px;"|'''In the current beta 2.0.0 version it is not possible to easily migrate data from 1.8.X to the 2.X module version. <br/>
| + | |
| − | Such a migration functionality will be added in the future stable version. We are sorry for the inconvenience.
| + | |
| | |} | | |} |
| | | | |
| | =Configuration and Management= | | =Configuration and Management= |
| | {| | | {| |
| − | |style="padding: 10px 0px 30px 15px;"|'''In this section we will show you how to properly set up and use Multibrand For WHMCS.''' | + | |style="padding: 10px 0px 30px 15px;"|'''In this section we will show you how to properly set up and use Hosting Quota Notifications For WHMCS.''' |
| | |} | | |} |
| − | ==Brands== | + | ==Configuration== |
| | {| | | {| |
| − | |style="padding: 10px 0px 30px 15px;"|In the '' 'Brands' '' tab you can create and manage your brands using a single instance of WHMCS solution.<br/> | + | |style="padding: 10px 0px 15px 15px;"|In '' 'Configuration' '' page you can find the list of configured notification groups.<br /> |
| − | '' '''Important:''' Due to the module beta limitations, configuration of one of the brands must be manually set to your '''main WHMCS domain'''. Simplification of this process will be solved in the future editions.'' | + | You can enable/disable any of them, as well as alter or completely remove them.<br /> |
| | + | Press '' 'Create New Group' '' to proceed. |
| | |} | | |} |
| − | ===New Brand===
| |
| | {| | | {| |
| − | |style="padding: 10px 0px 20px 15px;"|Let us start by creating a new brand. For that purpose go to the '' 'Brands' '' tab and press '' 'Add a new brand' '' [[File:MB2_Plus.png|frameless]] button. | + | |style="padding: 0px 0px 20px 25px;"|[[File:HQN_9.png]] |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:MB2_10.png]] | + | |style="padding: 0px 0px 15px 15px;"|Now, you can define all products related to this configuration and email template which will be used to notify your clients.<br /> |
| | + | You can choose between two types of resource usage counting:<br /> |
| | + | *Fixed - define amount of resources over specific time period. If client usage growth has exceeded the given limit in specified time, a notification will be sent. |
| | + | *Tiered - defines amount of resources. If client exceeds given limit, a notification will be sent. |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 15px;"|Fill in the brands's '' 'Name' '' and '' 'Domain' '' with desired values and press '' 'Save' '' button. | + | |style="padding: 0px 0px 20px 25px;"|[[File:HQN_10.png]] |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:MB2_11.png]] | + | |style="padding: 0px 0px 15px 15px;"|For example, shown below module uses fixed counting type.<br /> |
| | + | As you can see, we have defined limits for both bandwidth and disk.<br /> |
| | + | Settings shown below result in sending notification to client upon: |
| | + | *bandwidth usage growth by 5GB during 21 days. |
| | + | *disk usage growth by 100GB over period of 14 days. |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 15px;"|Your first brand is created. Next, press '' 'Edit' ' '' [[File:MB2_Edit.png|frameless]] action button. | + | |style="padding: 0px 0px 30px 25px;"|[[File:HQN_11.png]] |
| | |} | | |} |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:MB2_11_1.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 15px;"|You will be moved to the brand configuration area, where you can manage your brand's information and settings.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:MB2_11_2.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 15px;"|
| |
| − | '' '''Note:''' Once the configuration of your brand is complete, you will still need to set up a CNAME DNS record before the brand is published (status - enabled).''<br/>
| |
| − | ''This record will point from the branded domain towards your main domain used by WHMCS. To learn more about setting up the CNAME records, proceed to the [[Multibrand_For_WHMCS#Creating_CNAME_Records|Creating CNAME Records]] section.''<br />
| |
| − | ''Do not forget to publish the brand as soon as the CNAME record is spread worldwide.''
| |
| − | |}
| |
| − |
| |
| − | ===Brand Information===
| |
| − | {|
| |
| − | |style="padding: 10px 0px 15px 15px;"|In the Brand Information window you can edit the brand name, domain name and custom logo. <br/>
| |
| − | In addition, you can see the current month's revenue, total sales and the last brand update.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:MB2_9.png]]
| |
| − | |}
| |
| − |
| |
| − | ===Settings===
| |
| − | {|
| |
| − | |style="padding: 10px 0px 20px 15px;"|In this window you will be able to configure all the most important settings of your brand including billing, payment gateways, SMTP and email templates configuration.
| |
| − | |}
| |
| − |
| |
| − | ====General====
| |
| − | {|
| |
| − | |style="padding: 10px 0px 15px 15px;"|In the general settings you will configure the main brand options. <br/>
| |
| − | First, fill out the brand's '' 'Email Address', 'Company Name' '' and '' 'TOS URL' ''. Next, choose the brand's '' 'Color', 'Ticket Departments' , 'Default Language', 'Template' '' and '' 'Order Template' ''.<br />
| |
| − | Make sure that the chosen template is integrated with Multibrand correctly (see the [https://www.docs.modulesgarden.com/Multibrand_For_WHMCS#Integration_Code Integration Code] section). Finally, toggle '' 'Auto Client Assign' '' if you wish to. <br/>
| |
| − | Here you can also manage your current brand's status, but you should change it to '' 'Enabled' '' only after you have configured the rest of the settings. <br/>
| |
| − | Do not forget to press '' 'Save Configuration' ''.
| |
| − | <br/><br/>
| |
| − | '' '''Note:''' Currently all new users added by admin or through API will not be assigned to any brand by default. This feature will be included in the next releases.''
| |
| − | <!--
| |
| − | '' '''Note:''' Only published brands can be set as default. New users added by admin or through API will be assigned to the default brand.''
| |
| − | -->
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:MB2_11_3.png]]
| |
| − | |}
| |
| − | {|
| |
| − |
| |
| − | ====Billings====
| |
| − | {|
| |
| − | |style="padding: 10px 0px 15px 15px;"| In the '' 'Billing' '' settings you can configure the design of your invoices.
| |
| − | *'''Invoice Branding''' - if enabled, the invoices will be branded with the number and basic information
| |
| − | *'''Invoice Pay To Text''' - address that is displayed on the invoice as the 'Pay To' details.
| |
| − | *'''Sequential Invoice Number Format''' - if invoice branding is enabled, the provided sequential invoice number format will be used
| |
| − | *'''Next Sequential Number''' - change this option only if you want to reset the automatic sequential numbering. Otherwise leave empty
| |
| − | '' '''Note:''' Remember to do the '[https://www.docs.modulesgarden.com/Multibrand_For_WHMCS#Additional_Settings Additional Settings]' step during module installation to make the PDF invoices also branded.''
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:MB2_12.png]]
| |
| − | |}
| |
| − |
| |
| − | ====Payment Gateways====
| |
| − | {|
| |
| − | |style="padding: 10px 0px 15px 15px;"| This tab allows you to configure a payment gateway for the brand which will work independently from the one configured in WHMCS.<br />
| |
| − | You can check the list of the currently available gates in the [https://www.docs.modulesgarden.com/Multibrand_For_WHMCS#About_Multibrand_For_WHMCS Feature List].<br/>
| |
| − | If in the future releases you would like to see a payment gateway that is not yet available, please contact our [https://www.modulesgarden.com/support support].
| |
| − | <br/><br/>
| |
| − | To add a new payment gateway configuration, press '' 'Add' '' [[File:MB2_Plus.png|frameless]] button.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:MB2_13.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 15px;"|Next, choose the desired gate from the list and press '' 'Confirm' '' button.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:MB2_14.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 15px 15px;"|Finally, fill in the payment gateway settings according to the details received from the provider. <br/>
| |
| − | Save the configuration and activate the gateway.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:MB2_15.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 15px 15px;"|'' '''Note:''' You may still use any other payment gateway which is active in your WHMCS system. These gates will have a ''' (WHMCS) ''' label.''<br/>
| |
| − | ''Multibrand For WHMCS can work with any gateway that works within your WHMCS. The only limitation is that these payment gateways use the same settings for all brands.''
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:MB2_15_2.png]]
| |
| − | |}
| |
| − |
| |
| − | <br/><br/>
| |
| − |
| |
| − | ====SMTP====
| |
| − | {|
| |
| − | |style="padding: 10px 0px 15px 15px;"| If you would like to use for your brand an outgoing mail configuration which is different from the one in the main WHMCS settings, you can do so in this tab.<br/>
| |
| − | In addition, you can set your custom CSS email styling as well as the header and footer content.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:MB2_16.png]]
| |
| − | |}
| |
| − |
| |
| − | ====Email Templates====
| |
| − | {|
| |
| − | |style="padding: 10px 0px 15px 15px;"| In this window you can set up each branded email template in five available categories.<br/>
| |
| − | *If '''enabled''', the template configured here will be sent to the clients using the branded SMTP settings instead of the ones configured in the main WHMCS template and configuration.
| |
| − | *If '''enabled''', but not configured yet, the main WHMCS template will be sent with branding applied to it.
| |
| − | *If '''disabled''', the main WHMCS template will be sent using the main WHMCS SMTP configuration without any branding applied.
| |
| − | To start editing a branded template, simply press '' 'Edit' '' [[File:MB2_Edit.png|frameless]] button.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:MB2_17.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 15px 15px;"| Next, enter the desired subject and message content. You can also create more versions, in several languages. <br/>
| |
| − | IAdditionally, you can use the available merge fields tags just like in the standard email templates. Save the changes after finishing.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:MB2_18.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 10px 0px 15px 15px;"| Finally, toggle the edited template to enabled and save the configuration. Next to the edited template you will see the '' 'Branded' '' label. <br/>
| |
| − | If you would like to restore the default template, simply return to editing it and click the '' 'Delete Template' '' button.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:MB2_19.png]]
| |
| − | |}
| |
| − |
| |
| − | ===Services Pricing===
| |
| − | {|
| |
| − | |style="padding: 10px 0px 20px 15px;"|In this section you can configure separate prices for '' '''products''', '''addons''' '' and '' '''domains''' ''.<br/><br/>
| |
| − | To start, select the product, addon or domain tab and click on the '' 'Add' '' [[File:MB2_Plus.png|frameless]] button. In the following example you will see how to add branding for product pricing.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:MB2_20.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 15px;"|Select the product for which you want to set branded prices and click '' 'Save' ''.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:MB2_21.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 15px;"|Next, open the pricing editor for the chosen product.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:MB2_22.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 15px;"|Here you can configure the desired prices in selected billing cycles and currencies. <br/>
| |
| − | You can also automatically fill in the amounts from the main product and update them, refreshing the currencies rate.<br/><br/>
| |
| − |
| |
| − | '' '''Note:''' Availability of billing cycles, prices and currencies to be edited depends on their main configuration in WHMCS.''<br/>
| |
| − | ''If one of them is not available for branding, it means that there is no corresponding configuration in the main WHMCS.''
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:MB2_23.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 15px;"|From now on, the pricing for this product will be branded. In the same way, you can also configure pricing for addons and domains.
| |
| − | |}
| |
| − |
| |
| − | ===Relations===
| |
| − | {|
| |
| − | |style="padding: 10px 0px 30px 15px;"|In this section you can see which '' '''Clients, Services, Invoices, Knowledgebase, Downloads''' '' and ''' ''Announcements'' ''' are assigned to this brand. <br/>
| |
| − | In addition, you can manually manage, assign and unassign selected items to the brand.<br/>
| |
| − | Do not forget to check the '' '[https://www.docs.modulesgarden.com/Multibrand_For_WHMCS#Branded_Admin_Area_Functionalities Branded Admin Area Functionalities]' '' section, where you will find more brand relation management functionality outside the Multibrand addon.<br/><br/>
| |
| − |
| |
| − | '' '''Note:''' Currently there is no possibility of mass management, assigning and unassigning selected items to the brand. This functionality will be implemented in future releases.
| |
| − | |}
| |
| − |
| |
| − | ====Clients====
| |
| − | {|
| |
| − | |style="padding: 10px 0px 15px 15px;"|In the clients tab you can see customers who are assigned to the brand and the date on which they were assigned.<br/>
| |
| − | Assignment takes place at the moment of client's registration for the branded domain. You can also manually assign the already existing customers to the brand or migrate them to another.
| |
| − |
| |
| − | '' '''Note:''' If 'Auto Client Assign' option is enabled, then the customers who are already registered in one of the brands and try to log in to another brand,will also be automatically assigned to it.''<br/>
| |
| − | Therefore, one customer can be assigned to several brands at the same time.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:MB2_24.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 15px 15px;"| To assign an existing client to the brand, press '' 'Add' '' [[File:MB2_Plus.png|frameless]] button. <br/>
| |
| − | In the pop-up select the customer you want to add to the brand and press '' 'Save' ''.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:MB2_25.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 15px 15px;"| You can also migrate the customers from this brand to another one. <br/>
| |
| − | Click '' 'Migrate' '' [[File:MB2_Migrate.png|frameless]] button next to the client and then select the brand to which you want to assign the client.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:MB2_26.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 15px;"| And finally, if you want to delete a customer's relationship with this brand, press the '' 'Delete' '' [[File:MB2_Delete.png|frameless]] button and confirm the action.
| |
| − | |}
| |
| − |
| |
| − | ====Services====
| |
| − | {|
| |
| − | |style="padding: 10px 0px 15px 15px;"|In the Services tab you can see which '' '''Products, Addons''' '' and '' '''Domains''' '' have a relation with this brand.<br/>
| |
| − | These services are automatically added to the brand while ordering from the branded domain.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:MB2_27.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 15px 15px;"|You can also manually add a relation for a service that is not yet branded.<br/>
| |
| − | Press '' 'Add' '' [[File:MB2_Plus.png|frameless]] button and then select the type and service you want to assign to the brand.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:MB2_28.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 15px;"|Again, if you want to delete a service relation with the brand, press '' 'Delete' '' [[File:MB2_Delete.png|frameless]] button and confirm the action.
| |
| − | |}
| |
| − |
| |
| − | ====Invoices====
| |
| − | {|
| |
| − | |style="padding: 10px 0px 15px 15px;"|In this tab you can see which invoices have a relation with your brand.<br/>
| |
| − | These invoices are automatically added to the brand after the order has been created from the branded domain.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:MB2_29.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 15px 15px;"|You can also manually add a relation for the invoice that is not yet branded.<br/>
| |
| − | Press '' 'Add' '' [[File:MB2_Plus.png|frameless]] button and select the invoice you want to assign to the brand.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:MB2_30.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 15px;"|If you want to delete an invoice relation with the brand, press '' 'Delete' '' [[File:MB2_Delete.png|frameless]] button and confirm the action.
| |
| − | |}
| |
| − |
| |
| − | ====Tickets====
| |
| − | {|
| |
| − | |style="padding: 10px 0px 15px 15px;"|In this tab you can see which tickets have a relation with the brand.<br/>
| |
| − | These tickets are automatically branded after a ticket has been opened in one of the [https://www.docs.modulesgarden.com//Multibrand_For_WHMCS#General earlier branded departments].
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:MB2_31.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 15px 15px;"|You can also manually add a relation for the ticket that is not yet branded.<br/>
| |
| − | Press '' 'Add' '' [[File:MB2_Plus.png|frameless]] button and select the ticket you want to assign to the brand.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:MB2_32.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 15px;"|If you want to delete a ticket relation with the brand, press '' 'Delete' '' [[File:MB2_Delete.png|frameless]] button and confirm the action.
| |
| − | |}
| |
| − |
| |
| − | ====Knowledgebase====
| |
| − | {|
| |
| − | |style="padding: 10px 0px 15px 15px;"|In this tab you can see which of your knowledgebase articles have a relation with the brand.<br/>
| |
| − | In addition, here you can find statistics of views, useful points, number of votes and the date of assignment to the brand.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:MB2_33.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 15px;"|To add a relation for the knowledgebase articles, press '' 'Add' '' [[File:MB2_Plus.png|frameless]] button and select the article you want to assign to the brand.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:MB2_34.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 15px;"|If you want to delete a knowledgebase article relation with the brand, press '' 'Delete' '' [[File:MB2_Delete.png|frameless]] button and confirm the action.
| |
| − | |}
| |
| − |
| |
| − | ====Downloads====
| |
| − | {|
| |
| − | |style="padding: 10px 0px 15px 15px;"|In this tab you can see which of your files available for download have a relation with brand.<br/>
| |
| − | In addition, you can find here download category, type, number of downloads and date of assignment to the brand.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:MB2_35.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 15px;"|To add a relation for the download press '' 'Add' '' [[File:MB2_Plus.png|frameless]] button and select the file you want to assign to the brand.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:MB2_36.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 15px;"|And if you want to delete a download relation with the brand, press '' 'Delete' '' [[File:MB2_Delete.png|frameless]] button and confirm the action.
| |
| − | |}
| |
| − |
| |
| − | ====Announcements====
| |
| − | {|
| |
| − | |style="padding: 10px 0px 15px 15px;"|In this tab you can see which of your announcements have a relation with brand.<br/>
| |
| − | In addition, you can find here date of announcement creation, assignment to the brand and published status.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:MB2_37.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 15px;"|To add a relation for the announcement press '' 'Add' '' [[File:MB2_Plus.png|frameless]] button and select the article you want to assign to the brand.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:MB2_38.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 15px;"|And if you want to delete a announcement relation with the brand, press '' 'Delete' '' [[File:MB2_Delete.png|frameless]] button and confirm the action.
| |
| − | |}
| |
| − |
| |
| − | ==Statistics==
| |
| − | {|
| |
| − | |style="padding: 10px 0px 15px 15px;"|In the statistics section you will find sales charts of selected brands.<br/>
| |
| − | You can filter them by date period and selected brands.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:MB2_39.png]]
| |
| − | |}
| |
| − |
| |
| | ==Logs== | | ==Logs== |
| | {| | | {| |
| − | |style="padding: 10px 0px 20px 15px;"|Logs sections allows you to view warnings and errors related to your brands. | + | |style="padding: 10px 0px 15px 15px;"|Under '' 'Logs' '' page you can view information about sent notifications. |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:MB2_40.png]] | + | |style="padding: 0px 0px 30px 25px;"|[[File:HQN_12.png]] |
| | |} | | |} |
| − | | + | ==Notifications== |
| − | ==Branded Admin Area Functionalities== | + | |
| | {| | | {| |
| − | |style="padding: 10px 0px 30px 15px;"|Due to the beta version, not all sections available in the previous module versions provide the direct actions with the brand relations yet. <br/> | + | |style="padding: 10px 0px 15px 15px;"|You can create as many notifications as you wish.<br /> |
| − | See the [https://www.docs.modulesgarden.com/Multibrand_For_WHMCS#Beta_Version_2.0.0 Branding Limitations] section for more information. More admin area integrations are coming coon.
| + | The only requirement is their type being set to '' 'Product/Service' ''.<br /> |
| | + | Additionally, you can use {if} statement, as shown below: |
| | + | {if $bw_over} Your bandwidth usage is over {$bw_over}MB{if $bw_current} (current: {$bw_current}MB){/if}.{/if} |
| | + | {if $disk_over}Your disks usage is over {$disk_over}MB{if $disk_current} (current: {$disk_current}MB){/if}.{/if} |
| | + | It will allow you to use this email template for bandwidth and disk notifications at the same time. |
| | |} | | |} |
| − | ===Order Creation===
| |
| | {| | | {| |
| − | |style="padding: 10px 0px 15px 15px;"|If the administrator wants to create an order for a client manually, their can directly create a relation to the selected brand (provided that the client belongs to it). <br.> Additionally, their can also assign a payment gateway available in a given brand.
| + | |style="padding: 0px 0px 30px 25px;"|[[File:HQN_13.png]] |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:MB2_42.png]] | + | |
| | |} | | |} |
| | | | |
| − | ===Invoices=== | + | =Tips= |
| | {| | | {| |
| − | |style="padding: 10px 0px 20px 15px;"|If the administrator creates a new invoice for the customer, he has the possibility to select a direct relationship with the given brand. | + | |style="padding: 10px 0px 30px 15px;"| |
| | |} | | |} |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:MB2_43.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 10px 0px 20px 15px;"|Additionally, for previously created invoices there is also a possibility of direct changing the brand relation.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:MB2_44.png]]
| |
| − | |}
| |
| − | <!--
| |
| − | ===Announcements===
| |
| − | ===Downloads===
| |
| − | ===Knowledgebase===
| |
| − | -->
| |
| | | | |
| − | ==Branded Client Area== | + | =Update Instructions= |
| | {| | | {| |
| − | |style="padding: 10px 0px 20px 15px;"|Multibrand For WHMCS offers multiple client areas in one solution and lets you have your clients assigned to them.<br/> | + | |style="padding: 10px 0px 30px 15px;"|Essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.<br/><br/> |
| − | For example each brand domain can have a separate template, logo, language, services and invoices. <br/>
| + | 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!<br/> |
| − | You can find more information about what functionality can be branded in the [https://www.docs.modulesgarden.com/Multibrand_For_WHMCS#About_Multibrand_For_WHMCS Features] list.
| + | 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.<br/> |
| | |} | | |} |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:MB2_45.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 15px;"|On the following screen you can see invoices generated for a brand.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:MB2_46.png]]
| |
| − | |}
| |
| − | ==Branded Emails==
| |
| − | {|
| |
| − | |style="padding: 10px 0px 15px 15px;"|Brand configuration also apply to emails sent to clients.<br />
| |
| − | If you have enabled branding of a given template, the email sent to the client will be sent using the mailbox specified in the SMTP settings of the given brand.<br />
| |
| − | Additionally, the subject, logo, content and signature will also be branded accordingly. Here you can see an example of an order email.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:MB2_47.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 15px;"|More information you will find in branded [https://www.docs.modulesgarden.com/Multibrand_For_WHMCS#Email_Templates Email Templates] configuration.
| |
| − | |}
| |
| − |
| |
| − | ==Domains & CNAME Records Configuration==
| |
| − | {|
| |
| − | |style="padding: 10px 0px 15px 0px;"|In this section you will find guides on how to create ''CNAME'' record in popular control panels.<br />
| |
| − | For instance, if your branded domain is '' 'reseller.com' '' and domain with your WHMCS is '' 'whmcs.domain.com' '', your ''CNAME'' will be '' 'www.reseller.com. CNAME whmcs.domain.com.'.''<br />
| |
| − | '' '''Note 1:''' As you can see above, each domain has to be closed with a dot.''<br />
| |
| − | '' '''Note 2:''' To learn more about certificate requirements, visit [[Multibrand_For_WHMCS#Common_Problems|Common Problems]] section.''
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 0px;"|Domain used by each of the brands '''must be parked''' on the main domain.<br/>In case a domain cannot be parked or it is a subdomain, you must create ''CNAME'' records that will redirect from the brand domain to the main domain.<br/>
| |
| − | Only when you have parked your domains you can move to setting ''CNAME'' records on your panels. See the tips below.
| |
| − | |}
| |
| − | ===cPanel===
| |
| − | {|
| |
| − | |style="padding: 10px 0px 10px 15px;"|1. Log into your cPanel.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 10px 15px;"|2. Press '' 'Simple DNS Zone Editor' '' under '' 'Domains' '' section.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 5px 15px;"|3. Select the domain you wish to manage from the menu.<br />
| |
| − | '' '''Note:''' This step is required only if you own more than one domain.''
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 15px;"|4. Fill in '' 'Name' '' and '' 'CNAME' '' record and press '' 'Add CNAME Record'. ''<br />
| |
| − | '' '''Note:''' To define record's TTL, you have to use '' 'Advanced DNS Zone Editor'.
| |
| − | |}
| |
| − |
| |
| − | ===DirectAdmin===
| |
| − | {|
| |
| − | |style="padding: 10px 0px 10px 15px;"|1. Log into your DirectAdmin.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 10px 15px;"|2. Click '' 'DNS Administration' ''.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 10px 15px;"|3. Afterwards, press select the desired domain.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 15px;"|4. Fill in the full domain/subdomain into the CNAME record and press '' 'Add' '' next to it.<br />
| |
| − | '' '''Note:''' Do not forget to place a dot at the end.''
| |
| − | |}
| |
| − |
| |
| − | ===Plesk===
| |
| − | {|
| |
| − | |style="padding: 10px 0px 10px 15px;"|1. Log into your Plesk panel.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 10px 15px;"|2. Press '' 'Domains' '' under '' 'Hosting Services' '' section.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 5px 15px;"|3. Find the domain to be edited, and click on the corresponding Control Panel link.<br />
| |
| − | Afterwards, proceed to '' 'Websites & Domains' '' tab and press '' 'DNS Settings' ''.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 5px 15px;"|4. Find the domain to be edited, and click on the corresponding Control Panel link.<br />
| |
| − | Afterwards, proceed to '' 'Websites & Domains' '' tab and press '' 'DNS Settings'.''
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 10px 15px;"|5. Add a new record or edit an existing one.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 10px 15px;"|6. Now, change the record type to '' 'CNAME' '' and fill in both '' 'Domain name' '' and '' 'Canonical name'.''<br />
| |
| − | Finish by pressing '' 'OK'.''<br />
| |
| − | '' '''Note:''' The changes will take between 4 to 8 hours to update worldwide.''
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 15px;"|'''Remember to restart your server once it is configured.'''
| |
| − | |}
| |
| − |
| |
| − | ==SSL Certificate==
| |
| − | {|
| |
| − | |style="padding: 10px 0px 30px 15px;"|In this section you will find all information related to SSL certificate in WHMCS using Multibrand.<br />
| |
| − | If your branded domains or WHMCS domain are using SSL connection''', all of them need to have the same certificate.<br />
| |
| − | Certificate type required:
| |
| − | *'''Wildcard''' - if all brands and main WHMCS are using the same domain.<br />
| |
| − | *'''SAN''' - if your brands and main WHMCS are using different domains.<br />
| |
| − | This is due the way in which WHMCS works. It is not the limitation of our module which is using '' 'WHMCS System URL' '' scheme.<br />
| |
| − | ===cPanel===
| |
| − | {|
| |
| − | |style="padding: 10px 0px 10px 15px;"|Installing SSL certificate for domains managed from cPanel consists of the following steps:
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 10px 15px;"|1. Log into your cPanel and press '' 'SSL/TSLS Manager' '' under '' 'Security' '' section.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 10px 15px;"|2. Click on '' 'Manage SSL sites' '' under '' 'Install and Manage SSL for your site (HTTPS)'.''
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 10px 15px;"|3. (installing the certificate) Select the domain, paste certificate and private key and save the settings.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 15px;"|4. (using already installed certificate) Select it from '' 'Browse Certificates' '' and save the settings.
| |
| − | |}
| |
| − |
| |
| − | ==Branding Limitations==
| |
| − |
| |
| − | ===Beta Version 2.0.0===
| |
| − | {|
| |
| − | |style="padding: 10px 0px 20px 15px;"|For better stability and support for future improvements, Multibrand For WHMCS in version 2.0.0 has been completely rewritten. <br>
| |
| − | For this reason, some of the functionalities in previous versions are not yet available, or are operating in a limited way. <br/>
| |
| − | These features will be successively restored in future versions. Here are some of the features that are not currently being supported:
| |
| − | *'''Brand Details''' - a column with brands in admin area, displayed in such places like clients and orders lists. Also branded details in client's profile.
| |
| − | *'''Login as Client to a Brand''' - action directly accessible from the client profile in admin area
| |
| − | *'''Create Invoice/Quote/Ticket in a Brand''' - action directly accessible from the client profile in admin area
| |
| − | *'''Choose Brand in particular WHMCS sections''' - feature enabling direct brand selection on ''ticket, quote, announcement, download'' and ''knowledgebase'' view (currently only ''order'' and ''invoice'' view is supported)
| |
| − | *'''Product Bundle''' - not yet available for branding
| |
| − | *'''Brand Reports''' - the current statistics are limited
| |
| − | *'''Brand Previews''' - preview the client area of the brand is not yet implemented
| |
| − | *'''WHMCS V6''' - Multibrand For WHMCS V2 will no longer support ''WHMCS V6'' and template ''five''
| |
| − | |}
| |
| − |
| |
| − | ===WHMCS===
| |
| − | {|
| |
| − | |style="padding: 10px 0px 20px 15px;"|In this section we will list the parts of WHMCS which cannot be branded or may be working in an odd way.
| |
| − | *'''Bridges''' - Multibrand For WHMCS does not support any kind of bridges (WordPress, Jomla).
| |
| − | *'''Link replacement''' - currently links are replaced with their branded counterparts with a visible delay.<br/>This is the only way we could do that for the time being.<br />
| |
| − | *'''Clients Profile → Send Email''' - if you try to send an email template, a branded counterpart of which exists, you will receive an error.<br/>This is due to its branded counterpart being sent, while default email is blocked.
| |
| − | *'''Branded Quote → Duplicate''' - duplicating a branded quote results in receiving unbranded quote.
| |
| − | *'''Configurable Options Pricing''' - currently there is no possibility to set different pricing per brand for configurable options
| |
| − | *'''Emails''' - not branded due to the lack of possibility to determine from which brand an email should be sent:
| |
| − | **'''Affiliate Monthly Referrals Report'''
| |
| − | **'''Clients Only Bounce Message'''
| |
| − | |}
| |
| − | ===WHMCS Modules and Others===
| |
| − | {|
| |
| − | |style="padding: 10px 0px 20px 15px;"|In this section we will list the WHMCS modules and other services which do not support multibranding or do not cooperate with Multibrand For WHMCS at all.<br /><br />
| |
| − |
| |
| − | *'''WHMCS Modules'''
| |
| − | **'''SMS Center For WHMCS''' - SMS sent to customers cannot be branded. Default set of SMS templates is sent to clients from all brands.<br />
| |
| − | **'''Resellers Center For WHMCS''' - this module is not yet compatible with our Multibrand For WHMCS module
| |
| − | <br />
| |
| − | *'''Others'''
| |
| − | **'''Cloudflare''' - it is a service that will [http://support.cloudflare.com/hc/en-us/articles/203322654-Why-is-my-domain-resolving-to-the-wrong-IP-when-I-do-a-DNS-lookup-or-ping mask your server IP address]. <br /> This is because they use their own DNS to resolve to one of their many reverse proxy servers and will cause incompatibility with Multibrand module. <br />You may disallow the CloudFlare network to assume NS authority and don't become the intermediary between a user and your server, but then your Cloudflare service may become useless.
| |
| − | |}
| |
| − |
| |
| − | =Tips=
| |
| − | {|
| |
| − | |style="padding: 10px 0px 5px 15px;"|'''1. The logo image is usually hard coded into the WHMCS template files.'''<br />
| |
| − | In order to use logo file provided in the '' 'Multibrand For WHMCS' '' module, find proper line at the template file and replace it with '' '{$logo}' '' variable.<br />
| |
| − | The line responsible for a displayed logo is placed at the '' 'header.tpl' '' file located in a currently used template.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 10px 15px;"|2. If you want Captcha security option to be displayed in your client area for all branded domains, you need to configure each of those domains in your Google Account as well.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:MB2_41.png]]
| |
| − | |}
| |
| − |
| |
| | =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.''' |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 5px 15px;"|'''2. If your CNAME record is not working''', remember that first domain name in CNAME record should be branded domain.<br />
| + | |
| − | The second one is the domain on which you have your WHMCS. The redirection goes from the first domain to the second. <br />
| + | |
| − | Dots after domains are also important.<br />
| + | |
| − | Take note that there could be a delay with propagation of changes for DNS servers while using A type CNAME records.
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 5px 15px;"|'''3. If your branded domain or WHMCS domain are using SSL connection''', both of them need to have the same certificate.<br />
| + | |
| − | If both of them are using the same domain, you will need a wildcard certificate.<br />
| + | |
| − | If they are using different domains, secure them with the SAN certificate.<br />
| + | |
| − | This is due to the way WHMCS works. It is not the limitation of our module.
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 5px 15px;"|'''4. Please remember that Multibrand For WHMCS works flawlessly with the ''WHMCS V7'' and officially supported template '' 'Six' ''.<br/>
| + | |
| − | In case you are using some custom template, you must be aware that unexpected errors might occur and we cannot take the responsibility for solving them.
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 30px 15px;"|
| + | |
| − | '''5. Multibrand For WHMCS module is not compatible with our Resellers Center For WHMCS.'''<br/>
| + | |
| − | There is no integration between these modules and we '''do not''' recommend using them together.
| + | |
| | |} | | |} |
