FreePBX Distro
- Nathaniel Halbrooks
Registering your FreePBX Distro system to the Sangoma Portal at portal.sangoma.com allows you to purchase commercial module add-ons and paid support for your system.
We refer to each PBX as a "Deployment" in the portal. A deployment is a PBX instance that allows software and support to be connected with the PBX. Each deployment has a unique "Deployment ID" number. After you have registered your system, it will have a Deployment ID. When purchasing licenses and support, it is important to enter the correct Deployment ID at checkout.
The FreePBX Distro comes pre-installed with all needed packages to allow commercial modules to work, and this is the only officially supported platform for commercial modules.
You can register your FreePBX Distro-based system directly from the System Admin module as described below.
Registering your FreePBX System to our License Server
System Admin Version 12.0.19 or Newer
The first time you log into your new FreePBX Distro system, you will have the opportunity to register your system through the Out of Box Experience (OOBE). If you decide to skip this process, you can come back to it later as described under "Existing Installation" below.
Brand-New Installation
See Using OOBE for instructions.
Existing Installation
Log into your PBX GUI.
Navigate to the System Admin module:
In the top menu go to Admin.
In the drop-down menu go to System Admin.
Click on Activation in the menu at the right.
Click on the Activate button.
From this point forward, follow the instructions for our Out of Box Experience (OOBE) activation process, found in Using OOBE (skip the login step, as you have already logged in).
System Admin Version 12.0.18 or Older
Log into your PBX GUI.
Navigate to the System Admin module:
In the top menu go to Admin.
In the drop-down menu go to System Admin.
Click License in the menu at the right.
You will be presented with a screen like below, and will need to fill out some information to link this system with your account.
For "Would you like to register this deployment now?" click Yes.
For "Do you have a Deployment ID that is not tied to another Hardware System?" you will generally answer No, unless you have a Deployment ID that you are trying to move to this FreePBX system, or you created a Deployment ID in the Sangoma Portal at portal.sangoma.com.
For "Do you have a Portal account?" answer Yes or No based on whether you have already created a account for the Sangoma Portal at portal.sangoma.com. If you have not created an account already, that is fine -- we can create one from here.
If you answer Yes to indicate you already have a portal account, then provide the Email Address used with your account and define a Location Name for the deployment. The location name is a simple "friendly" name to help you remember what this PBX is for. This is mainly handy when you have multiple deployments registered with us in the portal. Click the Register button at the bottom when done, and move to the next step below.
If you answer No to indicate you do not have a portal account, you should see a screen like this where you can define user and company information to have a portal account created for you. You will then be able to login to portal.sangoma.com to purchase Support, Commercial modules, Appliances, and other items related to the FreePBX EcoSystem. Fill in the information and give this deployment a Location Name. The location name is a simple "friendly" name to help you remember what this PBX is for. This is mainly handy when you have multiple deployments registered with us in the portal. Click the Register button at the bottom when done, and move to the next step below.
Once you have clicked the Register button, the screen should refresh after 10-15 seconds. You should see the unique "Deployment ID" displayed and a global license with an expiration date. If you do not see this screen, and you still see the same text box from earlier, then you did not successfully grab a license file. Until you get a license file from us, you will not be able to purchase commercial modules, since you need to pick a deployment that has been registered with us when using the store. Please repeat the steps. If you are still having problems, you can contact support by logging into the portal and submitting a support request.
Purchasing Commercial Modules
You can purchase commercial modules from the Sangoma Portal at portal.sangoma.com by visiting the Store section.
Be sure to choose the correct Deployment ID during checkout, as a license is purchased for a specific deployment ID.
For instructions on how to purchase commercial modules, please see the following wiki:
Installing Commercial Modules
After you purchase a new commercial module, you simply need to update your licenses on your PBX through the System Admin module. This will force your PBX to reach into our portal and update the license file for the new module(s) you bought. There is no keycode or serial number to enter.
On most systems, commercial modules are preinstalled and ready to use as soon as you have a license. However, you may need to manually install a module.
For instructions on both updating the license and installing modules, please see the following wiki:
Installing Purchased Commercial Modules