We are going to walk through a simple and typical setup of FreePBX.  It would be impossible to teach you through a single wiki how to configure the over 1000 features of FreePBX, but following should allow a brand-new user to create a basic system setup. Please note, we try to keep these articles as up-to-date as possible, but your system may vary slightly from the procedures and screenshots shown here, based on the versions installed.

This setup assumes you have purchased the (System Building Basic) commercial module bundle to make setting up phones and your PBX much easier. It also assumes you are using SIP trunks. In our example we will use SIPStation for our trunking. The SIPStation module built into FreePBX Administration makes setting up FreePBX a breeze, as it does most of the work for us.

Configuration of the PBX is done using the various FreePBX Modules. The modules are divided into several categories at the top of the GUI.  Once you're at a specific module's page, you can hover your mouse over the question mark icon.

near each entry to view more information on what the item does.

For detailed instructions on each module, start here:  Standard Modules.

Login to the PBX Graphical User Interface ("GUI")

• Using another machine on your same network, open a web browser and enter the IP address of your PBX.

  • If you don't know the IP address of your PBX, go to the Linux console/command prompt.  Login to the Linux console using the username "root" without quotes, and the root password you selected during installation. You will then be shown your IP address.
    
    

    Open

    

     

    
    
    
    

    Open

    

     

• You will now be asked to create a user to log into FreePBX GUI.  Press Create Account when done.
   

   

  
   

• On the main landing page select the PBX Administration tab to log into FreePBX
  
  

   

  
   

• Login with the username and password you just created.

Register your PBX

• From here, you’ll be welcomed to your FreePBX and asked if you would like to activate your system. Activation is highly recommended, as it’s required to purchase Commercial Modules, Paid Support and SIPStation Trunking. To activate now, press the “Activate” button.
  
  

   

• Enter in your email address that you use for the FreePBX Portal. Once you’ve entered your address, press the “Check” button.

  • If you do not have an account enter the email address you would like to use for logging into the FreePBX Portal and you will be directed to create an account.

• The system will detect this address is tied to an existing Portal account and prompt you to enter your password. Once you have your password filled in, press the “Next” button.
  
  

   

• You can then choose to edit or add your personal Portal information. When finished, press “Next.”
  
  

• From here, you’ll be asked if this is a new activation. Since you don’t have an existing Deployment ID, then you’ll be looking at the first option, New Activation. All you need to do is give this deployment a "friendly" name to help you differentiate between your different systems when using the Portal to buy products. Then press the “Activate” button.

  • If you have a Deployment ID that is not tied to another PBX you can pick the Existing Deployment Option and provide that Deployment ID

• You’ll notice the activation process is now installing and after about 5-10 seconds this process will be complete.
  
  

   

• You will now be able to take part in special offers. We offer bundles that combine some of our most popular features that will save you money. Click on one of the “Buy” buttons to purchase your bundle of choice or press “Complete” to advance to the System Status screen of your PBX GUI.
  
  

   

Configure Asterisk SIP Settings

• Next, configure the Asterisk SIP Settings Module by following these instructions.  The most important section, which you must configure in order to avoid one-way audio problems, is the "IP Configuration" section.
   

• Make sure you define your external IP and local subnets

Sysadmin Module Setup

Set a Static IP Address and Configure DNS 

• When FreePBX is first installed, it is configured to obtain an IP Address using DHCP.  You'll need to assign your PBX a static IP address so that your phones will have a consistent internal IP address to use to contact it.  The easiest way to give your PBX a static IP address is to configure your DHCP server to always assign your PBX the same IP address using a DHCP reservation. This ensures that if DHCP settings later change, such as changing DNS server settings, the PBX will get these new settings with all other DHCP clients.   If that's not possible, you will need to configure your PBX to use a static IP and not use DHCP.
   

• From FreePBX GUI Click Admin, and then System Admin Module - Standard Version on the left hand side of the screen, and then Network Settings, on the right hand side of the screen.  You should now see a screen that looks like this:

