Brekeke PBX Wiki

  1. Brekeke PBX basic Info
    1. Brekeke PBX Quick start guide
    2. Brekeke PBX Quick start guide (Multi-Tenant)
    3. System requirement
    4. Hardware spec and performance (Brekeke PBX)
    5. How to check your software version
    6. Benefits & Features (Brekeke PBX)
    7. Brekeke PBX bundled SIP server
    8. Terminology
      1. Call
      2. Session
      3. Concurrent calls (Licensing)
    9. Interoperability - E1 Gateway (Brekeke PBX)
  2. Avoid Attacks
  3. Update & Upgrade
    1. Minor version update
    2. Update license
    3. Upgrade evaluation with new Product ID
    4. Upgrade Brekeke PBX v2 to v3
    5. Update Issues from v2.2.7.7 and earlier versions
    6. Update web server
  4. Configuration
    1. Installation
      1. New installation with a commercial license
      2. Install Brekeke PBX on 32 bit or 64 bit OS
      3. Install on Ubuntu
      4. Install Brekeke SIP Server and PBX on separate PCs
      5. Change SIP Server SIP Listening port
      6. Increase File Descriptor Limit on Linux
      7. Increase CentOS 6 Thread/Process Limit
      8. Increase IP_local_port_range TCP port range
      9. Increase Java memory used by Brekeke PBX
      10. Brekeke products with Mesh Network
      11. Reinstall Brekeke PBX in Linux
      12. Set port forwarding (Brekeke PBX)
      13. Update Java used by Brekeke PBX on Windows
      14. Uninstall Brekeke PBX
      15. Preparation before installation on Linux (Important)
      16. Disable SELinux
    2. Brekeke PBX default settings
      1. Max number of registered UAs
      2. Max number of concurrent calls
      3. Maximum voicemail messages
      4. Brekeke PBX Call Log
      5. Brekeke PBX parameters and syntax
      6. Brekeke PBX User Extensions and User Authentication Accounts
      7. Settings Directory List
      8. How Brekeke PBX counts calls?
      9. Ptime handled by Brekeke PBX
      10. RTP relay at Brekeke PBX
    3. Network Configuration
      1. Connecting Gateways with Brekeke PBX
      2. Setting for VPN
      3. Support NAT Traversal
      4. Using Brekeke PBX with a firewall
      5. Bind IP address for RTP relay
    4. Functions Configuration
      1. Performance optimization
      2. ARS
        1. ARS Target field
        2. Calls between two Brekeke PBX
        3. Connect to multiple ITSPs
        4. Decline non-numbered caller ID calls
        5. Default ARS Plug-ins for Notes
        6. Display caller name
        7. Distinguish outbound calls from calls between extensions
        8. Least Cost Routing (LCR) with Brekeke PBX
        9. Redirect call with 3xx response
        10. Setup for Connecting ITSP
        11. Call between two tenants
        12. Set the value of the Alert-Info header by ARS
      3. Auto Attendant
        1. Create Auto Attendant greeting message
        2. DTMF timeout
        3. Speed Dial
      4. BLF, SCA, and Presence
        1. Busy Lamp Field (BLF)
        2. Presence
        3. Shared Call Appearance (SCA)
          1. SCA Settings on the phone side
          2. SCA Settings on Brekeke PBX (3.6 ~)
            1. Old version - SCA Settings on Brekeke PBX (~v3.5)
      5. Codec
        1. Codec conversion & packetization interval
        2. Restrict Codecs used for a call
        3. Restrict outbound call codecs to G729
      6. Voicemail
        1. Are Messages deleted automatically?
        2. Automatically store voicemail to another directory
        3. Delete all voicemail messages at a time
        4. Different types of voicemail greetings
        5. Email notifications
        6. Forward voicemail message
        7. Retrieve voicemail messages
      7. Back up Brekeke PBX
      8. Call Pickup, Call Park
        1. Setting the Line Keys for Call Park
      9. Call Queue
      10. Call Waiting
      11. Confirm Call
      12. Fax Support
      13. Paging
      14. Queue settings at Call Hunting group
      15. Ring Group
      16. SRTP Support
      17. Switching Plan
        1. Switch plan in user extension
        2. Switch plan in schedule extension
        3. Change Switch Plan voice prompt
      18. Three-Way Calls
      19. Tutor Mode
      20. Video calls with Brekeke PBX
      21. Caller ID from analog (PSTN) phones
      22. Change busy forwarding destination according to response
      23. Change Music On Hold
      24. Change recorded audio files destination location
      25. Change RFC2833 Payload
      26. Replace display name
      27. Set RTP packet's TOS value
      28. TCP Support
      29. Microsoft OCS
      30. How to bypass Brekeke PBX
      31. How to create voice files (Fo IVR, Auto Attendant, Guidance) using your phone
      32. WebRTC
        1. Setting up Brekeke PBX to user WebRTC
      33. Web Phone
        1. How to Setup the bundled Web Phone
      34. Text to Speech
        1. Google Cloud Text to Speech
        2. IBM Watson Text to Speech
    5. Brekeke PBX Redundancy
      1. 1. Set up Brekeke PBX Auto Sync
      2. 2. Set up Mirroring at PBX bundled SIP Servers
      3. 3. Set up Heartbeat at Brekeke PBX
      4. 4. Test Brekeke PBX Redundancy
      5. 5. Resume to the State before Failover
    6. Remote Access of Brekeke Heartbeat
  5. Brekeke PAL option
    1. Brekeke PAL Basic Info
      1. What is Brekeke PAL?
      2. System Requirements
      3. Benefis & Features
      4. Price
    2. Configuration
      1. URL of Brekeke PAL Web Service
      2. Setting Up Development Environment
      3. Sample Program
        1. Setting up Sample Program
        2. Modify the Code
      4. Troubleshooting
        1. How to run two simultaneous PAL client programs on the same machine?
        2. Function calls has no response from PAL
        3. Function call produces an "Error: exception occurred..." message
        4. Sample Program is generating a COM ERROR
        5. Sample Program produces an error when creating the form
        6. Run PAL App on Windows 7
      5. Version History
  6. Add-ons
    1. Click-to-Call for Microsoft Outlook
  7. Troubleshooting
    1. Brekeke PBX License and Activation
    2. Starting Up
      1. Brekeke PBX stop running
      2. Cannot start Brekeke PBX, status Inactive
      3. Can't start Brekeke PBX in linux and the "UnsatisfiedLinkError" message is in a log.log
      4. Error - Failed to restart the SIP Server
      5. Error No.-200 in Brekeke PBX Admintool
      6. Got Exceptions when using GCJ
      7. Internet Explorer doesn't show the admin page
      8. Tomcat crashed when using Websocket
      9. Unable to install Brekeke PBX Service
    3. Log in
      1. Brekeke PBX user password
      2. Reset the default password of Brekeke PBX admintool
    4. Registering issue
      1. Registration fails from Brekeke PBX - ARS
        1. Authentication errors
        2. Expired
        3. 403 Forbidden
      2. Brekeke PBX upper registration
      3. Registration issue with UAs
    5. Call Transfer
      1. Transfer calls by Microsoft Windows Messenger
      2. Auto Attendant cannot forward calls
      3. Pressing "#9" does not invoke the Calll Hold state
      4. Call Hold not invoked by buttons
    6. Voicemail
      1. Cannot connect to the voicemail system
      2. Voicemail messages missing
      3. Not receive email notifications
      4. Message -"This message inbox is full", but it is not full.
      5. Change the default voicemail PIN of user extensions
    7. Trouble with Calling
      1. Call is not connected (no ringing tone)
        1. 404-Not Found, 484-Address Incomplete, 603-Decline
        2. 415-Unsupported Media Type, 488-Not Acceptable Here
        3. 482-Loop Detected, 483-Too Many Hops
        4. Other response code
      2. Disconnect suddenly
      3. Codecs and Protocols
      4. No INVITE packet from ITSP after restarting Brekeke PBX
      5. Disconnected when callee answers
      6. Brekeke PBX returns 486 for the inbound calls after updating
      7. Number of concurrent calls can not increse on Linux
      8. One-way call, and no voice at all
      9. Poor sound quality for uploaded sound files
  8. Known Bugs & Version History
    1. Known Bugs
    2. Version History

