Docs / LeadFlow AI
Signup

Install Module (Add-on)

Install optional LeadFlow AI modules such as AI builders, funnels, surveys, templates, QR tools, automation, reports, CRM, files, custom domains, integrations, and payment modules.

Estimated reading: 5 minutes

Install Module (Add-on)

LeadFlow AI supports optional modules that can extend the core SaaS product without replacing the main application. Add-ons may provide AI builders, funnels, surveys, templates, QR tools, automation, advanced analytics, lead CRM, pipeline, files, custom domains, integrations, payment tools, marketplace extensions, or industry-specific lead workflows. Install add-ons only after the main LeadFlow AI product is already installed, working, and backed up.

Main Features Overview

  • Install marketplace or vendor-provided module packages.
  • Register Laravel module providers, routes, migrations, views, assets, commands, and permissions.
  • Expose addon features through user workspace, admin workspace, pricing plans, team permissions, and marketplace package records.
  • Run addon migrations safely without deleting existing forms, responses, funnels, surveys, leads, QR codes, reports, files, or billing data.
  • Hide addon buttons, routes, and plan fields when a module is not installed or not enabled for the current plan.

Before Installing an Add-on

Confirm the add-on is compatible with your installed LeadFlow AI version. Read the addon changelog and installation notes. Back up the database, application files, .env, storage, uploaded files, and the modules directory. If the addon affects billing, AI usage, reports, files, domains, automations, public URLs, or integrations, test it first on a staging copy whenever possible.

Also confirm the license or purchase code for the add-on. Some marketplace modules are licensed separately from the main product. If the addon will be sold to SaaS users as a premium feature, review Regular versus Extended License requirements and configure plan access before announcing it to customers.

Package Source Types

  • Marketplace install: the package is downloaded and installed through the Marketplace screen after purchase verification.
  • ZIP upload: the admin uploads an addon ZIP file from the Packages or Marketplace area.
  • Manual module folder: the addon folder is uploaded to the Laravel modules directory by FTP, SSH, or hosting file manager.
  • Bundled addon: the seller includes addon folders inside the product package or an optional addons directory.

Recommended Installation Workflow

  1. Back up the current application and database.
  2. Confirm the main LeadFlow AI product is installed and running correctly.
  3. Upload or install the addon package from Marketplace, ZIP upload, or manual module folder.
  4. Confirm the module folder name, namespace, service provider, package metadata, version, and compatibility notes.
  5. Run required migrations and seeders from the addon instructions.
  6. Run composer dump-autoload -o if new PHP classes, commands, or service providers were added.
  7. Run php artisan optimize:clear to clear config, route, view, event, and application cache.
  8. Open the admin workspace and confirm the addon appears in Marketplace or Packages.
  9. Enable addon permissions in plans, team roles, user workspace menus, or admin settings as required.
  10. Test the addon with a normal workspace user.

Manual Module Folder Installation

If the addon is installed manually, upload the complete module folder into the modules directory. Do not rename the folder unless the addon documentation explicitly allows it, because provider namespaces, route names, migrations, menu registrations, and package metadata may depend on the original module name. After uploading, clear cache and confirm Laravel can discover the module.

If the addon includes migrations, run the documented migration command. For production environments, use the force flag only when you understand the migration and have a backup. If the addon includes assets, publish or build assets according to the package instructions. If the addon includes scheduled jobs or queue jobs, update cron and queue worker configuration.

Important Fields and Records

  • Module name: used to detect whether the addon is installed.
  • Provider class: registers routes, views, migrations, commands, events, and services.
  • Version: used for update checks and compatibility decisions.
  • License type and purchase code: used for marketplace verification and updates.
  • Install path: normally the module folder under modules.
  • Plan permissions: decide which SaaS customers can use the addon.
  • Menu visibility: controls whether the addon appears in user, client, or admin sidebars.

Permissions and Plan Access

Installing a module does not automatically mean every customer should use it. Enable addon access only for the correct plans and roles. For example, the LeadFlow AI builders require AI credits, a provider API key, and paid plan access. The Automation addon requires cron and queue workers. The Custom Domain addon requires DNS and HTTPS checks. The Files addon requires storage settings and upload limits.

Post-installation Checklist

  • Addon appears in Marketplace or Packages with the expected status.
  • Admin settings for the addon can be opened and saved.
  • Plan permissions show the addon feature keys.
  • User sidebar and admin sidebar show the correct items only for allowed roles.
  • Routes open without 404 or class not found errors.
  • Migrations created the expected tables without damaging core data.
  • Queues, cron, webhooks, AI providers, storage, custom domains, or external APIs work if the addon depends on them.

Best Practices

Install one addon at a time and test it before installing another. Keep a record of addon version, purchase source, license code, install date, enabled plans, and required cron or queue settings. Avoid editing vendor addon files directly unless you are maintaining a custom fork. When updating LeadFlow AI, update the core product first, then update addons that are compatible with the new core version.

Troubleshooting

Addon menu does not appear
Clear cache, confirm the module is enabled, check provider registration, verify plan permission, and test with a role that should see the menu.

Class not found or route not found
Run composer dump-autoload -o, clear route/config cache, and confirm the addon namespace matches the folder and provider class.

Database table is missing
Run the addon migrations. If migrations fail, restore from backup or inspect the migration error before retrying.

Feature appears for the wrong users
Review plan permissions, team role permissions, workspace ownership, route middleware, module installation status, and sidebar visibility rules.

Addon update fails
Check license verification, package compatibility, write permissions, logs, and whether the main product must be updated first.

FAQ

Can I install an addon before installing LeadFlow AI?
No. Install and verify the main product first, then install addons.

Should I run cache clear after addon installation?
Yes. Addons often register routes, views, config, commands, providers, menus, and permissions that require cache clearing.

Can an addon be sold as a paid SaaS feature?
Yes, if your license allows it and the addon license allows it. Configure plan permissions and billing carefully.

Can I uninstall an addon safely?
Disable related plan access first, back up the database, remove or disable the module, clear cache, and verify menus/routes are hidden. Do not drop addon tables unless you no longer need the data.