PBXware 4.1.2 Getting Started

From Bicom Systems Wiki


System Requirements

What is needed to get PBXware up and running?


Server Hardware

  • Standard x86-compatible server hardware
  • 1.6 GHz or faster CPU minimum (2.6 GHz or more recommended)
  • Compatible processors include:
Intel®: Celeron®, Pentium® II, Pentium III, Pentium 4, Xeon™, Core® series, Core® 2, Core® iX, Atom
AMD™: Athlon™, Athlon MP, Athlon XP, Athlon X series, Duron™, Opteron™
Via: C3, C7

Memory

  • 1 GB minimum (2 GB or more is recommended)


Display

  • None required. (The exception is during installation only)


Disk Drives

  • Free space required for installation:
  • 15 GB minimum for CD ROM/USB Installation Method
  • For PBXware in Vserver environment, please check the disk space requirements for Bicom Systems SERVERware
  • Standard CD-ROM/DVD-ROM drive


Local Area Networking

  • Any Ethernet controller supported by the operating system
  • Network configured and fully setup with DHCP service
  • Optional: If the server will operate from a private LAN IP, the firewall must be opened to the following ports: TCP: 80, 81, 443, 10001, 5038, 5060-5069, UDP: 4569, 5060-5069, 10000-20000


Supported Browsers

The system can be administered by using one of the following web browsers:

  • Microsoft Edge
  • Firefox
  • Opera
  • Safari
  • Chrome


Support Requirements

In order to provide system support we need access to the system server by SSH, HTTP/HTTPS protocols. The following is required:

  • Access to system server as user 'root'
  • Networking setup and fully configured to port forward (or firewall opened) to ports 2020, 80, 81 and 443.


With the above in place our technicians will be able to troubleshoot issues. We regret that we are not able to support systems that do not satisfy the above requirements.

If you are unsure how to install PBXware, we offer professional installation service. Please contact sales or visit our web site for full details.

Installation Guide

PBXware can be installed by one of the following installation methods:

The CD ROM installation method is used to install PBXware onto a commodity PC/server hardware. This installation process installs a Linux operating system, PBXware, and all other necessary applications onto the system hard drive. Installation is easy, fast, and includes everything needed to successfully install and operate.


WARNING:

CDROM will install PBXware on the hard disk and erase all existing data, operating systems, and other files.

  • The USB installation method is similar to the CD ROM method. The only difference is the boot medium which holds the PBXware installation files.
  • VIRTUAL SERVER installation is a PBXware system contained within a VSERVER (also known as VPS) on Bicom Systems SERVERware installation.
  • VMware image is pre-installed with PBXware so you can test it on your own computer without special hardware dedicated to this.


Any of the above formats will start the machine/Vserver/image and all necessary software, allowing the administrator to login to this machine/Vserver from a browser. The Administrator can then license the system by entering the licence number or use it in FREE mode. The system will contact our licensing server for authorization. Upon successful licensing, the system can be used normally by logging into the system.


CD ROM

To install the system using a CD ROM, do the following:

  1. Download and burn the CD image from http://bicomsystems.com/download
  2. Boot up the system, wait for the installer to start and follow the on-screen instructions
  3. The system will be installed and rebooted. Once the system is booted, the display will show the obtained IP address.
  4. Please login to the setup wizard using your favorite web browser by navigating to http://$IPADDRESS (For Example: http://192.168.1.2). The default username is "root". The default password is "pbxware"


IMPORTANT:

  • Before continuing, please read the System Requirements.
  • The setup wizard asks for a security username/password to prevent unauthorized access. The defaults are: username: root and password: pbxware. The setup wizard will ask for the password to be changed in one of the setup wizard steps. After it is changed, It is very important to remember this password since it is the system root and setup wizard password.


USB

Installing the system from USB is no different than using the CD ROM version. The only difference is how you put the downloaded image on the USB:

  1. Download the USB image from http://bicomsystems.com/download
  2. Download PBXware image writer from the downloads page
  3. Copy the USB image to a USB drive using PBXware image writer
  4. Set your machines BIOS to boot from the USB device
  5. Boot the system from the USB device


After the image boots from the USB device, everything else is the same as a system booted from a CD ROM.


IMPORTANT:

  • Before continuing, please read the System Requirements.
  • The setup wizard asks for a security username/password to prevent unauthorized access. The defaults are: username: root and password: pbxware. The setup wizard will ask for the password to be changed in one of the setup wizard steps. After it is changed, It is very important to remember this password since it is the system root and setup wizard password.


Vserver installation

