Multibrand 1.X For WHMCS
Contents
|
About Multibrand For WHMCS
Article update is ongoing on this page, watch out for broken links and unclear descriptions!
We are sorry for the inconvenience caused.
Multibrand For WHMCS will allow you to handle multiple brands on multiple websites while using a single WHMCS installation.
You will be able to customize your brand through modifying factors like client area template, logo, brand name, address and more. |
- Admin Area Features:
✔ User Friendly Management Of Multiple Brands |
✔ Easy Modification Of Existing Brands |
✔ Assign Unbranded Clients To Brands |
✔ Unassign Branded Clients From Brands |
✔ Migrate Clients Between Brands |
✔ Assign Products To Brands |
✔ Assign Product Groups To Brands |
✔ Assign Ticket Departments To Brands |
✔ Configure Payment Gateways For Each Brand Separately - PayPal And 2CheckOut (beta) |
✔ Display Active Clients, Invoices, Orders, Tickets And Services Associated To Brands |
✔ Quick Preview Of The Branded Client Area |
✔ Publish/Unpublish Brand On Click |
✔ Set Brand As Default - Automatic Assignment Of New Clients |
✔ Brand Reports - The List Of Clients, Invoices, Orders, Tickets And Services |
✔ Dynamic Brands Comparison Reports - Various Graph Types |
✔ Generate And Manage Email Templates For Brands |
- Client Area Features:
✔ Branded Clients Can Only Log Into The Brand They Are Assigned To |
✔ Multibranded Clients Can Log Into All Existing Brands With The Same Access Details |
✔ Receive Branded Emails And Invoices |
✔ Access To Products, Invoices, Ticket Departments and Payment Gateways Assigned To The Brand |
✔ Displayed Client Area Template And Default Language Depend On The Brand |
- Brand Configuration:
✔ Brand URL Address |
✔ Brand Name |
✔ Company Name |
✔ Brand Logo |
✔ Brand Language |
✔ Brand Template |
✔ Brand Address |
✔ Brand Email |
✔ Default Brand For New Accounts |
✔ Brand Graph Color |
- General Info:
✔ Multi-Language Support |
✔ Supports WHMCS V5 and Later |
Installation
This tutorial will show you how to successfully install and configure Multibrand For WHMCS. We will guide you step by step through the whole installation and configuration process. |
1. Log in to your client area and download Multibrand For WHMCS. |
2. Upload and extract the module into the main WHMCS directory. Files in your WHMCS directory should look like this. |
3. When you install Multibrand for the first time you have to rename 'license_RENAME.php' file. File is located in 'modules/addons/MultibrandFunctionality/license_RENAME.php' . Rename it from 'license_RENAME.php' to 'license.php' . |
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 at your client area → 'My Products' . |
5. Now you have to activate the module in your WHMCS system. Log in to your WHMCS admin area. Go to the 'Setup' → 'Addon Modules' . Afterwards, find 'Multibrand' and press 'Activate' button. |
6. In the next step you need to permit access to this module. To do so click on 'Configure' button, tick 'Access Control' near required admin role groups and press 'Save Changes' . |
7. Last step is setting 'logos' folder as writeable. Folder is located at the 'you_whmcs/modules/addons/MultibrandFunctionality/storage/' . |
8. You have just successfully installed Multibrand For WHMCS! You can access your module at the 'Addons' → 'Multibrand' . |
Configuration and Management
At this section we will show you how to properly set up and use a Multibrand For WHMCS. |
Dashboard
Under 'Dashboard' you can find basic information about the module and current status of 'logos' folder. It is required to set up 'logos' folder as writable in order to upload logos of your brands. |
Brands Management
'Brands Management' tab allows you to create and manage your brands on a single instance of WHMCS solution. Important 1: Clients will be able to log into the main client area until you set up any brand as published. |
New Brand
Let's start by creating a new brand. For that purpose go to the 'Brands Management' tab and press 'Create New Brand' button. |
Now, fill 'Brand Base URL' , 'Brand Email' , 'Brand Name' , 'Company Name' and 'Address' with desired values. Values at the 'Address' field will be used as a company address and displayed at e.g. created invoices. |
Afterwards, select desired brand language, template and graph colour. Additionally, upload logo which will be used at the branded invoices at the client area and branded emails. |
Last step is setting up DNS record, which will be pointing from branded domain to your main domain used by WHMCS. To learn more about setting up CNAME records, proceed to Creating CNAME Records section. |
Management of Existing Brands
To manage your brand, press 'Manage' button next to it as show on the following screen. |
General
General tab contains cofiguration of the brand. You can modify your brand at any time, simply alter wanted parameters and press 'Save Changes' . |
Products
This tab allows you to assign products configured in your system to the brand. Note: Product can be assigned to mutiple brands in the same time. |
Ticket Department
Here you can choose department available on the brand. |
Client
'Client' tab allows you to assign unbranded clients to the brand. |
File:MB 16.png |
Migrations
While 'Client' enables you to brand unbranded clients, 'Migrations' allows you to move clients between brand. As you can see on the following screen, brand to which client is assigned, is displayed next to him. |
File:MB 17.png |
Payment Gateway
This tab allows you to configure payment gateway for the brand. Note: Owing to 'Payment Gateway' tab, you can use different details per brand. |
Email Templates
Here you are able to generate email templates for the brand only. Check 'Create Brand Templates' and press 'Save Changes' to create them. |
Back To Brands Management
Alternatively, you can edit brand values visible at the 'Brands Management' tab by pressing on them. Choose/type desired value and confirm changes. |
Each brand can be disabled through pressing 'Published' (red) or set up as default through clicking on 'Default' (blue) button. Both of them are placed in 'Change Status' column as shown on the screen below. |
In order to view more details of brand, press 'Toggle Details' button next to a brand. Here you can find ID of a brand, provided address and check whether this brand is set up as a default for new accounts. |
You can also access the client area of a brand through pressing a 'Preview' button. Client area should appear in a popup window as shown on the following screen. |
Brand Reports
At the 'Brand Reports' tab you can easily view reports concerning specified brand. You can check reports of clients, invoices, orders, tickets and services bounded to selected brand. |
In an addition to that, you can select quantity of records per page, search specified record and order records by selected column. |
You can also compare all your brands using tabs marked on the following screen. Here you can compare them by amount of clients, orders, services, tickets, invoices, domains and income using various graph types. |
Membership In The Admin Area
Multibrand For WHMCS makes management of WHMCS easier through introducing 'Brand Details' column. 'Brand Details' column inform you about membership of clients, invoices or services to a brand. |
At the order list it looks similar. This column was implemented for lists of clients, invoices, orders, tickets and services. Through pressing a brand name, you will be moved directly to a report page of that brand. |
Branded Client Area
Owing to Multibrand For WHMCS your clients can log into different client areas which are using one WHMCS solution. |
Also invoices generated for different brands use settings of brand on which client is logged in. |
Branded Email Templates
Settings of brand also apply to emails sent to clients. On the following screen you can see exemplary order email. |
Creating CNAME Records
In this section you will find guides on how to create CNAME record in popular control panels. For sample where 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.'. |
cPanel
1. Log into your cPanel panel. |
2. Press 'Simple DNS Zone Editor' under 'Domains' section. |
3. Select from the menu the domain you wish to manage. Note: This step is required only if you won more than one domain. |
4. Fill in 'Name' and 'CNAME' record and press 'Add CNAME Record' . Note: To define record's TTL, use you have to use 'Simple DNS Zone Editor'. |
DirectAdmin
1. Log into your DirectAdmin panel. |
COMING SOON! |
Plesk
1. Log into your Plesk panel. |
2. Press 'Domains' under 'Hosting Services' section. |
4. Find the domain to be edited, and click on the corresponding Control Panel link. Afterwards, proceed to 'Websites & Domains' tab and press 'DNS Settings' . |
4. Find the domain to be edited, and click on the corresponding Control Panel link. Afterwards, proceed to 'Websites & Domains' tab and press 'DNS Settings' . |
5. Add a new record or edit an existing one. |
6. Now, change the record type to 'CNAME' and fill in both 'Domain name' and 'Canonical name' . Finish by pressing 'Ok' . |
Multibranded Clients
You can set up a client as 'Multibranded' , this status allows the client to log into all brands. To benefit from this, you need to set up a client custom field. |
1. Proceed to 'Setup' → 'Custom Client Fields' . |
2. Fill 'MultiBranded' into 'Field Name' , choose 'Tick Box' field type and mark 'Admin Only' . Afterwards, press 'Save Changes' . |
Setting A Client As Multibranded
Now, to allow a client to log into all brands follow this single step. Proceed to client's profile → 'Profile' , mark 'MultiBranded' and press 'Save Changes' . |
Now, proceed to management of a brand to which the client is assigned → 'Clients' . Afterwards, remove the client from the brand as shown on the following screen. |
Tips
1. The logo image is usually hard coded into the WHMCS template files. In order to use logo file provided at the 'Multibrand For WHMCS' module, find proper line at the template file and replace it with '{$logo}' variable. |
Common Problems
1. When you have problems with connection, check whether your SELinux or firewall does not block ports. |
2. Using 'Login as Client' functionality returns:
The page isn't redirecting properly Solution: This issue will be solved in the next version of module. |
3. If your CNAME record is not working, remember that first domain name in CNAME record should be branded domain. The second one is the domain on which you have your WHMCS. The redirection goes from the first domain to the second. |
4. If your branded domain or WHMCS domain are using SSL connection, both of them need to have the same certificate. If both of them are using the same domain, you will need a wildcard certificate. |