Module Admin User Guide

Overview

The PBX GUI software is built on a modular platform. The Module Admin module allows you to enable, disable, update, and install modules. You can also purchase commercial module licenses and renewals here. This module does not update Asterisk.

Logging in

• On the top menu click Admin

• In the drop-down menu click Module Admin

Open

Subscribing to Update Notifications

It is strongly recommended that you set up update notifications in order to receive important security and module updates. The e-mail address you provide is not shared with our remote servers and is only used for update notifications. To set up update notifications:

• Click on the Tango Frog picture at the upper right corner of the screen.

Open

• In the pop-up, enter your Email address and Machine ID.

• Click the Save button.

Selecting Repositories

This is where you choose which repositories you would like to pull from when you click the Check Online button.

Note: Dark blue color = active. In the example above, "Extended" and "Unsupported" are not selected.

The Check Online button will pull down the current list of modules and tell you whether updates are available.

Basic

This repository holds the base modules.

Extended

Modules in this repository are less common and may receive lower levels of support.

Unsupported

This repository has modules that are not supported by our team but may receive some level of support by the authors.

Commercial

This repository is reserved for modules that are available for purchase and commercially supported.

Module Administration

Checking for Available Upgrades

Click the Check Online button to check for available updates.

Once the results are in, you can check the Show only upgradeable box. This will hide all modules that don't have upgrades available.

Bulk Action: Downloading or Upgrading All Updated Modules

Toward the right side of the screen, you will see a set of buttons: Download all, Upgrade all, Reset, and Process.

Download all

• Click this button if you would like to download (but not install) the latest versions of all upgradable modules. The button will become highlighted when selected. 

• The button does not actually initiate the download; it only indicates your selection. Click the Process button to begin the download process.

Upgrade all

• Click the Upgrade all button if you would like to download and install the latest version for all upgradeable modules. The button will become highlighted when selected.

• The button does not actually initiate the download and installation; it only indicates your selection. Click the Process button to begin the download and installation.

Reset

If you change your mind at any time, you can click the Reset button to deselect your options. All of the options on the page will revert to "No Action." (Any selections you have made to download, upgrade, install, uninstall, remove, etc. will be cancelled.)

Process

This button applies the selected actions. You can select multiple actions on the page before clicking this button, if desired, and all actions will be performed at once.

• Click the Process button to begin processing the selected actions.
  
  

• You'll be asked to confirm your selected actions. If you haven't selected any actions, you'll be reminded to do so. Click the Confirm button to proceed.
  In this example, we have used the Upgrade all button to download and install available upgrades.
  
  

   

• Click the Confirm button to proceed.

• A status window will pop up displaying the progress of the actions. When the process is complete, click the Return button that appears.
   

   

• Click the Apply Config button to apply the changes.

Individual Action: Enabling, Disabling, Installing, or Uninstalling Modules

You can click on any single module to expand the information for it. Several buttons will be shown at the bottom. The options will vary depending upon which track(s) are available, whether an upgrade is available, whether the module is enabled/disabled, and whether it is installed or not.

In this example, we are looking at the System Admin module. We have clicked Check Online at the top of the page. An upgrade is available. The module is installed and enabled.

Track: Stable / Beta

Modules can have separate repos or tracks. These tracks can determine what types of updates the module receives. Some modules have only one track. Tracks can only be changed after clicking the Check Online button at the top of the page.

No Action

Select this option if you do not want any action to be performed for this module.

Download and Upgrade to (version)

If you clicked the Check Online button earlier, and an upgrade is available for this module, the latest available version will be shown here.

You can click Changelog in the menu at the left to see what has been updated in the module.

Select the Download and Upgrade to (version) button if you want to download and install the upgrade. This button doesn't actually begin the download/upgrade process; you will need to click the Process button to perform the action.

Disable

Sometimes for troubleshooting you need to disable a module rather than uninstall it. If a module is enabled, you can click the Disable button to indicate that you want to disable it. Then click the Process button to perform the action.

In this example we've clicked Disable for the Blacklist module.
 

After you have disabled a module, it will show a "disabled" status in the module list.
 

