FreePBX, Elastix and Trixbox Installation

Last modified by Scott Gagan on 2021/09/10 22:35

What's on this page:

These instructions are for an installation on a FreePBX based system. If you have a non-FreePBX based system see the Asterisk Server (Vanilla) Installation section.

Before you start

Please check the following points:

  1. Ensure that your system meets the minimum requirements to run iSymphony. For more information, please read the detailed system requirements.
  2. Have your iSymphony license key ready. You can obtain a trial, free or commercial license now, or retrieve your existing license key.
  3. You must be able to use a command prompt and install Java to continue. If not, please contact your system administrator to assist you.
  • Asterisk 1.4 or higher
  • FreePBX v2.5 or higher
  • FreePBX Asterisk API module v2.5.0.2 or higher
  • Sun Java JRE v1.6 or higher. [http://www.java.com]
  • iSymphony FreePBX module v1.0.8 or higher

Install the JRE (Java Runtime Environment)

iSymphony requires Java 6 (JRE 1.6) or later
 iSymphony needs JRE 1.6 or newer to be installed on your computer.

Failed to execute the [error] macro. Cause: [The required content is missing.]. Click on this message for details.

  1. If you are not sure whether you have JRE installed correctly, please confirm by doing the following:
    1. Open a shell console.
    2. Type echo $JAVA_HOME in the shell console and then press Enter
    3. View the result:
      • If a line is displayed such as /opt/jre1.6.0_12 or /usr/lib/jvm/java-6-sun, then your JRE is installed and properly configured.
      • If nothing is displayed, then you either need to install the JRE or set the $JAVA_HOME environment variable. You can set this environment variable in your user account's 'profile' file. Alternatively, you can set this after installing iSymphony by defining this path in your iSymphony installation's config.sh file, usually located in the iSymphony directory.
  2. If you need to install the JRE, follow these instructions:
    • Go to the Java download page.
    • Download the version entitled 'JRE 6 Update XX', where 'XX' stands for some number. (The latest version is available on that page.)
    • When the download has finished, run the Java installer. Detailed installation instructions are provided on Oracle's website.
       At one point, you will be asked to choose an installation directory. Make a note of this directory for use later.

Server Installation

  1. Once you have downloaded the iSymphony RPM run the following command to install:

    rpm -Uvh iSymphonyServer<version>.rpm

  2. Configure the iSymphony installation. iSymphony assumes your Sun Java JRE is located in /usr/java/latest/ by default. If your Sun Java JRE is in a different location you must run the following commands and set the correct path.

    /opt/isymphony/server/config.sh

  3. Start the iSymphony server:

    /opt/isymphony/server/startup.sh

  4. Verify that ports 50000 and 50003 are not being blocked by any firewall and are forwarded as necessary. If you are running IP Tables (installed and activated by default on PBXIAF) run the following commands on the server CLI in order to open the ports.

    Unknown macro: noformat. Click on this message for details.

    Failed to execute the [error] macro. Cause: [The required content is missing.]. Click on this message for details.

  5. Login to your FreePBX administrator and click on Module Admin.
  6. Verify that you have the Asterisk API module installed under System Administration. If not select Check for updates online at the top of the page and install the Asterisk API module.
  7. Click Upload module
  8. Specify the location of the iSymphony FreePBX module on your computer and click Upload.
  9. Return to the Module Admin and Enable the iSymphony module and click Process.
  10. Click Apply Configuration Changes.
  11. Asterisk will reload and the iSymphony module will populate the extensions and profiles. This may take some time as the iSymphony configuration is being built.

The iSymphony server should now be running. You'll need to setup permissions on the server for your users in the Permissions section. 

Extra Steps for Remote Installation

If iSymphony is on a separate box from FreePBX perform these extra steps.

When iSymphony is not running on the same file system as the voicemail files are stored the visual voicemail functionality will not be available. Mapped drives will not solve this issue.

If you are adding an additional location to your iSymphony server make sure that you set the Location name to something other than "default" or the location name of an existing location before you Apply Configuration in FreePBX. If you have two modules pointing to the same server with the same location ID both module instances will attempt to write their config to the same location causing conflicts.

 

  1. Go to the iSymphony page under Admin in FreePBX.
  2. Set the iSymphony Server Host field to the IP or Hostname of server iSymphony Server is running on so that the FreePBX module knows how to connect to the iSymphony server. 
  3. Set the Asterisk Server Host field to the IP or Hostname of the FreePBX server so that the iSymphony Server knows how to connect to the Asterisk server.
  4. Go to the Asterisk API Module page in FreePBX and select isymphony.
  5. In the Permit Field append the following to the existing entry. (Note the subnet mask may be different on your network)

    &<IP of the iSymphony server>/255.255.255.0
  6. Reload FreePBX
  7. Your iSymphony server needs to connect to the Asterisk server and vise versa so we need to make sure that no firewalls are blocking these connections. See step 4 in Server Installation to get an example of how to open a port when using IPTables
    1. The iSymphony server will need to connect to port 5038 on the FreePBX server.
    2. The FreePBX server will need to connect to port 50001 on the iSymphony server.

 

   
iSymphony