Installing PBXware in a Vserver environment is only different at the beginning of the installation process.

  1. First create a Vserver in SERVERware. (See SERVERware documentation.)
  2. After Vserver with PBXware is created, go to the Setup Wizard and configure your PBX system.


VMware image

The VMware image is used solely for testing purposes and is not supported for deployment. This means that the user should enter the FREE license when asked for one and use the system only for testing purposes.

  1. Download and extract the package to your disk
  2. Go to PBXware_3 folder that you get after extracting the image
  3. Open PBXware_3.vmx file in VMware Player/Workstation/Fusion
  4. Run the virtual machine


Important

Since PBXware is already installed inside the VMware image, you only need to go through the Setup Wizard for the initial configuration of the system and then you will be able to use it.

The image is made with bridged networking so the system should get its own IP address which you can access in any compatible web browser.


Obtaining IP Address

The PBXware IP address can be obtained by:

  • Connecting a monitor to the PBXware unit and obtaining the IP from the command prompt by entering the ifconfig command
  • Installing the PBXware Finder on a Windows machine which is also connected to the same network. PBXware Finder can be obtained at: http://downloads.bicomsystems.com/pbxware_finder/pbxware-finder-1.0.exe
  • Obtaining it from the DHCP server

Setup Wizard

The Setup Wizard is designed to collect essential data in order to get the system up and running. After the setup wizard has finished, the system should be fully licensed, fully operational, and ready for use.

In order to login to the setup wizard, please point your browser to: https://$IPADDRESS:81/ (For example:https://192.168.1.2:81/)

IMPORTANT:

The setup wizard asks for a security username/password to prevent unauthorized access. The defaults are: username: root and password: pbxware. The setup wizard will ask for the password to be changed in one of the setup wizard steps. After it is changed, It is very important to remember this password since it is the system root and setup wizard password.

EULA

EULA

The EULA (End User License Agreement) is the first step in the setup wizard. Please read the EULA and type '"I agree"' to proceed.

NOTE:

If you do not agree with the EULA, please remove the installation media and system software and return the issued license.

Administrator Details

Provide the details of the user who will administer the system. These values are used when logging into PBXware

Administrator Details
  • E-mail/Confirm E-mail
The provided email address is used as a username for logging in
([a-z] [0-9] [@_.-])
  • Password/Confirm Password
The provided password is used for logging in
([a-z] [0-9])

Server Details (CD ROM and USB version)

These are system and network fields necessary for proper system operation.

  • Root Password
PBXware prompts for this password during the system/ssh login and when accessing system services through the interface.
  • Confirm Password
Re-type the Root Password entered in the field above
  • Time Zone
Select the time zone in which PBXware is located.
Server Details
  • Hostname
The name given to the machine which will identify the system on the network (ex. "myhost")
([a-z] [0-9])
  • Interface
The interface that PBXware uses (LAN/WAN). If PBXware is in the LAN interface, select it here. If PBXware is installed on appliances in WAN mode, select WAN here.
(Select box)
  • Use DHCP
Whether PBXware is using DHCP or a static IP address. It is recommended to always set PBXware on a static IP address, in which case this option should be set to 'No'.
(Option buttons)
  • IP Address
If PBXware is in a LAN interface, provide its static IP address here.
([0-9])
  • Netmask
This field is calculated automaticaly and contains your IP address Netmask.
([0-9])
  • Gateway
If PBXware is located in a LAN interface, set the gateway IP address here.
(ex. 192.168.1.1)
([0-9])
  • DNS server
If PBXware is located in a LAN interface, set the preferred DNS server IP address here.
(ex.192.168.1.1)
([0-9])
  • DHCP Server
If there is no DHCP server on LAN, PBXware can start its own and provide UADs/Phones with this service. If you already have a DHCP server on your network, choose 'No'.
([0-9])

Server Details (Vserver version)

Server Details (Vserver version)

These are system and network fields necessary for proper system operation

  • Root Password
PBXware prompts for this password during the system/ssh login and when accessing system services throughout the interface.
(ex. do34ffjk)
([a-z] [0-9])
  • Confirm Password
Re-type the Root Password entered in the field above.
(ex. do34ffjk)
([a-z] [0-9])
  • Time Zone
Select the the time zone in which PBXware is located, ex. USA/East-coast.
(USA/East-coast)
(Select box)
  • Hostname
The name given to the machine which will identify the system on the network, ex. myhost.
(ex. myhost)
([a-z] [0-9])
  • Server name
Virtually the same as the 'Hostname' field, only this name will appear during system notifications, sent emails, etc.
(domain.com)
([a-z] [0-9])

Licensing

Licensing allows you to enter a valid non-active license and displays the MAC address with which the license will be valid. If the system has more than one network adapter, all found MACs will be shown for selection.

