Brekeke PBX Quick start guide (Multi-Tenant)
This guide provides a simple setup sample for getting started using Brekeke PBX Multi-Tenant edition.
In this guide, we use following environment for setting up Brekeke PBX
– Windows OS
– Brekeke PBX installed with installer (exe file)
- LAN switch or hub for setting up a small LAN environment
- Windows PC (with internet access)
- Java SE (https://docs.brekeke.com/sip/installing-java-se)
- PhonerLite (phonerlite.de) 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 192.168.0.102 and subnet mask of 255.255.255.0:) to the Windows PC that Brekeke PBX is installed
Step 2 – Install Java SE
Installing Java SE is required prior to installation of Brekeke products. For detail, refer to the Installing Java SE.
Step 3 – Download and Install Brekeke PBX
Step 4 – Create a Tenant
4-1. From Brekeke PBX Admintool > [PBX Admin] > [Tenants], display all current tenants.
4-2. In this example we will create a tenant named “test.”
Click the [New Tenant ] button to input “test” as the tenant name.
4-3. From the tenant > [Options] page, set the tenant user and session limit in the [Capacity] section.
Step 5 – Create PBX User Extensions
5-1. From Brekeke PBX Admintool > Select tenant > [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_200” will be 200.
The PBX user extension for PhonerLite B with SIP user ID “test_201” 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 extension is created, the [Phone 1] > [Phone ID] field is set as <tenant>_<user extension> in Multi-Tenant Brekeke PBX. Each PBX user extension can be assigned to up to four phones. (For details of Phone ID, please refer to “What is Phone ID ?”)
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_200 (PhonerLite A SIP user ID)
On the PBX user extension 201 > [Phones] page > [Phone 1] :
[Phone ID]: test_201 (PhonerLite B SIP user ID)
Save the settings.
Step 6 – 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] > [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 6 and move on to step 7.
– At Brekeke PBX Admintool > [SIP SERVER] > [Configuration] > [SIP] > [Authentication] >
[REGISTER]: off [INVITE]: off
– Save the settings and restart from the Brekeke PBX Admintool > [MAINTENANCE] > [Start/Shutdown].
—Rest of Step 6—————————————————————————————————————-
Steps to set up authentication accounts at the boundled SIP server > [User Authentication]:
6-1. Go to Brekeke PBX Admintool > [SIP SERVER] > [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].
6-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.
6-2a.PhonerLite A User Authentication account:
[User]: test_200 [Password]: 1234 [Confirm Password]: 1234 [Name]: PhonerLite A
6-2b. PhonerLite B User Authentication account:
[User]: test_201 [Password]: 5678 [Confirm Password]: 5678 [Name]: PhonerLite B
Step 7 – Setting up PhonerLite SIP UAs
7-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: 192.168.0.102 (Brekeke PBX server IP address set in step 1) Realm/Domain: 192.168.0.102 (Brekeke PBX server IP address set in step 1) STUN: (blank) User name: the [User] set in step 6-2a/2b Authorization name: the [User] set in step 6-2a/2b Password: the [Password] set in step 6-2a/2b profile name: (any)
Note: If PhoneLite is used on the same place where the Brekeke SIP Server is running, because Brekeke SIP Server uses 5060 port as its default SIP port, PhonerLite’s SIP port should be changed from 5060 to others.
7-2. In order for PhonerLite to work as a voice communication device, you must have a microphone and speaker(s) connected to your PC.
7-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_200; [Contact URL:] sip:test_200@pc1_IP [user:] test_201; [Contact URL:] sip:test_201@pc2_IP
Step 8 – 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:
- 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.
- To hang up, press the [Disconnect] button.
To make a call from PhonerLite B to PhonerLite A:
- Enter 200 as the [Destination number] at PhonerLite B and press the Enter key.
- To hang up, press the [Disconnect] button.