You are on page 1of 12

Digium Addons Module for FreePBX

User Guide

Rev. A
Digium, Inc.
445 Jan Davis Drive NW
Huntsville, AL 35806
United States
Main Number: 1.256.428.6000
Tech Support: 1.256.428.6161
U.S. Toll Free: 1.877.344.4861
Sales: 1.256.428.6262
www.asterisk.org
www.digium.com
www.asterisknow.org

© Digium®, Inc. 2010


All rights reserved.

No part of this publication may be copied, distributed, transmitted, transcribed, stored in a


retrieval system, or translated into any human or computer language without the prior written
permission of Digium, Inc.

Digium, Inc. has made every effort to ensure that the instructions contained in this document
are adequate and error free. The manufacturer will, if necessary, explain issues that may not
be covered by this documentation. The manufacturer’s liability for any errors in the
documents is limited to the correction of errors and the aforementioned advisory services.

This document has been prepared for use by professional and properly trained personnel,
and the customer assumes full responsibility when using it.

Adobe and Acrobat are registered trademarks, and Acrobat Reader is a trademark of Adobe
Systems Incorporated.

Asterisk, Digium, Switchvox, and AsteriskNOW are registered trademarks and Asterisk
Business Edition, AsteriskGUI, and Asterisk Appliance are trademarks of Digium, Inc.

Any other trademarks mentioned in the document are the property of their respective owners.

Digium, Inc. Page 2


The Digium Addons module for FreePBX allows you to easily download, install, and register
select Digium Addon packages from the FreePBX GUI. After a Digium Addon is installed and
registered by this module, you may need to configure the installed Digium Addon for use with
Asterisk. Please refer to the Configuration section of this user guide to obtain instructions on
how to configure a specific Digium Addon. This module comes preinstalled in AsteriskNOW
version 1.7.1 or later when using the FreePBX GUI. The information in this user guide briefly
discusses the main components of this module.

The Digium Addons module is located on the left navigation pane of the FreePBX GUI.

Figure: Digium Addons Module Link

Digium, Inc. Page 3


Section 1: Purchase
If you have not already purchased a license for the Digium Addon that you wish to install, you
can click any of the Purchase links to be taken directly to the Digium web store to place an
order.

Figure: Purchase Links

Digium, Inc. Page 4


Section 2: Install
In order to begin the installation process, simply click the Install link associated with the
particular Digium Addon that you would like installed. This process may take a few moments
to complete. The page will automatically refresh once it has finished.

Figure: Installation Links

Digium, Inc. Page 5


Section 3: Register
You must register your Digium Addon before it can be utilized. There are some important
points to be aware of before attempting to register your Digium Addon.

• Internet access is required from your Asterisk server in order to register a Digium
Addon key for licensed use. Outgoing network traffic on TCP port 443 (SSL) must be
allowed in order to successfully communicate with Digium's license server and
complete the registration process. You must have at least one Ethernet device in your
Asterisk server in order for the registration process to successfully complete.

• Multiple keys for the same Digium Addon may be registered on the same Asterisk
server. This will allow you to increase the total number of available Digium Addon
channels on your Asterisk server. New Digium Addon keys may be registered to your
Asterisk server using the same instructions provided below. There will be an additional
license file generated for each Digium Addon key that is successfully registered to your
Asterisk server. It is extremely important that you follow the instructions provided in
Section 5 whenever a new Digium Addon key is successfully registered to your
Asterisk server.

• All Digium Addon keys must be re-registered if any of the Ethernet devices in your
Asterisk server are changed, added, or removed. The unique Digium Addon license
files are tied to the MAC address of all the Ethernet devices installed in your system. A
particular Digium Addon 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 Digium Addon key incremented. Digium reserves the right to deny authorization
for having a Digium Addon key incremented.

Digium, Inc. Page 6


Click the Add License link to begin the registration process for your Digium Addon.

Figure: Add License Links

You will be prompted to provide your key and some personal information in order to register
your Digium Addon. After you have filled in all of the required fields, click the Submit button
to proceed.

Figure: Registration Form

Digium, Inc. Page 7


Next, you will be prompted to accept or deny the Digium End-User Purchase and License
Agreement. If you accept the license, click the Accept button.

Figure: Digium End-User Purchase and License Agreement

Congratulations! Your Digium Addon is now installed and registered.

Important Notes:

• After a Digium Addon is installed and registered by this module, you may need to
configure the installed Digium Addon for use with Asterisk. Please refer to the
Configuration section of this user guide to obtain instructions on how to configure a
specific Digium Addon.

• It is extremely important that you follow the instructions provided in Section 5 to


backup all of your Digium Addon keys.

Digium, Inc. Page 8


Section 4: Configuration
After a Digium Addon is installed and registered by the Digium Addons module, you may
need to configure the installed Digium Addon for use with Asterisk. For instructions on how to
configure a specific Digium Addon, please refer to the product manuals and README guides
which are available from the Documentation links.

Figure: Documentation Links

Digium, Inc. Page 9


Section 5: Backup
It is extremely important that you backup the license file for each Digium Addon that is
registered to your Asterisk server. First, click the Backup link to backup the license(s) for a
particular Digium Addon.

Figure: Backup Link

Then click the link to the file ending in tar.gz to download the license backup archive to your
computer. Store this file in a safe place.

Figure: Backup Download Page

You should repeat this process for each Digium Addon that is installed. In addition, this
process should be repeated whenever a new Digium Addon key is successfully registered to
your Asterisk server.

Digium, Inc. Page 10


5.1 Restore

In the unlikely event that you need to restore one or more Digium Addon license keys, you will
need to place the license backup archive on the Asterisk server and run the following
command as root from the same directory where you placed the license backup archive,
substituting [license-backup-file] for the license backup file ending in tar.gz which you wish to
restore.

# tar zxvfP [license-backup-file]

Then reload the Digium Addons Module page in the FreePBX GUI for the changes to take
effect. Your license file(s) should now be restored.

Digium, Inc. Page 11


Section 6: Uninstall
In order to uninstall a Digium Addon, simply click the Uninstall link associated with the
particular Digium Addon that you would like uninstalled. This process may take a few
moments to complete. The page will automatically refresh once it has finished.

Figure: Uninstall Link

Digium, Inc. Page 12