Brekeke PBX Version 3 Quick Start Guide
This Quick Start Tutorial provides a guide to set up VoIP PBX communications using Brekeke PBX version 3.
SIP User Agent (UA) <-> Brekeke PBX Server <-> SIP User Agent (UA)
Note:
- In this tutorial, Brekeke PBX and bundled SIP Server are installed on Windows OS with Brekeke PBX installer.
- You can use any SIP-compliant products you like, but in this tutorial we will use X-Lite softphone for example purposes only.
What's Required?
- A simple and inexpensive LAN switch or hub for setting up a small LAN environment
- A Windows PC
- X-Lite Softphone(www.counterpath.com) installed on two separate PCs.
(Note that X-Lite requires a microphone and speaker for voice communication.)
Step 1 - Setting up a Windows PC with a static IP address
Configure Brekeke PBX server PC with a static IP address, e.g., IP address 192.168.0.102 and subnet mask of 255.255.255.0:Step 2 - Download and Install Brekeke PBX
- Download Brekeke PBX installer from our download page. (A free trial is available.) Run the executable file.
- Go to "Start" / "All Programs" / "Brekeke PBX" to run Brekeke PBX Admintool and activate Brekeke PBX with product license ID.
Need a Product ID? - Login with "sa" for both [User] and [Password].
Step 3 - Setting Up User Authentication Accounts
The authentication for REGISTER and INVITE is enabled by default on Brekeke PBX bundled SIP Server, which is set from fields under Brekeke PBX Admintool > [SIP Server Admin] > [Configuration] -> [SIP] -> [Authentication].
To register SIP UA to Brekeke PBX bundled SIP Server with authentication ON, create a [User Authentication] account for each SIP UA.
- 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 [Add] button
- To make sure the user authentication information is added for this user, click [User Authentication] to check.
- In this example, we will create authentication accounts from both X-Lite SIP UA. The authentication user IDs below need to be the same as the phone numbers (SIP user IDs), which is required by default authentication setting in Brekeke PBX bundled SIP Server.
- X-Lite A User Authentication account:
- [User]: xlite_a
- [Password]: 1234
- [Confirm Password]: 1234
- [Name]: X-Lite A
- X-Lite B User Authentication account:
- [User]: xlite_b
- [Password]: 5678
- [Confirm Password]: 5678
- [Name]: X-Lite B
- X-Lite A User Authentication account:
If you do not need to authenticate users when they are registering or making calls with Brekeke PBX, do the following:
- Set Brekeke PBX Admintool > [SIP Server Admin] >[Configuration]>[SIP]->[Authentication]->[REGISTER]: off
- Set Brekeke PBX Admintool > [SIP Server Admin] >[Configuration]>[SIP]->[Authentication]->[INVITE]: off
- Save the settings and restart from Brekeke PBX Admintool > [PBX Admin] > [Start/Shutdown] page
Step 4 - Setting up X-Lite SIP UAs
- Set up X-Lite as a SIP UA:
- Start X-Lite by choosing "Start" / "All Programs" / "X-Lite"
- From X-Lite menu, click "Softphone" / "Account Settings",
from pop-up window "Account" tab, set:- User ID: user set in step 3-2a/2b
- Domain: 192.168.0.102 (the Brekeke PBX server IP address set in step 1)
- Password: the password set in step 3-2a/2b
- Display Name: any
- Authorization name: user set in step 3-2a/2b
- Check field "Register with domain and receive calls"
- Select field "domain" under "Send outbound via:" section
- In order for X-Lite to work as a voice communication device, you must have a microphone and speaker(s) connected to your PC.
- Verify that X-Lite on two PCs have successfully registered.
From Brekeke PBX Admintool > [SIP Server Admin] > [Registered Clients] page, both X-Lite registration records will show as
[user:] xlite_a; [Contact URL:] sip:xlite_a@<pc1_ip>
[user:] xlite_b; [Contact URL:] sip:xlite_b@<pc2_ip>
Step 5 - Create PBX User Extensions
- From Brekeke PBX Admintool > [PBX Admin] > [Extensions] -> [Users] to display all current user extensions.
- In this example, we will create two PBX user extensions, 100 and 101, for both X-Lite A and B.
For X-Lite A with SIP user ID "xlite_a", its PBX user extension will be 100.
For X-Lite B with SIP user ID "xlite_b", its PBX user extension will be 101.
Click on [Create a new user] button to create a new PBX user extension.
At new user [My Account] page, set:
[User]:user extension number, ex. 100 or 101
[Name]: the name of this user
[Descriptions]: Description to remind you who is this user, ex. X-Lite A or X-Lite B
[Login Password]: password for PBX admintool user login
Click on [save] button - Assign phones to a PBX user extension
From user [My Phones] page, set registered phones' SIP ID to this user extension [Phone ID] fields.
Each PBX user extension can be assigned with up to 4 phones.
In this example, we only set one registered X-Lite to each PBX user extension.
In PBX user extension 100 > [My Phones] page, set [Phone 1] -> [Phone ID]: xlite_a (X-Lite A SIP user ID)
In PBX user extension 101 > [My Phones] page, set [Phone 1] -> [Phone ID]: xlite_b (X-Lite B SIP user ID)
Save the settings.
The password for checking extension voicemail is set from extension > [Settings] page -> [voicemail settings] section.
Step 6 - Making Calls
Dialing PBX user extension number associated with phones' SIP ID to make calls among registered phones.To make a call from X-Lite A to X-Lite B:
- Enter 101 and click the [Dial] button
X-Lite A PBX user extension number, 100, will show on X-Lite B as caller number. - To hang up, click the [hang up] button
To make a call from X-Lite B to X-Lite A:
- Enter 100 and click the [Dial] button
- To hang up, click the [hang up] button


