You will be able to customize your brand through modifying factors like client area template, logo or brand language, and preview the changes with just a single click.
The module enables you to easily assign your clients to and migrate them between brands, as well as assign products and ticket departments to each brand.
Owing to Multibrand For WHMCS your customers will be able to log into specified client areas in accordance with the brand under which they purchased a product or service.

We will guide you step by step through the whole installation and configuration process.

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

The content of PHP version files should look like this.

File is located in 'modules/addons/MultibrandFunctionality/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

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'.

Log in to your WHMCS admin area. Go to 'Setup' → 'Addon Modules'. Afterwards, find 'Multibrand' and press 'Activate' button.

To do so click on 'Configure' button, tick 'Access Control' near required admin role groups and press 'Save Changes'.

Folder is located in 'your_whmcs/modules/addons/MultibrandFunctionality/storage/'.

'invoicepdf_RENAME.tpl' is located in 'your_whmcs/templates/default/' .
Simply, remove default 'invoicepdf.tpl' file from template folder and copy 'invoicepdf_RENAME.tpl' into the folder.
Afterwards, rename the file to 'invoicepdf.tpl' .

You can access your module in 'Addons' → 'Multibrand'.

It is required to set up 'logos' folder as writable in order to upload logos of your brands.
Additionally, here you can find links to articles that will guide through the set up of CNAME records process in the most popular platforms.

• 'Address' - value from this field will be used as a company address and will be displayed for example on created invoices.
  
• 'Brand Email' - will be used to send branded emails to clients.
  
• 'Terms of Service URL' - defines URL to Terms of Service for the brand.

Additionally, upload the logo which will be used in branded invoices, emails and client area.
'Save Changes'.
Note: Only published brands can be set as default.
New users created by admin or through API will be assigned to the default brand.

To learn more about setting up CNAME records, proceed to Domains & CNAME Records Configuration section.
Do not forget to publish the brand as soon as the CNAME record propagates worldwide.

You can modify your brand at any time, simply alter wanted parameters and press 'Save Changes'.

Note: Products/product bundles can be assigned to multiple brands at the same time.

'Important': Only one brand for each department is allowed.

To enable payment gateway, mark checkbox next to it, fill out required details and press 'Save Changes'.
Note 1: Remember, to use branded payment gateway you need to activate it first under 'Setup' → 'Payments' → 'Payment Gateways'.
Note 2: Owing to 'Payment Gateway' tab, you can use different details per brand.
Note 3: 2Checkout payment gateway currently supports only single payments.

Still, you may use any other payment gateway that is active in your WHMCS system. Multibrand For WHMCS can work with any gateway
that works within your WHMCS, the only limitation is that the other payment gateways use the same settings for all brands.

Check 'Create Brand Templates' and press 'Save Changes' to create them.

Choose/type in the desired value and confirm changes.

Both of them are placed in 'Status' column as shown on the screen below.

Here you can find basic information about the brand as well as quick access links to the brand reports.

The client area should appear in a popup window as shown on the following screen.
You can easily log into/register client account via this popup window.

• branded - a client with only one brand assigned. They will be able to log into the brand they are assigned to.
• semi multi-branded - a client assigned to multiple brands. They will be able to benefit from all brands they are assigned to.
• fully multi-branded - a client with no brands assigned, such client will be able to log into any of your brands.
  

Additionally, if they own products from different brands, they will be fluidly redirected between brands when viewing them.

In 'Clients' page you can assign clients to chosen brands.
Note: It's worth mentioning that client can be assigned to multiple brands.
Note 2: We were forced to abandon quick reassigning clients due to optimization reasons.

You can view the reports of clients, invoices, orders, tickets and services bounded to the selected brand.

Here you can compare them by the amount of clients, orders, services, tickets, invoices, domains and income with various graph types.
On the following screen you can see a web graph with a popup containing the amount of services in brands.
Popups with different information are shown upon hovering over specified parts of graph.

• For all WHMCS templates:
  

1. Access the location of your template. For the Five template it is the /yourWHMCS/templates/five/ folder, while for the Six template, you need to go to the /yourWHMCS/templates/six/ location.
2. Make a copy of your invoicepdf.tpl and quotepdf.tpl files located in your template's folder.
3. Now, move to the 'yourWHMCS/templates/default' folder and rename invoicepdf_RENAME.tpl and quotepdf_RENAME.tpl to the original file names.
4. Lastly, replace these files in your template's folder.

• For the Five WHMCS template
  

