WHMCS MultiSite Module

Transcription

1 WHMCS MultiSite Module - Installation and User guide WHMCS MultiSite Version 1.8

2 Table of contents 1. Introduction WHMCS MultiSite Installation WHMCS MultiSite Updating WHMCS Multisite Activate WHMCS MultiSite addon Set configuration for access control Set license Key Configuration Adding a new brand Setup Custom nameservers per client Managing the Groups Link a brand to a group Managing site s Coupling URL to brand Setup the default templates Setup default client-template in WHMCS Setup default order-template in WHMCS Default name server Changes to make for setting up Enable/Disable links in home template Changes in custom template lay-out per brand: homepage.tpl Changes in custom template lay-out per brand: footer.tpl Changes in custom template lay-out per brand: header.tpl Customizable options for messages Styling your per brand Variables for outgoing mail Product development Changes and fix history Version and release history Support Disclaimer Tools 4 ISP Page 2

3 1. Introduction WHMCS MultiSite First of all we thank you for purchasing this module. With our WHMCS MultiSite module you can manage at least two (or more) brandings (and associated by the specific branding styles) under one WHMCS license. So all brands have their own layout and their own ordering system's, you can manage them in a single WHMCS admin area. All texts and logos of each brand are set separately in the WHMCS MultiSite configuration. Before your start following this user guide, check if your MultiSite version number matches with your module version (version user guide: see bottom frontpage, version MultiSite module: see file name module or readme file). 2. Installation WHMCS MultiSite The installation of WHMCS MultiSite consists of two parts, uploading the files and configuring the module. If you follow the steps of this description, you can set up the module by yourself. First install first the folders "custom" and "modules", then configurate the settings in WHMCS admin -> addons -> Multisite. Then upload the remaining folders / files. This way, everything will work as it has not yet been fully established. 2.1 Updating WHMCS Multisite When updating the WHMCS Multisite module (or WHMS), always read carefully the release notes at the bottom of this page (section 9). When updating WHMCS Multisite, only the updated files will be overwritten (your current settings will not be overwritten). When you updating WHMCS, always first update WHMCS, then update WHMCS Multisite. 2.2 Uploading WHMCS MultiSite files. Extract the WHMCS MultiSite.zip file and upload the whole folder (including all files) in the root of your WHMCS installation. Overwrite existing files if asked. 2.3 Activate WHMCS MultiSite addon. Login the admin area of WHMCS and activate the WHMCS MultiSite addon you ve just uploaded. Click on the tab Setup -> Addon Modules and activate the addon MultiSite. 2.4 Set configuration for access control. On the same page as above Addon Modules you have to configure the access role for the module. Choose the admin role groups you want to have permissions to access this module. Tools 4 ISP Page 3

4 2.5 Set license Key Also on the page Addon Modules you have to fill in the license key, you received a license key by your order, if not please contact us how to get a valid license key. Note: Without the license key you can t use the WHMCS MultiSite module. The same applies when the expiration of the license, invalid data or if IP addresses are not correct set. your installed license key (Setup -> addon modules -> WHMCS Multisite -> configuration) must match with the license key you'll find in your In our panel you can also see the period of validation of your license key. 3. Configuration In the configuration you have to configure the settings for your brands, groups and sites. In the tab Addons you ll see MultiSite. Once you click on MultiSite you can configure all your MultiSite settings by brand. Use the tab s to manage respectively Brands, groups and Sites. For each item you want to edit, use the icon: For each item to delete use the icon: 3.1 Adding a new brand First you have to add and configure your brands under the tab Brands. Here you click the button Add new brand, now you see a form similar as below. Fill in the form with your settings and save it by confirm Add brand. The remarks for the form shown below. * For this option to work it also has to be enabled within WHMCS. ** For this option to work the default WHMCS template should be multisite. *** For this option to work the default cart should be multisite. **** When hidden it will not be displayed. Tools 4 ISP Page 4