Upgrade Brekeke PBX v2 to v3

  1. Send request to upgrade your current v2 license to Brekeke PBX v3 license.
  2. Download Brekeke PBX version 3 [updates & upgrades] zip file and unzip the file
  3. Re-activate current license from Brekeke PBX v2 admintool > [maintenance] > [Activate License]
    you will get a 2-day temporary license
  4. Upgrade Brekeke PBX to version 3 from Brekeke PBX v2 admintool > [maintenance] > [Update Software] by uploading “pbx.war” file downloaded in step 2
  5. Restart Brekeke PBX server machine and start Brekeke PBX service
  6. There will be Brekeke PBX version 3 activation page shown when access Brekeke PBX admintool again.
    copy and paste license ID into [Enter the product ID] textbox
    then click on the [Accept terms and activate the license] button

Upgrade from Brekeke PBX v2 to v3 has been completed and you can access Brekeke PBX v3 admintool.


See Also: 

I have Brekeke PBX v2, can I upgrade to v3?


  1. When upgrade Brekeke PBX v2 to v3,
    the following settings can be different from those in v2 and necessary changes need to do manually.

      • Brekeke PBX v2 – Schedule users
        these users will be restored as v3 [Schedule] extensions but schedule settings cannot be saved.


      • Brekeke PBX v2 – PBX users with settings in [Forwarding destinations *] field
        these users will be restored under v3 [Groups] extensionsWhen this kind of PBX v2 users have settings in [Assigned ID] field (form MT PBX)
        these users will be restored under [Users] extensions
        and forwarding destinations will be saved at [User] > [Inbound] > [Other Forwarding Destinaitons*]


      • Brekeke PBX v2 – PBX users set as [IVR] > [Add/Remove Forwarding Destinations]
        set group extensions at [Target groups*] field, but not user extensions


      • Brekeke PBX v2 – [Options] > [Settings] > [Java VM arguments], set as -Xss128k
        when Brekeke PBX v3 is running on 64-bit OS with 64-bit java
        Remove the above setting from the field or set a value greater than 256k, such as -Xss256k


      • Brekeke PBX v2 – call park with #8
        in Brekeke PBX v3, need to input a park number + # after issuing #8 to park the call
        For details, please check Brekeke PBX User Guide


      • Brekeke PBX v2 – ARS default rule “mediaserver_prefix”
        remove or disable all Patterns-IN rules in v2 ARS rule “mediaserver_prefix”; these pattern-INs are not needed in Brekeke PBX v3


    • Brekeke PBX v2 – PBX call log settings at [Options] > [Advanced] page
      check Brekeke PBX v3 changes in call log feature behavior and database table from “Developer’s Guide – Log Database” and do necessary changes

    • Brekeke PBX v3 – [SIP Server Admin] > [Configuration] > [Miscellaneous] -> [Check Request-URI’s validity]
      If set as yes for more secured system configuration, some SIP clients may not register to Brekeke successfully.
    • If you use MT edtion and want to still use tenant ID, add the following parameter in under <Brekeke PBX installation folder>/webapp/pbx/WEB-INF/work/pbx and restart the Brekeke PBX server machine:
  2. We suggest the following changes when upgrade Brekeke PBX v2 to v3
      • Update Brekeke PBX default Dial Plan rules
        – Backup current Dial plan rules from Brekeke PBX admintool > [SIP Server Admin] > [Dial Plan] > [Import/Export]
        – Download Brekeke PBX v3 Default Dial Plan table from link below 
        – Import downloaded Brekeke PBX v3 default dial plan rule from admintool
        – Add other necessary Dial plan rules which are not as default and used in Brekeke PBX v2


      • Change PBX SIP and RTP port range from Brekeke PBX Admintool.
        The following are the default port setting in Brekeke PBX v3Brekeke PBX bundled SIP Server
        [SIP Port] 5060
        [Min RTP Port] 10000
        [Max RTP Port] 29999PBX system settings
        [PBX Port] 5052
        [Min RTP Port] 30000
        [Max RTP Port] 49999Media Server system settings 
        [Media Server Port] 5056
        [Min RTP Port] 50000
        [Max RTP Port] 59999


    • Check port forwarding and opened port settings at router, firewall or anti-virus program to make sure the UDP or TCP ports are the same as those set from Brekeke PBX Admintool


Yes No
Suggest Edit