1. Open the header.tpl file located in the /yourWHMCS/templates/five/ folder
2. Find and remove the following code (should be located in the line 7):

{if $systemurl}<base href="{$systemurl}" />{/if}

3. Next, find the following code:

<div id="whmcsimglogo"><a href="index.php"><img src="templates/{$template}/img/whmcslogo.png" alt="{$companyname}" /></a></div>

4. And replace it with:

<a href="{$WEB_ROOT}/index.php"><img src="{if $logo}{$logo}{else}{$WEB_ROOT}/templates/{$template}/img/logo.png{/if}" alt="{$companyname}" /></a>

• For WHMCS V6 and the Six template
  

1. Open the header.tpl file located in the /yourWHMCS/templates/six/ folder
2. Find the following code:

<a href="{$WEB_ROOT}/index.php"><img src="{$WEB_ROOT}/templates/{$template}/img/logo.png" alt="{$companyname}" /></a>

4. And replace it with:

<a href="{$WEB_ROOT}/index.php"><img src="{if $logo}{$logo}{else}{$WEB_ROOT}/templates/{$template}/img/logo.png{/if}" alt="{$companyname}" /></a>

• For WHMCS V7 and the Six template
  

1. Open the header.tpl file located in the /yourWHMCS/templates/six/ folder
2. Find the following block of code:

{if $assetLogoPath}
	<a href="{$WEB_ROOT}/index.php" class="logo"><img src="{$assetLogoPath}" alt="{$companyname}"></a>
{else}
	<a href="{$WEB_ROOT}/index.php" class="logo logo-text">{$companyname}</a>
{/if}

4. And replace it with:

<a href="{$WEB_ROOT}/index.php"><img src="{if $logo}{$logo}{else}{$WEB_ROOT}/templates/{$template}/img/logo.png{/if}" alt="{$companyname}" /></a>

Note - Resellers Center For WHMCS v3.X module is no longer compatible with Multibrand For WHMCS v1.X module.

Important: Migration disables branded payment gateways. You have to manually re-enable them.

'Brand Details' column informs you about membership of clients, invoices, tickets, orders or services to certain brand.
Let's see how it looks in a 'Client List'.

Through pressing a brand name, you will be moved directly to a report page of that brand.
Notice: Client, service etc. status has to be set to active in order to show brand it is assigned to.

Therefore, you as an administrator have to be able to define from which brand create them.
As you can see on the following screen, from the summary page you can create all of mentioned above as well as log into any of client's brands.

Important: Those can be done only from client summary page in the admin area, other possibilities of creating invoices/tickets/quotes are blocked.

If you brand a category, then any of files in this category will be automatically visible only for clients of this brand.
Remember that files in such category can still have a different brand assigned, then they will not be visible in this group in client area.

On the following screen you can see an example of an order email.

Let's consider how WHMCS has implemented email templates system:

• there are a few email types: general/product/domain/invoice
• there are a lot of default WHMCS templates in the system. These kinds of templates are "special" in a few ways.
• we have only one tool that allows us to adjust emails (link)

How does email branding mechanism look like?

1. Client enters the site which uses brand #1, and orders a product.
2. WHMCS creates an order and performs email sending Hosting Account Welcome Email
3. Using hook, we get:
   • Unique email template name, in this case Hosting Account Welcome Email
   • Parameter 'relid' which, depending on the email type, may be the ID of various entities:
     • for 'general' email type, it is Client ID
     • for 'product' email type, it is Service ID
     • for 'domain' email type, it is Domain ID
     • for 'invoice' email type, it is Invoice ID
   • Basing on that email unique name we are going to determine 'relid' type, so if a unique name contains "Hosting Account Welcome Email" string, we know that 'relid' is a service ID.
4. Now, we need to determine the brand, so we use the brand of the service ('relid' is in this case our service ID; service brand is a brand from which it was ordered)
5. As service is created for brand #1, we can obtain this specific brand details
6. In the next step, all default variables for this email are overridden using once specified brand, such as:
   • company_name, company_domain, whmcs_url, whmcs_link, from (email and name), logo_url
   • As a result you have the same email subject/content with different stack of variables. Email sent from will be changed as well.