Enable

If a module is installed but not enabled, you can click the Enable button to indicate that you want to enable it. Then click the Process button to perform the action.

In this example, the Blacklist module is currently disabled. We have clicked Enable.

After you have enabled a module, it will show an "Enabled" status in the module list.
 

Install

Some modules are present on your system but have not yet been installed. For these, you will see a message "Not installed (locally available)." These can be installed without the need to download. Simply click the Install button then click the Process button.

Uninstall

While you can disable a module to temporarily disable it, the more nuclear option is to uninstall it. This will remove the module and its file system data. Depending on the module, this may remove database info that belongs to it as well. To uninstall, click the Uninstall button and then click the Process button.

Remove

If a module has been uninstalled, it may still be available locally. You can make it unavailable by removing it from the system. To do this, click the Remove button and then click the Process button.

The module will disappear from the module list after it has been removed.

Rollback

Starting in version 12 you can downgrade module versions from Modue Admin. If you wish to downgrade, you first click the 'Check Online' button, wait for the page to refresh, and then expanding the module in question from the module list. Once expanded, the menu option 'Previous' will show, click that, and from there you can roll back to any of the previous 5 versions.

Purchasing Commercial Modules within Module Admin

Module Admin has a built-in shopping cart function that allows you to purchase module licenses without leaving your PBX GUI.

In the Module Admin module, you will see a "Buy" button next to any commercial modules that are available for purchase.

Adding Items to Your Cart

• Click the Buy button for each module you want to add to your shopping cart.

  • After you add your first module, you will see a total price for your cart in the upper right hand corner of the screen.

     

  • If you continue to add more modules, you will see a pop-up window showing your shopping cart contents, with the option to continue shopping or check out. You can click the Continue Shopping button if you would like to close this window.

     

Removing Items from your Cart

Need to remove one or more items from your cart?

 Click here to display the instructions

Proceed to the checkout process when you are ready to purchase the items in your shopping cart.

Checkout

• Click the cart button if you are not already viewing your shopping cart contents.

   

   

  • Note: If your shopping cart looks like this, with only the Continue Shopping and Checkout buttons at the bottom, click Checkout to proceed to the next step below.

• At this point, you need to either enter the credentials for your Sangoma Portal account or indicate that you are a new customer. A Portal account is required in order to complete your purchase. If you do not have a Portal account, you will have the opportunity to create one here.

   

• Choose one of the options below:
  
  

 Existing customer? Click here to display checkout instructions.

 New Customer? Click here to display checkout instructions.

Uploading Third-Party Modules

The Upload modules button is used to load modules from sources outside of the Repositories, such as from third-party sites or your own development. You should only upload packages from known and trusted sources. You can upload any gzip file (module.tar.gz). This will overwrite any module with the same name.

To get started, click the Upload modules button.

You can choose to either Download (From Web) or Upload (From Hard Disk) as described below.

Downloading from the Web

• In the Type drop-down menu, select Download (From Web).

• Enter the path to the remote module. This is typically the direct address of a module tarball.
  
  

• Click the Download (From Web) button.

• The PBX will attempt to download remotely and upload locally.

Uploading from the Hard Disk

• In the Type drop-down menu, select Upload (From Hard Disk).

• Click the Choose File button. This will bring up your OS file system dialog.

• Select a local file from your computer.

• Click the Upload (From Hard Disk) button.

Installing a Module

After you upload a new module, either from the web or from your hard disk, you should see the message "Module uploaded successfully. You need to enable the module using local module administration to make it available."

In order for your new module to become active (enabled), you must first "Install" it by following the instructions below:

• Click the local module administration link or the Manage local modules button to return to the Module Admin homepage.

• Find your newly uploaded module in the list.
  
  

   

• Click on the name of the module in order to expand the information for it.
   

   

• Click the Install button.
   

   

• Click the Process button.
  
  

   

   

• You'll be asked to confirm the action. Click the Confirm button to continue.
   

   

• A pop-up will display the progress of the installation. When it finishes, click the Return button.

• Click the Apply Config button when done.