Skip to end of metadata
Go to start of metadata

FreePBX Installation Notes

Users of FreePBX who are using version 3.5.0 or greater of DPMA and who have already Registered their FreePBX system do not need to separately execute the register utility.

DPMA Installation

No-charge license keys for DPMA are available from Digium's webstore at the following web address:

https://store.digium.com/cart.php?action=add&product_code=804-00032&quantity=1

Overview

Once you have a DPMA license key, there are two primary tasks to perform in order to install DPMA software:

  1. Download and execute the register utility to generate a valid license.
  2. Download and install the DPMA binary that is built for your platform.
    1. The DPMA binary consists of the res_digium_phone.so, the res_pjsip_endpoint_identifier_dpma.so binary, and the res_pjsip_dialog_info_digium_body_supplement.so binary.
      1. Releases for versions of Asterisk prior to Asterisk 12 contain only the res_digium_phone.so binary.
      2. Releases prior to 3.5.0 do not contain the res_pjsip_dialog_info_digium_body_supplement.so binary.

The steps to complete these tasks are described in the Installation Procedure section.

The register utility may be downloaded from:
http://downloads.digium.com/pub/register

The DPMA binary may be downloaded from:
http://downloads.digium.com/pub/telephony/res_digium_phone

Icon

For help in choosing the appropriate DPMA binary for your system, visit Sangoma's download page for a download selector tool.

Icon

If you have installed the bundled version of PJSIP, you will need to download DPMA binaries from tarballs that include the "-bundled" identifier. Failure to use a bundled DPMA binary with a bundled install of Asterisk with PJSIP will result in Asterisk crashes.

Icon

Supported software builds are provided for 32-bit and 64-bit x86 platforms, and are optimized for a variety of processor types. Choose the directory that closest matches your Asterisk version and processor type.

Installation Procedure

  1. Download and execute the register utility to generate a valid license.

    1. Download the register utility to the root home directory of your Asterisk server. First, log in as the user "root".

      Command-line Example for 32-bit Linux
      # cd /root
# wget http://downloads.digium.com/pub/register/x86-32/register

    2. Change the permissions of the /root/register file to r-x------.

      Command-line Example
      # chmod 500 /root/register

    3. Run the register utility and follow the interactive instructions. The registration utility will prompt you for your DPMA license key.

      Command-line Example
      # /root/register

      Internet Access

      Icon

      Internet access is required from your Asterisk server in order to register your DPMA key for licensed use. Outgoing network traffic to TCP port 443 (SSL) must be allowed in order for the register utility to successfully communicate with Digium's license server and complete the registration process.

  2. Download and install the DPMA binary that is built for your platform.

    Icon

    There are versions for releases of Asterisk 17, 16, 15, 14, 13, and releases of Certified Asterisk. Take note that DPMA binaries are not loadable in prior releases of Asterisk, and will only load in the specific version for which they are designed. Be sure that you download the correct version of the DPMA binary for your Asterisk version.

    DPMA 2.3 is the last version for Asterisk 1.8-cert

    DPMA 1.7 is the last version for Asterisk 10

    DPMA 3.4.3 is the last version for Asterisk 11

    DPMA 2.3 is the last version for Asterisk 12

    DPMA 3.4.8 is the last version for Asterisk 14

    DPMA 3.5.7 is the last release for Asterisk 15

    Icon

    Updated builds of the DPMA binary are frequently released. Each build has a 'version number'. This version number is part of the filename, and is also included in the copyright/license message that is displayed when the module is loaded into Asterisk. In this document, build number '3.5.5' has been used as an example. Keep in mind that the build number may be newer when you read this document.

  3. Download DPMA to the root home directory of your Asterisk server,

    Command-line Example for 32-bit Linux
    # cd /root
# wget http://downloads.digium.com/pub/telephony/res_digium_phone/\
       asterisk-13.0/x86-64/\
       res_digium_phone-13.0_3.5.5-x86_64.tar.gz

  4. Expand the res_digium_phone archive and copy the DPMA binary to the /usr/lib/asterisk/modules directory.

    Command-line Example for 32-bit Linux
    # tar xzvf res_digium_phone-13.0_3.5.5-x86_64.tar.gz
# cp /root/res_digium_phone-13.0_3.5.5-x86_64/res_*.so /usr/\
     lib/asterisk/modules

    For a RedHat or CentOS 64-bit distro (where a /usr/lib64 path exists), copy the modules to the /usr/lib64 directory instead:

  5. # tar xzvf res_digium_phone-13.0_3.5.5-x86_64.tar.gz
# cp /root/res_digium_phone-13.0_3.5.5-x86_64/res_*.so /usr/\
     lib64/asterisk/modules

  6. If you already have a configuration file present from a previous installation, skip this step. Next, copy the res_digium_phone.conf.sample sample configuration file to the /etc/asterisk directory and rename it res_digium_phone.conf.

    Command-line Example for Config Copy
    # cp /root/res_digium_phone-13.0_3.5.5-x86_64/res_digium_phone.conf.sample \
     /etc/asterisk/res_digium_phone.conf

  7. The DPMA binary must now be loaded. (See General Notes to use multiple licenses on one server.)

    Command-line Example for new installs
    # asterisk -rx "module load res_digium_phone.so"
    Command-line Example for a DPMA upgrade
    # asterisk -rx "module reload res_digium_phone.so"

  8. Verify that DPMA is licensed and operating. This can be verified by issuing "digium_phones license status" in the Asterisk CLI.

    Command-line Example
    # asterisk -rvvv
*CLI> digium_phones license status
OK, Valid product license found
  9. Copy the generated license files to a safe place as described in the Backup Procedure section.

Backup Procedure

It is extremely important that you backup all of the files located in the /var/lib/asterisk/licenses directory. This directory contains the Host-ID specific license files for your system. These license files are tied to the MAC address of all the ethernet devices installed in your system. Creating a backup of this directory will allow you to restore your DPMA license file in case you need to reinstall your operating system. This will help prevent the need to contact Digium to request authorization to increment your DPMA key and from needing to freely order a new DPMA key if you exceed the maximum number of DPMA key increments allowed.

General Notes

A DPMA key must be re-registered if any of the Ethernet devices in your Asterisk server are changed, added, or removed. The unique DPMA license file which is located in your /var/lib/asterisk/licenses directory is tied to the MAC address of all the Ethernet devices installed in your system. A DPMA key can only be re-registered once without authorization from Digium. Digium must be contacted by phone in order to request authorization to have your DPMA key incremented. Digium reserves the right to deny authorization for having a DPMA key incremented.

It is not required or suggested to specify a load line in the /etc/asterisk/modules.conf for the DPMA binary. Asterisk will automatically load it using the autoload option. The autoload option is set on by default.

  • No labels