5 !!! To get this option work, you need to adjust a piece of code in the source of the template files home.tpl, header.tpl and footer.tpl from the particular brand. (see section 7.0) Brand name Default client group Comany name Comany logo file name Company site (with http(s)://) Company logo url (with http(s)://) Twitter user name * Display affiliate support *!!! Display order system *!!! Display add funds *!!! Display mass payments *!!! Display option to update creditcard * Display support/ticket system *!!! Display server status *!!! Display network issues *!!! Display knowledgebase *!!! Display downloads *!!! Display announcements *!!! WHMCS url (with http(s)://) General sender name General sender address Invoice sender name Invoice sender address Ticket sender name Ticket sender address Custom name servers Custom name server 1 Custom name server 2 Custom name server 3 Custom name server 4 Custom name server 5 Disabled The brand name you want to configure Select de default client group (see section 4) The company name for public The file name of your logo (alt and logo hover display) The main URL of the website you want to configure The URL of the company logo you want to configure Set twitter username (see *) Display affiliate link/icon in "portal home" page Display link/icon in "portal home" page Display add funds link/icon in "portal home" page Display mass payments link/icon in "portal home" page Display option update creditcard data by customer Display support/ticket system in "portal home" page Display server status link/icon in "portal home" page Display network issues link/icon in "portal home" page Display knowlegdebase link/icon in "portal home" page Display downloads link/icon in "portal home" page Display announcements link/icon in "portal home" page The URL of your WHMCS for this brand General "sender name" regarding this brand General adress regarding this brand "sender name" for invoices regarding this brand adress for invoices regarding this brand "sender name" for tickets regarding this brand adress for tickets regarding this brand Enable custom nameservers for customer if enabled, set your custom primary name server here if enabled, set your custom secund. name server here optional optional optional Tools 4 ISP Page 5

6 Custom name server per client Custom name server 1 per client Custom name server 2 per client Custom name server 3 per client Custom name server 4 per client Custom name server 5 per client Custom name servers Custom ns1 Custom ns2 Custom ns3 Custom ns4 Custom ns5 * see below where to setup 3.2 * see below where to setup 3.2 * see below where to setup 3.2 * see below where to setup 3.2 * see below where to setup 3.2 * see below where to setup 3.2 Mail signature Will be displayed in the mail templates Invoice address/payto information Will be displayed on the invoices PayPal account Domain registrations * Domain transfers * Allow own domains * Domain bulk actions * Default language for brand Client template ** Order template *** classic Set the adress of your PayPal account Enable domain registration for customer Enable domain transfer for customer Enable domain ownership for customer Enable bulk actions for customer Select an default language for the brand you want to configure Select a "template" for the brand you want to configure Select an "order template" for the brand you want to configure Domain registration Product groups **** Virtual hosting Colocate hosting Colocate hosting brand 2 Select product groups to couple to the brand you want to configure General Download category **** Software Select a download category this brand may use Ticket departments **** Sales adress: sales@yourdomain.nl (set in WHMCS main setup) Tools 4 ISP Page 6

7 3.2 Setup Custom nameservers per client To setup the custom nameservers dropdown, go to "Setup" -> "Custom Client Fields" and scroll down un till you'll see form fields like below. Configure here the fields for the dropdown by defining a "Field name", setting the Field Type as "Tick box" and select "Admin Only". Also define the "Display Order" in your order. See also this example: After configured your brand click the button Edit Brand to add the new brand and save the changes. Note: Upload your company logo s at the same location you set by Company logo url. Product groups and Download category s you ll have to configure in the standard WHMCS setup. Tools 4 ISP Page 7

8 4. Managing the Groups Manage and couple the groups by brand 4.1 Create groups in WHMCS Before linking the groups to the brands, you ll have to setup the client groups in WHMCS. After you ve setup the client groups in the WHMCS setup, you can link a brand to a specific group in the MultiSite module. 4.2 Link a brand to a group Click on the tab Groups and hit the button link new group. Use the dropdown to couple a client group to a brand. Each group can and should be linked to at least one brand, one brand might entail groups. Forced URL/Redirect after login to specific page is optional. 5. Managing site s Each client-template will be visible under its own brand and its own URL. So you ll have to setup your configuration so that each domain point to the same server and same directory on the server. 5.1 Coupling URL to brand. By clicking the tab Sites, you can couple your URL to the specific brand. Be sure you ve configured your URL to the same location. Tools 4 ISP Page 8

9 6. Setup the default templates 6.1 Setup default client-template in WHMCS To setup the default client-template in WHMCS go to the tab Setup en choose General Settings. Here have to set the dropdown behind Template on Multisite. 6.2 Setup default order-template in WHMCS In the same setup screen as above, you ll see the tab Ordering. Set the Tools 4 ISP Multisite as the Default Order Form Template. Save your changes with the button Save Changes. Tools 4 ISP Page 9

10 6.3 Default name server Sequence of assign (a name server position for orders in the client, it is first) : 1. When in use per customer Asked name server 2. When in use by brand name server set 3. WHMCS default name server 7. Changes to make for setting up Enable/Disable links in home template 7.1 Changes in custom template lay-out per brand: homepage.tpl If you want to control the (enable/disable) homepage links/options by our module, you need to make some changes in the specific brand layout. Edit the file homepage.tpl for the used brand layout and enclose each sections as example: {if $condlinks.support} <td> <div align="center"><a href="submitticket.php"><img src="templates/{$template}/images/submitticket.png" border="0" alt="" /></a></div></td><td><strong><a href="submitticket.php">{$lang.supportticketssubmitticket}</a></strong><br /> {$LANG.submitticketdescription} </td> {/if} Tools 4 ISP Page 10

11 You can use the following values, each value contains the name of the specific link: {if $condlinks.orders} {if $condlinks.addfunds} {if $condlinks.masspay} {if $condlinks.updatecc} {if $condlinks.support} {if $condlinks.status} {if $condlinks.issues} {if $condlinks.kb} {if $condlinks.downloads} {if $condlinks.announcements} {if $condlinks.domainreg} {if $condlinks.domaintrans} {if $condlinks.domainown} {if $condlinks.affiliates} You can also use this in templates/orderforms/<your order form>/products.tpl to be able to disable options on the cart per brand. 7.2 Changes in custom template lay-out per brand: footer.tpl If you want to control the (enable/disable) the side-menu/quicknavigation items on the homepage by our module, you need to make some changes in the specific brand layout. Edit the file footer.tpl for the used brand layout and enclose each sections as example: {if $condlinks.announcements} <li><a href="announcements.php" title="{$lang.announcementstitle}"><img src="templates/{$template}/images/icons/announcement.gif" alt="{$lang.announcementstitle}" width="16" height="16" border="0" class="absmiddle" /></a> <a href="announcements.php" title="{$lang.announcementstitle}">{$lang.announcementstitle}</a></li> {/if} {if $condlinks.kb} <li><a href="knowledgebase.php" title="{$lang.knowledgebasetitle}"><img src="templates/{$template}/images/icons/knowledgebase.gif" alt="{$lang.knowledgebasetitle}" width="16" height="16" border="0" class="absmiddle" /></a> <a href="knowledgebase.php" title="{$lang.knowledgebasetitle}">{$lang.knowledgebasetitle}</a></li> {/if} {if $condlinks.support} <li><a href="submitticket.php" title="{$lang.supportticketssubmitticket}"><img src="templates/{$template}/images/icons/submit-ticket.gif" alt="{$lang.supportticketssubmitticket}" width="16" height="16" border="0" class="absmiddle" /></a> <a href="submitticket.php" title="{$lang.supportticketspagetitle}">{$lang.supportticketssubmitticket}</a></li> {/if} You can use the following values, each value contains the name of the specific link: {if $condlinks.orders} {if $condlinks.addfunds} {if $condlinks.masspay} {if $condlinks.updatecc} {if $condlinks.support} {if $condlinks.status} {if $condlinks.issues} {if $condlinks.kb} Tools 4 ISP Page 11

12 {if $condlinks.downloads} {if $condlinks.announcements} {if $condlinks.domainreg} {if $condlinks.domaintrans} {if $condlinks.domainown} {if $condlinks.affiliates} 7.3 Changes in custom template lay-out per brand: header.tpl If you want to control the (enable/disable) the header-menu items on the homepage by our module, you need to make some changes in the specific brand layout. Edit the file header.tpl for the used brand layout and enclose each sections as example: {if $condlinks.domainreg $condlinks.domaintrans} <li><a href="clientarea.php?action=domains" title="{$lang.clientareanavdomains}">{$lang.clientareanavdomains}</a></li> {/if} {if $condlinks.support} <li><a href="supporttickets.php"title="{$lang.clientareanavsupporttickets}">{$lang.clientareanavsupporttickets}</a></li> {/if} {if $condlinks.affiliates} <li><a href="affiliates.php" title="{$lang.affiliatestitle}">{$lang.affiliatestitle}</a></li> {/if} You can use the following values, each value contains the name of the specific link: {if $condlinks.orders} {if $condlinks.addfunds} {if $condlinks.masspay} {if $condlinks.updatecc} {if $condlinks.support} {if $condlinks.status} {if $condlinks.issues} {if $condlinks.kb} {if $condlinks.downloads} {if $condlinks.announcements} {if $condlinks.domainreg} {if $condlinks.domaintrans} {if $condlinks.domainown} {if $condlinks.affiliates} 8. Customizable options for messages 8.1 Styling your per brand Make sure that the default fields in WHMCS admin -> setup -> general settings -> mail are empty. Then put in the templates the following variable at the beginning (before the rest of the html) Tools 4 ISP Page 12

13 mail {$header}... The rest of the html Now it can be specified by brand In MultiSite. This can be done by putting the following example in the mail header field: <style> body,td { font-family: verdana; font-size: 11px; font-weight: normal; } a { color: #0000ff; } </style> <p><a href=" target="_blank"><img src=" alt="tools 4 ISP" border="0" /></a></p> 8.2 Variables for outgoing mail You can use all variables below in outgoing mail. These are updated/set by Multisite, others available within WHMCS will also work (but they are set by WHMCS and not updated by Multisite). {$pw_reset_url} (password reset mail only) {$invoice_link} (invoice mail only) {$ticket_link} (ticket mail only) {$brand} {$brandlink} {$signature} {$whmcs_link} {$whmcs_url} {$company_domain} {$company_name} {$company_logo_url} {$brandsig} 9. Product development Our goal is to deliver the best possible product. So help us to improve this product. Did you find a bug, or you've a feature request or other comment regarding this product, please feel free to contact us and let us know. info@tools4isp.com Tools 4 ISP Page 13

14 9.1 Changes and fix history Feature/Bugfix description Status Ver. Add documentation for possible variables to use in templates Added 1.8 Optional redirect after login to correct URL for brand Added 1.8 styling per multisite Added 1.8 Show certain knowledge base articles groups for a brand Added 1.8 Database automatically created/updated if needed Added 1.8 Don't overwrite group id if already set by adding a user Added 1.8 Set default nameservers adjustable by client Added 1.8 Add credits to client not possible Fixed 1.8 One time payments are not being listed as being recurring anymore Fixed 1.8 Affiliate links not updated/replaced with new URL Fixed 1.8 Correct total prices of configurable options Fixed 1.8 Correct contact details in printable invoice Fixed 1.8 Invoice and company logo visibility fixed Fixed 1.8 s won't open in client area Fixed 1.8 Special characters fixed in Payto block Fixed 1.8 Single and double quotes possible in names and addresses Fixed 1.8 Default language is also running for admin area Fixed 1.8 Removed the limits of productgroups and downloadgroups Fixed 1.8 Remove duplicate in s Fixed 1.8 Added option to set standard nameserver per multisite Added 1.7 Fixed discount for product codes Fixed 1.7 Fixed free domainname calculating 0 Fixed 1.7 Fixed incorrect prices for domainnames with promotion codes Fixed 1.7 Make quotes brand aware (use brand information based on client information) Added 1.6 Fixed issue with quote not being displayed as pdf Fixed 1.6 Fixed empty products in cart (when viewing a cart) Fixed 1.6 Printable version re-orderd Fixed 1.6 Fixed that only 1 product category was available for orders Fixed 1.6 Added option to set a language per brand (only for clients that aren't logged in Added 1.5 Added option to set a language per brand (only for clients that aren't logged in Added 1.5 When you use custom messages from within WHMCS they weren't send, this is now fixed and using custom mail templates is now supported Fixed 1.5 Logs where filling, changed a few things and should be fixed now Fixed 1.5 Fixed when people did go to cart.php within WHMCS products from the first product category where available even when they shouldn't be available for that brand Fixed 1.5 Fixed a bug so people can use a directory on a domain (eg for WHMCS Fixed 1.5 Tools 4 ISP Page 14

15 Fixed bug when people are logged out when they are trying to pay Fixed Version and release history Version: Release date: Added Fixed WHMCS version* jun jan nov nov oct 2014 N/A N/A N/A N/A N/A 5.2 * Supported WHMCS version, other versions might work but are not guaranteed. 10. Support This module can also be installed by the Tools 4 ISP professionals for additional charges, contact us for more information. If you ve suggestions to improve this module please let us know. Tools 4 ISP Page 15

16 Disclaimer: WHMCS MultiSite addon provided by Tools 4 ISP is for commercial purposes only. This software is supplied "AS IS" without any warranties and support except where indicated. Tools 4 ISP assumes no responsibility or liability for the use of the software, Tools 4 ISP reserves the right to make changes in the software without notification. Tools 4 ISP also make no representation or warranty that such application will be suitable for the specified use without further testing or modification. Resale of this product is strictly prohibited. Upon discovering resale practices Tools 4 ISP will take legal action. Tools 4 ISP Page 16