• Change IP Protocol to "None" and then enter your desired static IP address.  Be sure to also set your subnet mask (typically 255.255.255.0) and default gateway (usually 192.168.1.1). 
   

• When you're done, click save settings.  
   

• To continue, input the new IP address into your web browser.  Return to the System Admin Module (follow the instructions described above) and manually set your DNS Servers 
   

• Then go to the DNS section of the System Admin module and click DNS on the right hand side of the screen.  You'll see a screen that looks like this:

When you're done, click "Submit"

Configure E-Mail Settings

Configure Email Server

View the System Admin Module - Standard Version module guide here to setup and manage your email relay servers.

Configure E-Mail Alert Destination Addresses

FreePBX has a number of components that will send out e-mail alerts on various conditions.

Check the following areas to verify or set the desired e-mail destination address of the phone system administrator who will receive the alerts:

• Admin > System Admin>Notifications Settings

  • From Address: Enter the From address the PBX will use for the notifications on this page, e.g. pbx@mydomain.com

  • Storage Notifications: (enter the desired e-mail address)

  • Intrusion Detection Notifications: (enter the desired e-mail address)

  • Abnormal Call Volume Notifications: (enter the desired e-mail address)

  • Submit
     

• Settings > Advanced Settings

  • Backup Module

    • Email "From:" Address: Enter the From address the Backup module will use, e.g. pbx@mydomain.com

    • click the green check mark to the right of the field

      • Apply Config
         

• Settings > Fax Configuration

  • Fax Options > Fax Presentation Options

    • Outgoing Email address: Enter the From address the fax module will use when sending received faxes, e.g. pbx@mydomain.com

  • Fax Options > Fax Feature Code Options

    • Email address: Enter the default destination e-mail address for received faxes so they can be manually routed by a human being, e.g. mainreception@mydomain.org

  • Submit

    • Apply Config
       

• Settings > Voicemail Admin

  • Settings

    • fromstring: Enter the From address the voicemail module will use when sending out voicemail alerts, e.g. pbx@mydomain.com

    • pagerfromstring: Enter the From address the voicemail module will use when sending out voicemail alerts, e.g. pbx@mydomain.com

    • serveremail: Set the same as "fromstring"; not sure how this is different

  • Submit

    • Apply Config

There is additional configuration needed for some of the above components but the above is just the e-mail From and To configuration.

Setting the Time Zone

•  

  • Go to Admin→System Admin→Time Zone

    • Use the drop-down menus to select the appropriate time zone and then click Submit. Note the warning stating that you must reboot your system in order to complete the changes.
      
      

       

       

    • Go to Admin → System Admin → Power Options

    • Be very careful with this section! You will want to reboot, NOT power off.

    • Click the Reboot button
      
      

       

    • You'll be warned that rebooting will cause call processing to stop. Click OK if you are ready to continue.
      
      

       

       

    • Just to make sure you're really ready to reboot, a pop-up will ask you to type "reboot" in the field. Do this, then click OK.
      
      

       

    • Your system will now reboot. Click OK to close the information window, and wait at least 5 minutes before reloading the page.
      
      

       

    • Go to Admin → System Admin → Time Zone again, and you should see your newly chosen timezone displayed.

Setting a Hard Drive Failure / Fill-Up Notification E-Mail Address

•  

  • Go to Admin -> System Admin -> Storage

    • Enter an e-mail address where you would like to receive hard drive failure / fill-up notifications, and click Submit.
      
      
      

       

Configuring Intrusion Detection

• Go to Admin -> System Admin -> Intrusion Detection

• We recommend that you keep this service running, in order to detect, block, and notify you of attempts to compromise your system. You may check the status here and adjust your ban time, max retry, and find time if needed.

• Enter an e-mail address where you would like to receive intrusion detection notifications.

• Optionally, enter any IPs that you would like to whitelist.

