Skip to content

Module Installation Guide

This guide explains different methods to install modules in the system.

Step 1: Access Module Manager

Navigate to your dashboard or admin panel and go to Module Manager > Modules.

Module Manager Interface

Step 2: Add New Module

Click on the Add New Module button.

Add New Module Button

A popup will appear with two installation options:

  • Upload local file
  • Add by URL

Upload Module Popup

Step 3: Choose Installation Method

Option A: Upload Zip File

  1. Select your module zip file from your computer
  2. Upload it through the interface

Upload Local File

  1. Click the Install button to complete the installation

Install Local Module

Option B: Install via URL

If your module is hosted on a third-party server, you can install it using the URL option.

Install Third-Party Module

Step 4: Enable the Module

After installation, you'll see the module listed. Click the "Enable" button to activate it.

Enable Module

Note: If the "Enable" button doesn't appear, it means the module is a core component essential for the system to function properly.

Method 2: Manual Installation

Step 1: Download the Module

Purchase and download the module zip file.

Download ModuleDownloaded File

Step 2: Upload and Extract the Module

  1. Navigate to the Modules directory in your installation: /path/to/root/Modules/

Modules Directory

  1. Click the Upload button and upload your module zip file

Upload Module

  1. After successful upload, close the window and return to the module directory

Upload Module CompleteModule Directory Reload

  1. Extract the zip file

Extract ModuleExtract PathExtract Close

  1. Important: Delete the uploaded zip file for security

Delete Module Zip

Step 3: Verify Folder Structure

Ensure there is no extra parent folder after extraction. Your module folder structure should look like:

ModuleName (parent folder)
   - app
   - config
   - database
   - resources
   - routes
   - ...

Correct Folder Structure

Step 4: Enable via Module Manager

  1. Go to your admin panel and select Module Manager >> Modules

Module Manager

  1. Find your module in the list and click the "Enable" button

Enable Module

Step 5: Migration

 php artisan module:migrate {name}

Updating Composer After Installation

After installing a module, you must update Composer for the system to recognize it. If you see an error like Class "Modules\Subscription\Providers\SubscriptionServiceProvider" not found, follow these steps:

Service Provider Not Found

Option 1: Manual Composer Update

Go to your project root directory and run:

bash
composer update

Composer Update

Option 2: Composer Dump Autoload

If your hosting has disabled composer update, try:

bash
composer dump-autoload

Composer Dump Autoload

Note: If both commands are unavailable, contact your hosting provider to enable Composer functionality.

Automating Composer Updates

To handle composer updates automatically, you can use the queue system:

Option 1: Manual Queue Processing

Run the following command via SSH:

bash
php artisan queue:work

This will process any pending jobs, including composer updates. However, this command stops when your SSH session expires.

Set up a cron job to run the queue automatically.

Refer to the Cron Jobs documentation for instructions on setting up cron jobs in cPanel and hPanel.

Important: Ensure you have sufficient permissions to run Composer commands on your server.