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

Brekeke PBX Quick start guide

This guide provides a simple setup sample for getting started using Brekeke PBX.


In this guide, we use following environment for setting up Brekeke PBX

– Windows OS
– Brekeke PBX installed with installer (exe file)


What’s Required?
  • LAN switch or hub for setting up a small LAN environment
  • Windows PC (with internet access)
  • PhonerLite ( installed on two separate machines.
    (Note that PhonerLite requires a microphone and speakers for voice communication.)


Step 1 – Setting up a Windows PC with a static IP address

Assign a static IP address (i.e, IP address and subnet mask of to the Windows PC that Brekeke PBX is installed


Step 2 – Download and Install Brekeke PBX
  1. Download Brekeke PBX from DOWNLOAD page. Run the executable file.
  2. Go to “Start” / “All Programs” / “Brekeke PBX” to run the product admintool and activate the license.
  3. Login using “sa” for both [User] and [Password].


Step 3 – Setting Up User Authentication Accounts

The authentication for REGISTER and INVITE is enabled by default on the bundled SIP server, which is set from fields under Brekeke PBX Admintool > [SIP Server Admin] > [Configuration] > [SIP] > [Authentication]. To register a SIP UA with atuthentication, create a [User Authentication] account for your SIP UA.



If you do not require to authenticate users, configure settings below and skip the rest of step 3 and move on to step 4.

– At Brekeke PBX Admintool > [SIP SERVER] > [Configuration] > [SIP] > [Authentication] >

[INVITE]: off

– Save the settings and restart from the Brekeke PBX Admintool > [MAINTENANCE] > [Start/Shutdown].


—Rest of Step 3—————————————————————————————————————-

Steps to set up authentication accounts at the boundled SIP server > [User Authentication]:

3-1. Go to Brekeke PBX Admintool > [SIP Server Admin] > [User Authentication], click [New User], and set:

[User]: Phone number (SIP user ID)
[Password]: AnyPassword
[Confirm Password]: SamePassword
[Name]: Description to remind you whose authentication account this is
[Email Address]: User contact email

Click the [Add] button.

To make sure the user authentication information has been added for this user, click [User Authentication].

3-2. In this example, we will create authentication accounts from both PhonerLite SIP UAs. The authentication user IDs below need to be the same as the phone numbers (SIP user IDs), which is required by the default authentication setting in the bundled SIP server.

3-2a.PhonerLite A User Authentication account:

[User]: test_a
[Password]: 1234
[Confirm Password]: 1234
[Name]: PhonerLite A

3-2b. PhonerLite B User Authentication account:

[User]: test_b
[Password]: 5678
[Confirm Password]: 5678
[Name]: PhonerLite B
Step 4 – Setting up PhonerLite SIP UAs

4-1. Set up PhonerLite as a SIP UA:

Run PhonerLite by double-clicking PhonerLite.exe (or start from the start menu.)

Set up from the PhonerLite [Setup Wizard]. Select “manual configuration“.

Proxy/Register: (Brekeke PBX server IP address set in step 1)
Realm/Domain: (Brekeke PBX server IP address set in step 1)
STUN: (blank)
User name: [User] set in step 3-2a/2b
Authorization name: the [User] set in step 3-2a/2b
Password: the [Password] set in step 3-2a/2b
profile name: (any)

4-2. In order for PhonerLite to work as a voice communication device, you must have a microphone and speaker(s) connected to your PC.

4-3. Verify that PhonerLite has been successfully registered on two PCs.
From the Brekeke PBX Admintool > [SIP SERVER] > [Registered Clients] page, both PhonerLite registration records will show as:

[user:] test_a; [Contact URL:] sip:test_a@pc1_IP
[user:] test_b; [Contact URL:] sip:test_b@pc2_IP


Step 5 – Create PBX User Extensions

5-1. From Brekeke PBX Admintool > [PBX Admin] > [Extensions] > [Users], choose to display all current user extensions.

5-2. In this example, we will create two PBX user extensions, 200 and 201, for both PhonerLite A and B.

The PBX user extension for PhonerLite A with SIP user ID “test_a” will be 200.
The PBX user extension for PhonerLite B with SIP user ID “test_b” will be 201.

Click the [Create a new user] button to create a new PBX user extension.
At the new user [My Account] page, set:

[User]:user extension number, e.g. 200 or 201
[Name]: the name of this user
[Descriptions]: Description to remind you who the user is, e.g. PhonerLite A or PhonerLite B
[Login Password]: password for PBX Admintool user login

Click the [save] button

5-3. Assign phones to a PBX user extension

From the user [Phones] page, enter the registered phones’ SIP IDs in the user extension [Phone ID] fields.

By default, when a user is created, the [Phone 1] > [Phone ID] field is set to the same number as the user extension number or <tenant>_<extension> in Multi-Tenant Brekeke PBX. Each PBX user extension can be assigned to up to four phones.

In this example, we will assign the A and B to each PBX user extension.

On the PBX user extension 200 > [Phones] page > [Phone 1] :

[Phone ID]: test_a (PhonerLite A SIP user ID)

On the PBX user extension 201 > [Phones] page > [Phone 1] :

[Phone ID]: test_b (PhonerLite B SIP user ID)

Save the settings.


Step 6 – Making Calls

Dialing a PBX user extension number associated with a phone’s SIP ID to make calls among registered phones.

To make a call from PhonerLite A to PhonerLite B:

  1. Enter 201 as the [Destination number] at PhonerLite A and press the Enter key.
    PhonerLite A PBX user extension number, 200, will show on PhonerLite B as the caller number.
  2. To hang up, press the [Disconnect] button.

To make a call from PhonerLite B to PhonerLite A:

  1. Enter 200 as the [Destination number] at PhonerLite B and press the Enter key.
  2. To hang up, press the [Disconnect] button.


See also:
Yes No
Suggest Edit