Lagom WHMCS Client Theme Documentation
Docs v2.x
/ /website-builder/ /leased-bundle/ /extensions/ /module-integration/ /order-form/

# Installation

Welcome to the comprehensive installation guide for Lagom WHMCS Leased Bundle (opens new window). In this article, you will find step-by-step instructions to seamlessly integrate this powerful product bundle into your existing setup.

# Product Requirements

Below is a list of requirements for latest product version, make sure that your server meets all below requirements, BEFORE you start installation process:

  1. Requires IonCube Loader 14 or later.
  2. Supports PHP 8.2 and 8.3.
  3. Recommended Apache server. Optional possible compatibility with other types of servers - learn more.
  4. Required PHP modules:
  5. Requires Modrewrite (opens new window) to be enabled on your server.
  6. Requires max_input_vars to be set to at least 5000.
  7. Requires max_execution_time to be set to at least 300 seconds.
  8. Requires InnoDB database storage engine.
  9. Requires WHMCS Friendly URLs to be set to either Full Friendly Rewrite or Basic URLs (configured in General Settings -> General -> Friendly URLs). Avoid using Friendly index.php, as it may cause issues with Lagom WHMCS Website Builder functionality (e.g., pages like cart.php not loading correctly).

# Before You Begin

  1. IMPORTANT - Enable WHMCS Maintenance mode (opens new window) and perform a full backup of your WHMCS server and database.
  2. IMPORTANT — Before you continue, verify that the version of Lagom WHMCS Client Theme included in your Leased Bundle is compatible with your WHMCS installation. The Lagom WHMCS Client Theme is a core part of the bundle and must meet the same compatibility requirements as when installed separately. Check the compatibility list here (opens new window).
  3. While we make every effort to test all our new releases, we strongly recommend giving our product a try on your WHMCS installation before activating it. You can preview the installed theme by clicking the "Live Preview" button as presented below.

# Download Files

  1. Log in to our RS Studio Client Portal.
  2. Navigate to My Services.
  3. Choose a product that you wish to install and click the "Manage" button.
  4. Download the latest version by pressing the "Download" button on the main product page. If you want to choose one of the previous releases, click "Show all files".

# Upload Files

Lagom files can NOT be uploaded using ROOT owner, as files and folders uploaded using root can not be overwritten by RS Themes addon. This will cause issues during activation of the Lagom Color Schemes.

  1. Extract the .zip file downloaded from the Client Portal.
  2. Using an FTP client, upload the contents of the /php81+/ folder to the directory where your WHMCS system is installed. You can find the WHMCS installation directory in the WHMCS admin area under "Help" > "License Information" > "Valid Directory".
  3. Ensure that all files are uploaded correctly without any errors during the transfer process.
  4. After successfully uploading the Lagom package to your WHMCS server, verify that the files and folders in /templates/lagom2/core/styles/ have the necessary write permissions.

# Activate Addon

  1. Log in to the WHMCS admin area on your server.
  2. In the top right corner, click on "System Settings" and then choose "Addon Modules".
  1. Activate the "RS Themes” addon.
  1. Press the "Configure” button and select admin role groups (these groups may differ depending on the WHMCS installation) to grant access according to your needs, then save changes.

# Visit RS Themes Addon

  1. To activate the Client Area Theme, navigate to Addons -> RS Themes.
  1. Theme Selector will appear. Locate the previously uploaded theme and click the Manage button next to it to open its settings and configuration options.
  1. The installer window will appear. Before proceeding with the installation, please review the License Agreement and End-User License Agreement. Once reviewed, mark the required checkboxes and press the Continue button. Afterward, follow the on-screen instructions to complete the installation.
  1. Next, you will be prompted to enter your Lagom WHMCS Client Theme license key. Paste your license key into the field provided, then click "Verify License Key” to continue.

  1. The installation will go through the following processes:

    • Starting Installation
    • Checking Module Requirements
    • Installing Theme Core
    • Installing Addon Core
    • Building Color Styles
    • Creating Default Pages
    • Building Product Pricing Cache
    • Activating Bundle Requirements
    • Client Notifications Is Being Installed
    • Email Template Is Being Installed
    • Polishing
    • Finalizing Installation

  2. During the installation process, various errors or warnings may appear. Below is a sample message, and a full list of them can be found in "Common Problems" section.

  1. After the installation is complete, you will be notified of the outcome.
  1. Click the "Activate Theme" button to activate the Lagom WHMCS Client Theme for the "client area" and the "ordering process". If you would like to preview the theme before activating it, please check this step.