Licensing
  • License Type
Select a system license type. The system comes with two license types: FREE license and 'Requested License'
(Select box)
  • License Number
Enter the PBXware license number, select the MAC address if more than one is present, and click 'Next' to register PBXware.
([a-z] [0-9])
  • MAC
The MAC address associated with PBXware.
NOTE: The system must have access to a fully operational Internet connection in order to license the system. If more than one MAC address is present, select the one you wish to associate with PBXware and click 'Next'.
(Select box)

Locality

Locality

Locality allows for the 'local' system values to be entered in order to setup all the necessary values for normal system operation.

  • Country
Select the country in which PBXware is located, ex. United Kingdom.
(Select box)
  • Indications
Typical telephony sounds PBXware will use. A different signal is heard when the handset is picked up in different countries. This field will be set automatically. If your country is not on the list, select 'Other'.
(Select box)
  • Area Code
The area code of the city where PBXware is located, for example, if PBXware is in New York, you would set '212' here.
([0-9])
  • Number Of Digits
The number of digits PBXware will associate with local extensions. If this field is set to '4', all local extensions will have a range from 1000-9999.
Minimum number of digits is 2 and maximum is 16 digits.
(0-9)

WARNING: After you create the first extension, queue, or agent on your system, you will no longer be able to change this setting.

  • Police/Fire/Ambulance
The phone number for Emergency Services in the area where PBXware is located. PBXware has an option to dial these emergency services through certain trunks. If all trunk channels are busy, an active call will get dropped in order to dial these numbers.
(If in the USA, for example, set these fields to '911')
(Select box)

Music On Hold

The system comes with a default 'silence' sound file for Music On Hold. It can also be changed to a royalty free music file.

Music on Hold

TIP:

This field is available for: Virtual Server, VMWare, CD, and Appliance PBXware packages

  • Royalty Free Music On Hold
This will upload royalty free music which can be used as the default for Music On Hold. It can be changed again later.
(Option button)

Trunk

The Trunks step will detect supported trunk devices present on the system. Once detected, the wizard will automatically create a trunk based on the most common configuration values.

Trunk
  • Detected devices
If the setup wizard detects any hardware devices (cards), they will be listed here.
(Display)
  • Default Destination
If PBXware has no DIDs set, all incoming calls will go to this destination. Set '1000', for example, to make all calls coming in from trunks go to this extension.
([0-9])

Confirm

Finally, the confirmation step lets you double check all values and either finish the wizard or start all over from the beginning. If you click "Confirm and finalize", the setup wizard will finish and the browser will be redirected to the system login screen.

Trunk
  • Repeat the wizard
If you click this button, all of the provided details will be reset and you will go back to step one.
(Command button)
  • Confirm and finalize
Click this button to confirm the data provided in the setup wizard and finalize the installation. All provided details will be applied and the setup wizard will redirect you to the PBXware login screen.
(Command button)

Logging into the system

Login screen

In order to login to the system, please point your browser to: http://$IPADDRESS/ (For Example:http://192.168.1.2/)

  • E-mail
This is the administrator's e-mail address that you set in the initial setup wizard.
([a-z] [0-9] [@_.-])
  • Password/PIN
This is administrator's password that you set in the initial setup wizard.
([a-z] [0-9])

Updates

In order to update PBXware to the latest version,follow these steps:

  1. Login to the PBXware web interface
  2. Navigate to 'Site Settings: Updates' and click on the 'Updates' button
  3. Click on 'Start' and wait until the system shows the interface again

License Updates

To upgrade your PBXware license, do as follows:

  1. Login to the PBXware web interface
  2. Navigate to 'Site Settings: Updates'
  3. Enter the system root username and password
  4. Click on the 'License' button
  5. Enter the license number in the 'License Number' field (e.g. 0A9DS8F7)
  6. Click on the 'Save' button

Setup Wizard

Not all of the Setup Wizard sections will be available from PBXware GUI. To access them simply navigate to your PBXware address on port 81.

https://YourPBXware.com:81