• Click Submit. Your settings will be applied when the page reloads.

Creating Extensions

• Go to Applications -> Extensions

• For the fastest, easiest setup, click the Quick Create Extension button.
  
  

   

   

• Select the desired type of new extension, enter the extension number, and enter the display name. In our example we are creating a new Chan_SIP extension.
  
  

   

   
   

• Optional: Enter an e-mail address for the user. This e-mail will be used for services such as voicemail, User Control Panel, and fax.
  
  

   

• Click Next to go to step 2.

• Optional: If you would like to enable voicemail now, do the following:

  • Click the Yes button next to "Enabled." This will make the password field available.

  • Enter an initial password (digits only). We recommend initially setting this to the extension number, because the first time the user dials *98, they will be prompted to set up their voicemail box and change this password. Users can also change their passwords later by dialing *97 and changing voicemail settings.
    
    

     

     
     

• Click the Finish button.

• Click the X button in the upper right-hand corner of the window to close the Quick Create window.

• Reload the extensions list page to see your newly created extension in the list.

• Repeat the process for each extension you would like to add.

• To manage the extensions you created, go to Applications -> Extensions -> List Extensions. Here you can see a table showing extensions and whether various settings are enabled. You can click the pencil icon to edit, or the trash can icon to delete.

Configuring a Phone Using EndPoint Manager (EPM)

• Go to Settings → EndPoint Manager

• Click on Global Settings in the menu at the upper right corner of the page.
   

Setting the IP Address and Viewing the HTTP Provision Port

•  

  • Enter the IP address of your PBX into the Internal IP Address field. If you will have phones connecting to the PBX on an External IP or FQDN, enter that into the External IP Address field.

  • Take note of the HTTP provision port shown, as some phones such as Digium only support HTTP or FTP provisioning.

  • Click Save Global when done.
    
    
    

     

     

     

Creating a Template for the Phone

• Click Add Brand in the EndPoint menu at the upper right corner of the screen.

• Click on the brand of your phone. You will be taken to a page where you can begin creating a new template.
  
  

   

• Enter a Template Name (no spaces).
  
  

   

• Choose an Internal or External Destination Address.

  • Internal: The system will pull the IP address you defined earlier in Global Settings.

  • External: You may enter any IP or Fully Qualified Domain Name (FQDN).
    
    

     

     

• Select the Time Zone for the phone. Choose the time offset from GMT, or select GMT. (Do not adjust for daylight savings time; use the standard time number.)
  
  

   

• Choose a Line Label for line keys on supported phones. This can be name only, extension only, or name and extension.
  
  

   

• For Firmware Version, select Firmware Slot 1 from the drop-down menu. Note: you will need to install firmware by following the instructions given later in this wiki.
  
  

   

• Check your Provision Server Address. It should match the Destination Address set earlier.

• For Provision Server Protocol, click on HTTP, FTP, or TFTP, depending on the options you see available, and which protocol is correct for your phone.
  
  

   

• Click the Save Template button when finished. The page should reload and you should see a list of available phones. Next you'll configure some buttons on the phone.

Setting Up a Line Key for an Extension

• After you’ve saved your template, you should now see your available phone(s) at the bottom of the page. (To navigate to this page if you are not there already, go to Settings → EndPoint Manager → Brands: [Name of Brand] → Manage: [Name of Template].)

• Click on the blue button for the phone you’d like to work on.

• In the Line Keys section, select Type: Line. The Label and Value fields will disappear. Select Account: Account 1.

• Click the Save Model button on the left side of the page when finished.

Mapping the Phone to an Extension

• Click on Extension Mapping in menu at the right side of the page.

• Click the Add Extension button. New drop-down menus and fields will be shown.
  
  

   

• Under Extension/Name, select the extension and account you would like to associate with this phone.
  
  

   

• Select your phone’s Brand from the drop-down menu and enter its MAC Address. The MAC address is typically found on a label on the back of the phone.
  
  

   

   

