Skip to content

Install a Module

Add a new module to UnifiedBX — either from Sangoma's online repository, by uploading a tarball, or pulling from a remote URL.

Before You Start

  • Confirm the module is needed (don't install random modules — each adds attack surface and complexity).
  • Recent backup exists.

Install from Sangoma's online repository

  1. Go to System Admin → Modules.
  2. Click Check Online.
  3. Click the Available filter (top of the list) to see modules you don't have.
  4. Click the module name to open it.
  5. Set Action = Download and Install.
  6. Click Process at the bottom.
  7. Confirm.
  8. Click Apply Config.

Install from an uploaded tarball

When Sangoma provides a tarball directly, or for offline installs:

  1. Modules → Upload Modules tab.
  2. Click Choose File, pick the .tgz / .tar.gz.
  3. Click Upload.
  4. The module appears in the Local list with Action = Install.
  5. Click Process → confirm → Apply Config.

Install from a URL

  1. Modules → Upload Modules tab.
  2. Paste the URL into the Download from URL field.
  3. Click Download.
  4. Same as above from there.

Commercial / Licensed modules

  1. Modules → System Admin → Activation — confirm the system is registered with Sangoma and the license includes the desired module.
  2. Refresh the module list.
  3. Install as above.
  4. Some commercial modules require a license activation step inside the module after install.

Verify

  • The module appears with status Enabled in Modules.
  • Its menu item appears in the appropriate UnifiedBX menu category.
  • A test of the feature works.

Common Issues

  • "License invalid." Expired or wrong tier. Visit Sangoma portal, renew or upgrade.
  • Dependency missing. Module requires another module not installed. Process all together with Process.
  • Module installs but menu item missing. Check /etc/asterisk/freepbx_menu.conf — UnifiedBX's custom menu config may be filtering it out (remove=1). Edit the config or use the Sysadmin menu config GUI.
  • PHP fatal after install. Module incompatible with PHP version. Sangoma's matrix shows compatibility per FreePBX version.