Add-on Guide

Add-ons are optional functional components that can be enabled, disabled, and configured within the system. They allow your platform to expand its capabilities without interfering with core features.

This guide focuses on add-on types, management, and configuration, without detailing their actual usage.

1. What is an Add-on?

An Add-on is a packaged feature that can be activated when needed. It can interact with:

Add-ons must be enabled and properly configured to function, but remain optional components until activated.

2. Types of Add-ons

Add-ons can be categorized by their scope and purpose:

1. Email Add-ons

   • Extend system.
   • Example: send email

   ---

2. sms Add-ons

   • Extend system.
   • Example: send email.

3. Managing Add-ons

1. Enabling an Add-on

   1. Navigate to Add-ons in the admin panel.
   2. Locate the add-on you wish to enable.
   3. Toggle the Enable/Disable switch.
   4. Save changes.
      
      

   Enabling an add-on activates its configuration options and makes it available for the platform.

   ---

2. Configuring an Add-on

   • Some add-ons require configuration before activation:
     • Linking to modules
     • Assigning to routes or hooks/actions
     • Adjusting schedule parameters
   • Always review configuration settings after enabling.

   ---

3. Disabling an Add-on

   1. Navigate to the Add-ons list.
   2. Toggle the add-on to Disable.
   3. Save changes.
      
      

   Disabling an add-on removes its active functionality but does not delete the add-on from the system.

4. Best Practices

• Review dependencies before enabling or disabling add-ons.
• Test add-ons in a staging environment before applying changes live.
• Maintain documentation of enabled add-ons and their configurations.
• Ensure add-ons do not conflict with existing modules, routes, or hooks/actions.
• Keep add-ons updated for compatibility and security.

Add-ons allow flexible expansion of the platform while keeping core functionality intact.