• Select the phone Template and the Model of the phone.
  
  

   

• Make sure Save and Rebuild is the selected Action.
  
  

   

• Click the Use Selected button and wait for the page to reload.

  • Your newly mapped extension should show up with a green background.
    
    

     

Installing Firmware

• Click Firmware Management in the menu at the right side of the page.

• Your phone's brand should appear under Firmware. Click the phone brand.
  We are using Digium in our example.
  
  

   

• You should now see a list of Available Firmwares.
  
  

   

• Drag the latest firmware to Firmware Slot 1.
  
  

   

  
  
  

   

• Click the Submit button. The page will reload.

• Wait a few seconds, then reload the page. (Confirm form submission if prompted.) You should see a green message confirming the firmware has been installed.
  
  

   

Downloading Configuration Files to the Phone

•  

  •  

    • Press the phone’s Settings button

    • Select Fetch Configuration File from URL

    • Enter the IP address of your PBX

    • Enter the HTTP port for provisioning

    • Press Go

    • Your phone should reboot, and you should now see the extension line key that was set up earlier.

Setting Up SIPStation Trunks

With SIPStation unlimited SIP trunks, you can be making and receiving calls from your PBX in just a few minutes. The FreePBX SIPSTATION module helps you set up SIP trunks easily and automatically. When you set up SIPStation trunks, a few basic inbound and outbound routes are automatically set up for you. We will discuss inbound and outbound routes later.

If you are a new SIPStation customer, our Free Trial program will let you try SIPStation before you buy. The Free Trial includes one trunk and one DID. Setup is quick and easy in the SIPSTATION module within FreePBX.

Setting Up a SIPStation Free Trial

• SIPStation Free Trials are Available Through Your PBX GUI

• How to Use the SIPSTATION Module in Your PBX GUI to Sign Up for a Free SIPStation Trial

• Converting Free Trial account to Paid Account

• FAQ on Service not working after Conversion to Paid

SIPStation Free Trials are Available Through Your PBX GUI

With FreePBX version 12 and above, in just a few clicks we can have you up and running with your PBX connected to our world class services. You just pick a phone number and we'll do the rest! There is no cost or obligation. You'll see just how easy it is to connect your phone system to our award-winning platform. There is no risk. After your evaluation, you can convert your account to a regular account (no contract period required), or end the trial and go your own direction. You can keep your Free Trial phone number (DID) when you convert to a regular account. 

How to Use the SIPSTATION Module in Your PBX GUI to Sign Up for a Free SIPStation Trial

• Go to Connectivity -> SIPSTATION
  
  

   

   

• Click on the "SIPSTATION Free Trial" tab.
  
  

   

• You will be taken to this screen:
  
  

   

• Step 1 - Login / Register: You will need to log in with an existing account or register a new one.

  • If you already have a SIPStation or FreePBX Portal account:

    • Enter your Email Address and Password.
      
      
      

       

    • Click "Next"
      
      

       

  • If you need to create a new account enter in your email address and the new user screen as seen below:

    • 
      
      

       

       

      
      
      

    • Enter your registration information and choose a password.
      
      
      

       

       

    • Enter your address.
      
      

       

    • Fill in the remaining information
      
      

       

       

    • Click "Next" when finished.
      
      

       

       

       

• Step 2 - Service: Choose a DID (Direct Inward Dial) number.

  • Select a country and state/province.
    
    

     

  • Select a calling area (exchange).
    
    

     

  • Select a DID. You may select one number.
    
    

     

  • Click "Next."
    
    

     

• Step 3 - Finish: You will see the products included with your SIPStation Free Trial account. You must agree to the Terms and Conditions in order to continue.

  • Check the box next to the Terms and Conditions.
    
    

     

  • Click "Finish." Please wait while the system applies your new settings.
    
    

     