# Clear Cache

  1. Clear your browser and server cache (for example Cloudflare).
  2. Clear the WHMCS template cache in: Utilities → System → System Cleanup → Empty Template Cache.

# Common Problems

To find out more about common problems and errors, navigate to the Common Problems article.

# Product Configuration

After you complete the installation, you can start configuring all products included in the Lagom WHMCS Leased Bundle.

For a step by step overview of the first configuration for each product, see the following article.

First Steps with Lagom WHMCS Leased Bundle

# *WHMCS in Subfolder

If you have installed WHMCS in a subdirectory of your website, such as www.yourdomain.com/whmcs/, you'll need to make some adjustments to your WHMCS .htaccess file.

Follow these steps:

  1. Locate the .htaccess file in the root directory of your website.
  2. Open the .htaccess file using a text editor.
  3. Add the following RewriteBase/[directory] rule at the end of the file, replacing [directory] with the name of your WHMCS subdirectory. In our example, it will be:
RewriteBase/whmcs

This rule tells Apache to set the base directory for URL rewriting to your WHMCS subdirectory.

  1. Save the changes to the .htaccess file, and your Lagom Website Builder installation should now work correctly when accessed from a subdirectory.

# *LiteSpeed Servers

Due to our limited technical knowledge and possible diverse environment configurations, our team offer limited "Technical Support" for this type of servers.

If you are using LiteSpeed server, you have to be aware that this type of servers require server restart after every change in Lagom WHMCS Website Builder functions, which implement changes to the htaccess file, for example:

  1. Activation of CMS product.
  2. Creation or deletion of CMS page.
  3. Changes in Display Rule settings.
  4. etc.

This is one of the limitations of OpenLiteSpeed web server over the Enterprise website. OLS does not read or integrates the .htaccesschanges done on the website. To make it read the webserver requires restart using root user. This can be done by following simple steps.

  1. Log in to the root user of the OLS installed server.
  2. Run the following command to restart OpenLiteSpeed server.
systemctl restart lsws
  1. Check if OLS is running properly without any issues.
systemctl status lsws
  1. After restarting OLS the changes done in .htaccess files in any website will start reflecting. However, this has to be done after every change in the .htaccess file. If you don’t want to restart the webserver manually then you should consider upgrading to LiteSpeed Enterprise.

# *NGINX Server

Due to our limited technical knowledge and possible diverse environment configurations, our team offer limited "Technical Support" for this type of servers.

If you are using NGINX server, you have to be aware that this type of servers require server restart after every change in Lagom WHMCS Website Builder functions, which implement changes to the htaccess file. Here is a step-by-step configuration guide.

# Configure the NGINX Virtual Host file

  1. Include the NGINX htaccess configuration file in your NGINX Virtual Host configuration. The location of this file vary and often is /etc/nginx/sites-available/default.
  2. Add this line to include the htaccess file: include {path-to-whmcs-directory}.htaccess-nginx;. For instance, include /var/www/.htaccess-nginx;.

# Use the New NGINX htaccess Generating Tool

Every time you save page in Lagom WHMCS Website Builder (RS Themes -> Pages), you have to use the "NGINX .htaccess Generator Tool" tool found under Addons -> RS Themes -> Tools. If everything is configured correctly, the tool will confirm that the NGINX htaccess file is valid.

Remember to restart your NGINX server to apply the changes after using the tool.

← Update →