Close

Wiki

Notification:  
v3.0.2 Professional

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 the Brekeke PBX installer.
  • You can use any SIP-compliant products you like, but in this tutorial we will use the X-Lite Softphone for example purposes.

 

What's Required?

  • Simple and inexpensive LAN switch or hub for setting up a small LAN environment
  • Windows PC
  • X-Lite Softphone(www.counterpath.com) installed on two separate PCs.
    (Note that X-Lite requires a microphone and speakers 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

  1. Download Brekeke PBX installer from our download page. (A free trial is available.) Run the executable file.
  2. Go to "Start" / "All Programs" / "Brekeke PBX" to run Brekeke PBX Admintool and then activate Brekeke PBX with a product license ID.
    Need a Product ID?
  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 Brekeke PBX bundled SIP Server, which is set from fields under Brekeke PBX Admintool > [SIP Server Admin] > [Configuration] > [SIP] > [Authentication].
To register a SIP UA to Brekeke PBX bundled SIP Server with authentication ON, create a [User Authentication] account for your SIP UA.

Steps to set up authentication accounts at Brekeke PBX boundled SIP Server > [User Authentication]:
  1. Go to Brekeke PBX Admintool > [SIP Server Admin] > [User Authentication], click [New User], and set:
    1. [User]: Phone number (SIP user ID)
    2. [Password]: AnyPassword
    3. [Confirm Password]: SamePassword
    4. [Name]: Description to remind you whose authentication account this is
    5. [Email Address]: User contact email
    6. Click the [Add] button
    7. To make sure the user authentication information has been added for this user, click [User Authentication].
  2. In this example, we will create authentication accounts from both X-Lite 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 Brekeke PBX bundled SIP Server.
    1. X-Lite A User Authentication account:
      1. [User]: test_xlitea
      2. [Password]: 1234
      3. [Confirm Password]: 1234
      4. [Name]: X-Lite A
    2. X-Lite B User Authentication account:
      1. [User]: test_xliteb
      2. [Password]: 5678
      3. [Confirm Password]: 5678
      4. [Name]: X-Lite B
Note:
If you do not need to authenticate users when they are registering or making calls with Brekeke PBX, do the following:
  1. Set Brekeke PBX Admintool > [SIP Server Admin] > [Configuration] > [SIP] > [Authentication] > [REGISTER]: off.
  2. Set Brekeke PBX Admintool > [SIP Server Admin] > [Configuration] > [SIP] > [Authentication] > [INVITE]: off.
  3. Save the settings and restart from the Brekeke PBX Admintool > [PBX Admin] > [Start/Shutdown] page.
When authentication is set to "off" as above, the setup in step 3 can be skipped.

Step 4 - Setting up X-Lite SIP UAs

  1. Set up X-Lite as a SIP UA:
    1. Start X-Lite by choosing "Start" / "All Programs" / "X-Lite"
    2. From the X-Lite menu, click "Softphone" / "Account Settings".
      Then from the pop-up window "Account" tab, set:
      1. User ID: user set in step 3-2a/2b
      2. Domain: 192.168.0.102 (the Brekeke PBX server IP address set in step 1)
      3. Password: the password set in step 3-2a/2b
      4. Display Name: any
      5. Authorization Name: user set in step 3-2a/2b
      6. Check field "Register with domain and receive calls".
      7. Under the "Send outbound via:" section, select field "domain".
  2. In order for X-Lite to work as a voice communication device, you must have a microphone and speaker(s) connected to your PC.
  3. Verify that X-Lite has been successfully registered on two PCs.
    From the Brekeke PBX Admintool > [SIP Server Admin] > [Registered Clients] page, both X-Lite registration records will show as:
    [user:] test_xlitea; [Contact URL:] sip:test_xlitea@pc1_IP
    [user:] test_xliteb; [Contact URL:] sip:test_xliteb@pc2_IP

Step 5 - Create a Tenant (Multi-Tenant PBX)

  1. From Brekeke PBX Admintool > [PBX Admin] > [Tenants], display all current tenants.
  2. In this example we will create a tenant named "test."
    Click the [New Tenant ] button to input "test" as the tenant name.
  3. Once the tenant is created, go to the tenant setup menu by clicking on the tenant name.
  4. From the tenant > [Options] page, set the tenant user and session limit in the [Capacity] section.

Step 6 - Create PBX User Extensions

  1. From Brekeke PBX Admintool > [PBX Admin] > [Extensions] > [Users], choose to display all current user extensions.
    For Multi-Tenant Brekeke PBX Admintool, choose a tenant from the [Tenants] menu and go to [Users] from the tenant [Extensions] menu.
  2. In this example, we will create two PBX user extensions, 100 and 101, for both X-Lite A and B.
    The PBX user extension for X-Lite A with SIP user ID "test_xlitea" will be 100.
    The PBX user extension for X-Lite B with SIP user ID "test_xliteb" will be 101.

    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. 100 or 101
    [Name]: the name of this user
    [Descriptions]: Description to remind you who the user is, e.g. X-Lite A or X-Lite B
    [Login Password]: password for PBX Admintool user login
    Click the [save] button
  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.
    Each PBX user extension can be assigned to up to four phones.
    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.
    By the default settings on the user [Inbound] page, if all Phone ID fields are assigned, Brekeke PBX will ring all assigned phone numbers at the same time when there is a call to this user.

    In this example, we will set the registered X-Lite A and B phones to each PBX user extension.
    On the PBX user extension 100 > [Phones] page, set [Phone 2] > [Phone ID]: test_xlitea (X-Lite A SIP user ID).
    On the PBX user extension 101 > [Phones] page, set [Phone 2] > [Phone ID]: test_xliteb (X-Lite B SIP user ID).
    Save the settings.
Note:
A user's voicemail PIN is set on the Extension > [Settings] page in the [Voicemail settings] section.

Step 7 - 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 X-Lite A to X-Lite B:

  1. Enter 101 and press the [Dial] button.
    X-Lite A PBX user extension number, 100, will show on X-Lite B as the caller number.
  2. To hang up, press the [hang up] button.

To make a call from X-Lite B to X-Lite A:

  1. Enter 100 and press the [Dial] button.
  2. To hang up, press the [hang up] button.

Learn More