(Replace YourPBXware with system IP address e.g.https://192.168.1.120:81')


IMPORTANT:

The setup wizard has a security username/password to prevent unauthorized access.

Defaults are: username: root , password: pbxware. The setup wizard will ask for the password to be changed in one of the setup steps. After it is changed, it is very important to remember this password since it is the system root and setup wizard password.


Server Details

Server Details

These are system and network fields necessary for proper system operation.

  • Root Password
PBXware prompts for this password during the system/ssh login and when accessing system services through the interface.
  • Confirm Password
Re-type the Root Password entered in the field above
  • Time Zone
Select the time zone in which PBXware is located.
  • Hostname
The name given to the machine which will identify the system on the network (ex. "myhost")
([a-z] [0-9])
  • Interface
The interface that PBXware uses (LAN/WAN). If PBXware is in the LAN interface, select it here. If PBXware is installed on appliances in WAN mode, select WAN here.
(Select box)
  • Use DHCP
Whether PBXware is using DHCP or a static IP address. It is recommended to always set PBXware on a static IP address, in which case this option should be set to 'No'.
(Option buttons)
  • IP Address
If PBXware is in a LAN interface, provide its static IP address here.
([0-9])
  • Netmask
This field is calculated automaticaly and contains your IP address Netmask.
([0-9])
  • Gateway
If PBXware is located in a LAN interface, set the gateway IP address here.
(ex. 192.168.1.1)
([0-9])
  • DNS server
If PBXware is located in a LAN interface, set the preferred DNS server IP address here.
(ex.192.168.1.1)
([0-9])
  • DHCP Server
If there is no DHCP server on LAN, PBXware can start its own and provide UADs/Phones with this service. If you already have a DHCP server on your network, choose 'No'.
([0-9])


Licensing

Licensing

Licensing allows you to enter a valid non-active license and displays the MAC address with which the license will be valid. If the system has more than one network adapter, all found MACs will be shown for selection.

  • License Type
Select a system license type. The system comes with two license types: FREE license and 'Requested License'
(Select box)
  • License Number
Enter the PBXware license number, select the MAC address if more than one is present and click 'Next' to register the PBXware
([a-z] [0-9])
  • MAC
The MAC address associated with the PBXware.
NOTE: The system must have access to a fully operational Internet connection in order to license the system. If more than one MAC address is present, select the one you wish to associate with PBXware and click 'Next'.
(Select box)

SMTP Configuration

SMTP Configuration
  • E-mail Account:
Address to which the email will go if a recipient is not specifically defined
(ex. john@domain.com)
([0-9][a-z] @)
  • SMTP Address:
The host to send mail to, in the form "host | IP_addr"
(ex. mail.domain.com)
([0-9][a-z])
  • SMTP port:
Port used to send emails to the host
(ex. Default port is 25)
([0-9])
  • Authentication:
Select whether authentication with the SMTP server is needed or not
(ex. On)
(Option buttons)
  • Username:
Username used for SMTP AUTH
(ex. username)
([a-z][0-9])
  • Password:
Password used for SMTP AUTH
(ex. password)
([a-z][0-9])
  • Allow From: Override:
Are users allowed to set their own From: address
Example:
  • YES - Allow the user to specify their own From: address
  • NO - Use the system generated From: address
(Option buttons)
  • Use SSL:
Specifies whether ssmtp uses TLS to talk to the SMTP server
(ex. The default is NO)
(Option buttons)
  • Use Start TLS:
Specifies whether ssmtp does a EHLO/STARTTLS before starting SSL negotiation
(ex. See RFC 2487)
(Option buttons)

Services

Services

This window controls the basic actions (start, stop, restart, reload) of PBXware services

  • System
Stop/Start/Restart the system
(ex. Clicking on the 'Restart' button would reboot the system)
(Command button)
  • PBX service
Stop/Start/Restart/Reload the Asterisk (The core PBXware runs on)
(ex. Clicking on the 'Restart' button would restart the Asterisk)
(Command button)
  • PBXware:
Stop/Start/Restart/Reload the PBXware
(ex. Clicking on the 'Restart' button would restart the PBXware)
(Command button)
  • HTTP service
Stop/Start/Restart/ the nginx web server
(ex. Clicking on the 'Restart' button would restart the nginx web server. If you cannot reach the PBXware login screen this is the service you need to start/restart)
(Command button)
  • Database service
Stop/Start/Restart/Reload the MySQL database
(ex. Clicking on the 'Restart' button would restart the MySQL database server)
(Command button)
  • TFTP service
Stop/Start/Restart/ the TFTP server
(ex. TFTP is used for storing and serving the UAD/Phone auto-configuration files)
(Command button)
  • Jabber service
Stop/Start/Restart/Reload the Jabber messaging server
(ex. Clicking on the 'Restart' button would restart the Jabber server)
(Command button)
  • Memcached
Stop/Start/Restart the memcached service
(ex. Memcached service stores information which is read by PBXware Proxy)
(Command button)
  • PBXware Proxy
Stop/Start/Restart the PBXware Proxy
(ex. PBXware Proxy is connecting to asterisk manager and reading events which are then put into memcached for later usage. Based on that data, monitoring section will show information that user wants)
(Command button)

G729

G729
  • Codec optimized for:
Select the server architecture.
(ex. Select the type of server processor)
(Select box)
  • License Key:
Codec license key.
(ex. Provide the codec license key here).
([a-z] [0-9] [:/_.-])
  • Install:
Install button
(ex. After all necessary details are provided with the correct data (valid urls) click this button to install the g729 codec).
(Command button)

Updates

Updates

This section allows a shortcut to the licensing screen. It is useful if a license upgrade needs to be performed.

  • Username:
Username used for update.
(ex. This is always pbxware, do not change this).
([a-z][0-9])
  • Password:
Password used by user for update.
(ex. This is always update, do not change this).
([a-z][0-9])
  • Version:
If you are using an older version of PBXware, this is the option where you upgrade it to newer one

Remote Logs

Remote Logs

In order to set up a Remote Log during the Setup Wizard process, one needs to fill in the following fields:

  • Use remote database:
This option prompts for a usage of a remote database which can be chosen by selecting the 'Yes' button or 'No' in order not to use a remote database
  • Remote Host:
Enter the Remote Host or IP address that needs to be used
  • Username:
Enter the username to access Remote Host
  • Password:
Enter the password to access Remote Host

SSL Certification

You can now easily create and download your PBXwares private key and CSR files from PBXware Setup Wizard, in order to send them to certificate authorities. In addition, once you receive your certificate files you can use this tool to install it on your PBXware.

Install SSL Certificate to PBXware

SSL Installation
  • Navigate to SSL Certification step in Setup wizard
  • Choose installation method:
    • select “System provided” in order to create or download CSR file to be used for obtaining an SSL certificate (see GENERATE PRIVATE KEY AND CSR)
    • select “Upload my own private key” to use a private key generated elsewhere
  • Import private key (if not created through setup wizard) and certificate files.
  • Import intermediate certificate file (optional) if provided by the CA. If uploaded, it will be appended to the certificate file and used as one certificate.
  • All files must be <= 50kB, an alert should appear if oversized. Private key and certificates must match.
  • Begin certificate installation.

Generate Private Key and CSR

Generate private key and CSR
  • Navigate to “Generate private key and CSR” page by choosing the “System provided” method on the first page and following the “Create private key and CSR” link.
  • Provide information about party for which the certificate will be issued
    • all fields are required
    • “Generate CSR” button should remain disabled until all fields are populated
    • country will be pre-populated based on user’s timezone, if set in /etc/localtime
  • Submit your information by clicking the “Generate CSR” button - keep in mind that if a CSR file already exists, it will be overwritten, as well as the stored private key.
  • Check if private key and CSR files are created in /opt/httpd/etc/ssl_temp/ (ssl_cert.csr, ssl_cert.key).
  • Copy CSR output or download a CSR file.
  • Use created CSR to generate and sign SSL certificate.
  • Go back to first page to install your certificate.

NOTES:

  • Please test above functionality in IE 10, 11, Edge.
  • If the certificate is about to expire in a month or less, or has already expired, a warning message will appear at the bottom of the “Currently installed certificate information”


Services affected (with Corresponding files)

  • NGINX
    • /opt/pbxware/pw/etc/ssl/nginx - nginx.key, nginx.crt, nginx.csr
    • After first successful install, backup files nginx.key.bak, nginx.crt.bak and nginx.csr.bak will be created at the same path.
    • Check if service restarted successfully.
  • PWPROXY
    • /opt/pbxware/pw/etc/pwproxy - pwproxy.key (private key and certificate concatenated in one file)
    • After first successful install, backup file pwproxy.key.bak will be created at the same path.
    • Check if service restarted successfully.
  • JABBER C2S
    • /opt/pbxware/pw/etc/jabber - server.pem (private key and certificate concatenated in one file)
    • After first successful install, backup file server.pem.bak will be created at the same path.
    • Check if service restarted successfully.
  • ASTERISK
    • /opt/pbxware/pw/etc/asterisk - asterisk.pem (private key and certificate concatenated in one file)
    • After first successful install, backup file asterisk.pem.bak will be created at the same path.
    • There is no need for service restart.
  • HTTPD (SETUP WIZARD ITSELF)
    • /opt/httpd/etc/ - server.key (private key and certificate concatenated in one file)
    • After first successful install, backup file server.key.bak will be created at the same path.
    • Check if service restarted successfully (restart will be performed in the background, so that client isn’t aware of the process).

NOTE: If an error occurs in any of the installation steps, all changed files will be restored from their backups (if any) and the corresponding services will restart again.



Next -> 2.System Overview