7. In the last step, there is one significant mechanism: (let's just say, that it is the last resort mechanism)
   • When we determine brand, for example MyBrand is a brand name
   • Hook checks if email template with unique name exists: $currentBrand → name.' '.$emailUniqueName (prefix + space + the same unique name)
   • If it exists, the hook disables sending email by WHMCS and the module will send email with found template by our own Mailer
     (as a result, you will find in logs that email was aborted, and it will not be displayed in the list of emails sent to client)

Note: there is much more logic behind that, it is just an overview.

Point is, for predefined email templates everything works fine.
But as soon as admin specifies their own, custom template, and sets it manually to the product, there might be a problem.

So, as you set welcome email to your custom MyBrand Card Brief. Basing on this, we are unable to determine a proper brand.
But when I make the same email, with a unique name Other Product/Service Welcome Email for Copy Brief, it will work.
Why? There is a string inside the email name Other Product/Service Welcome Email so we know it is related to a product.
Following, we are able to get brand attached to that product and then we can brand this template.

Whole idea of this is that we have email, but we do not know for which brand it should be branded.
It is important for current Multibrand state to keep email templates unique names in proper pattern.

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.'.
Note 1: As you can see above, each domain has to be closed with a dot.
Note 2: To learn more about certificate requirements, visit Common Problems section.

Only when you have parked your domains you can move to setting CNAME records on your panels. See the tips below.

Note: This step is required only if you own more than one domain.

Note: To define record's TTL, you have to use 'Advanced DNS Zone Editor'.

Note: Do not forget to place a dot at the end.

Afterwards, proceed to 'Websites & Domains' tab and press 'DNS Settings' .

Finish by pressing 'Ok'.
Note: The changes will take between 4 to 8 hours to update worldwide.

If your branded domains or WHMCS domain are using SSL connection, all of them need to have the same certificate.
Certificate Type Required:

• wildcard - if all brands and main WHMCS are using the same domain.
  
• SAN - if your brands and main WHMCS are using different domains.
  

This is due the way in which WHMCS works. It is not the limitation of our module.
Additionally, in order to fix connection support for secured connections, add the integration code shown below.
Edit 'configuration.php' located in the main WHMCS directory and place following code at the end of the file.
For WHMCS V6:

require_once dirname(__FILE__).'/includes/MultiBrandSSLFixer.php';
$SSLFixer = new MultiBrandSSLFixer();

if($SSLFixer->shouldBeInSSL()){
    if(! $SSLFixer->isInSSL()){
        $SSLFixer->forceRedirect(true);
    }
}else{
    if($SSLFixer->isInSSL()){
        $SSLFixer->forceRedirect(false);
    }
}

For WHMCS V7:

require_once dirname(__FILE__).'/includes/MultiBrandSSLFixer.php';
$SSLFixer = new MultiBrandSSLFixer();
if($SSLFixer->shouldBeInSSL() || $SSLFixer->issetSystemSSLURL($db_host, $db_username, $db_password, $db_name))
  {    
      if(! $SSLFixer->isInSSL())
      {
          $SSLFixer->forceRedirect(true);
      }
  }
  else
  {
      if($SSLFixer->isInSSL())
      {
          $SSLFixer->forceRedirect(false);
      }
  }

3b. (using already installed certificate) Select it from 'Browse Certificates' and save the settings.

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.
  This is the only way we could do that for the time being.
  
• Clients Profile → Send Email - if you try to send an email template, a branded counterpart of which exists, you will receive an error.
  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.
• 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

In this section we will list the WHMCS modules which do not support multibranding or do not cooperate with Multibrand For WHMCS at all.

• SMS Center For WHMCS - SMS sent to customers cannot be branded. Default set of SMS templates is sent to clients from all brands.
  
• Resellers Center For WHMCS - This module is not compatible with our Multibrand For WHMCS module.

Cloudflare is a service that will mask your server IP address.
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.
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.

• Product Bundle - bundle requires all of its products to be assigned to the same brand that the product bundle is.

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.
The line responsible for a displayed logo is placed at the 'header.tpl' file located in a currently used template.

The page isn't redirecting properly

Solution: This issue will be solved in the next version of module.

The second one is the domain on which you have your WHMCS. The redirection goes from the first domain to the second.
Dots after domains are also important.
Take note that there could be a delay with propagation of changes for DNS servers while using A type CNAME records.

If both of them are using the same domain, you will need a wildcard certificate.
If they are using different domains, secure them with the SAN certificate.
This is due to the way WHMCS works. It is not the limitation of our module.

These are: Template 'Six' and 'Five'.
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.

6. Multibrand For WHMCS module is not compatible with our Resellers Center For WHMCS.
There is no integration between these modules and we do not recommend using them together.