• After your free trial has been set up successfully, you will see new information in your SIPSTATION module. The tabs at the top are now called "Local Settings" and SIPSTATION Store, with no SIPSTATION Free Trial tab. The "Account Key" area has been replaced with instructions about how to cancel your free trial, update account information, or test your firewall. This area also displays the number of days remaining for the free trial.
  
  
  

   

• Your SIPSTATION System Status is displayed:
  
  

   

• Note that E911 options are greyed-out in trial mode. E911 is not available with SIPStation Free Trial accounts.
  
  

   

• Your SIPStation account settings are shown:
  
  

   

   

  
  
  

• Your route and trunk configuration is shown:
  
  

   

• Your DID configuration is shown.
  The default inbound destination for your new DID is "Sipstation - DID Verification." In order to receive calls, you will need to change this to a different destination, such as an extension.
  
  

   

  
  
  Please see the Configuring Your PBX wiki for a complete guide to getting your PBX system up and running. This wiki will help you create various call destinations and configure popular options.

Converting Free Trial account to Paid Account

Once you’ve completed your testing and are ready to convert to a paid account you can follow the following steps.   

Go to Connectivity -> SIPSTATION

Step 1 -  Select the “Click to Convert” to start the process.  

Step 2 – Select any additional services required and click “Next”   It will automatically select your freetrial DID and 2 High Volume trunks which was setup under your freetrial.  

Step 3 – Add your credit card information and select “Next”.    Be sure to flip the card to add your security code.     

Step 4 –  Read the Terms and Conditions statement and acknowledge that you agree by selecting the check box.   Once you’ve acknowledged our terms you can select “Finish”.   

Reloading - Once you’ve selected the “Finish” button it will bring you back to the main SIPStation Module page.  You’ll need to select the “Apply Config” button to reload Asterisk.      

Once Asterisk reloads it will attempt to Register with our two trunk peers at “trunk1.freepbx.com” and “trunk2.freepbx.com”.    

FAQ on Service not working after Conversion to Paid

Q:  My SIPStation module is showing “Registered” but I’m not able to dial out, getting “all circuits busy”? 

A:  This is mostly likely caused by Asterisk not reloading properly.   Try restarting Asterisk via CLI which will force it to reload/restart, “core restart now”.     

Q:  My SIPStation module is showing “Registration Sent” but It’s not able to Register with either trunk server and my inbound/outbound calling isn’t working and longer?

A:  The most common issue for this is your local firewall is likley blocking the SIP traffic to/from our “trunk1.freepbx.com” , “trunk2.freepbx.com” servers.   When you switch from the Free trial account to a SIPStation Paid account the server IP addresses change.    Check your firewall for proper configuration. Many versions of Asterisk also require a restart for the new trunk hostnames to take affect. You can restart Asterisk with the bash command 'fwconsole restart' or by simply rebooting the PBX.

Purchasing SIPStation Trunks and DIDs

• Logging into the SIPStation Store

• Adding Trunks

• Adding Local DIDs

  • Choose a Rate Center

  • View the Search Results

    • How to Filter by Specific Digits

    • How to Filter by SMS and/or T38 Capability

    • How to Find Consecutive DIDs

    • What if There is No Inventory?

  • Selecting DIDs

• Adding Toll-Free Numbers

  • Choose a Toll-Free Prefix

  • View the Search Results

    • How to Find "Vanity" Toll-Free Numbers

    • What if There is No Inventory?

  • Selecting Toll-Free Numbers

• Checkout Process

• Special-Ordering Local DIDs and Toll-Free Numbers

Logging into the SIPStation Store

• Before you can purchase any DIDs, toll-free numbers, or trunks, or make any special orders, you will need a SIPStation account. If you need to create an account, please see our Creating a SIPStation Account wiki for instructions.
   

• Log into your account at the SIPStation Store.

• If you are already logged in but are not seeing the store section, click Purchase in the green navigation menu to navigate to the store section.
  
  
  

   

Adding Trunks