Installation and Quick Start

From Pbxnsip Wiki

Contents 1 Downloading and Installation of the Software 2 Logging in 3 Verifying that the System is ok 4 Configuring your PBX 5 Connecting Devices to the PBX 6 Changing Your Passwords 7 Next Steps

Downloading and Installation of the Software

The software can be downloaded from http://www.pbxnsip.com/downloads.php. Please select the operating system that you are using. If you are not experienced with Linux, we strongly recommend to use the Windows installation image. You may move the setup to a Linux computer later if you like.

Please refer to your detailed installation instruction according to your Operating System. The operating systems we currently support are:

Installing in Windows

Installing in Linux

Installing the Embedded IP-PBX Appliance

Logging in

There are three ways to log in as:

1) System Administrator Mode

• In this mode, you have access to all resources of the PBX. There is exactly one system administrator mode. Because of this, you should make sure that the login information is kept in a safe place.

2) Domain Administrator Mode

• This is a second mode where you can only make changes within a specific domain.

3) User/Extension Mode

• A very restrictive access, where you can change only the settings for the selected extension.

By default, the login name for the administrator mode is "admin" and the password is empty. If you check the "Remember login information" mark, the PBX will send a permanent cookie to the web browser. This cookie can be used next time to skip the login screen and directly move to the first page after login. Logging out effectively deletes the cookie, therefore you will get a login page every time you access the PBX server.

If the PBX could not allocate the port that you specified as http port, you need to locate the port number. This situation can happen for example if another web service already took the port, such as Apache web server. In these situations you can use the Windows command line command "netstat -a -p TCP" to locate the process and find out which TCP ports it has allocated. Normally, you would still be able to log in, because for instance, if you have Apache running on port 80, the pbxnsip server would take over precedence of the assigned port.

There are three ways to resolve this issue:

• 1) Login to the pbxnsip HTTP interface, and then go to System->Ports->HTTP port and change the port number to any of the unused port, and then restart the pbxnsip service (This can be achieved by not using any of the established TCP port in the netstat output)

• 2) If you wish to the specified port for the HTTP interface, you can then changed whatever web

service that are using the allocated port to another available port

• • 2.1) This method is out of the scope of this manual, please refer to the specific web service's documentation to change the port as necessary.

• 3) In the event that the pbxnsip's HTTP interface is unaccessable possibly due to the fact that the other web service is taking over precedence of the specified port. Make sure the pbxnsip service is actually running.
  • 3.1) This can be achieved in Microsoft Windows by looking for pbxctrl in the Window's Task Manager's process list, or in Linux, execute "ps -aux | grep pbx" ), And you will either have to:
    • 3.1.1) Shut down the web service that is using the specified port, and follow solution #1 and #2, or
    • 3.1.2) Edit the pbx.xml manually (located in the pbxnsip server's working directory), search for <http-port>some port number</http-port> and replace xxxx value to an available port.

After executing any of the step has completed correctly, execute the pbxctrl program with the parameter --http-port xxxx where xxxx is an available port

• In Windows command line interface pbxctrl --http-port 8080
• In Linux, the pbxctrl is usually appended with the Linux flavor name such as pbxctrl-suse10

Please note that for secure communication, you should use a certificate for your domain. Otherwise, you might have to accept the warnings from the web browser about the certificate.

Verifying that the System is ok

Usually the installation should be working smoothly. However, if you are already running SIP processes on the system, you might have conflicts on the SIP ports (5060/5061) and/or on the HTTP/HTTPS port. If you are experiencing trouble, please check our section on System Sanity Check.

Configuring your PBX

After you have logged in, you first need to set up the license code. In order to do this, you must be logged in as system administrator. Go to the Settings tab and select License. Enter your license code into the License Code field and push the Save button.

To verify that you code is correct, go to the Status tab. There you should see the License Status and the expiration date. You will also find other useful information like the version number and the routing table that the PBX identified on your system.

In order to get a reasonable first configuration for the PBX, you can use the wizard on the pbxnsip web page. Just go to http://www.pbxnsip.com/configurator/wizard.php. Select how many extensions you would like to set up (you must have enough licenses for that). If you are using a PSTN gateway, you just need to enter the IP address of the PSTN gateway into the field that opens when you select "yes" in the PSTN radio button.

We also provide pre-configured configuration information for a few ITSP. If your ITSP is on the list, you just need to enter your customer number and (optionally) your password. If you don’t like to enter your password here, you can enter that password later directly in the web interface of your PBX.

After hitting the send button, the web browser will provide you with a URL with the necessary parameters. Copy this URL, then go back to the PBX web interface and go to the system administrator settings tab, and select the License tab again. Below the license code you will find the field "URL" in the Request Configuration section of the page. Paste the URL into that field and hit the Save button.

The PBX will then download the configuration from the pbxnsip web page, erase the existing configuration and replace it with a pre-configured configuration.

In order to verify to configuration, you should click on the Domains tab and go to the localhost domain. If you click on Accounts, you should be able to see that there have been accounts set up.

If you want to enter the password for your ITSP now, just click on the Trunks tab and select the ITSP trunk. Then you will find a password field, where you have to enter your password twice. Hit the Save button and the trunk then should register with your ITSP.

Connecting Devices to the PBX

After your PBX is up and running, you should register a SIP phone to the PBX. Please refer to the Interoperability Pages to see your specific device.

When your phone is registered, just call *97. You should hear a prompt that welcomes you to your mailbox. If you like, you can record your name there and start using the PBX.

Changing Your Passwords

When you install the PBX, there are no passwords set up.

• You should set the password for the system Administrator. You find this setting in the administrator mode, Settings.

• You should also consider setting passwords for the extensions. In order to do that, you need to go the domains, select your domain, click on Accounts and then on the extension that you want to set up. Then you will find a password field, where you have to enter the password twice and then hit the save button.

If you want to log in as domain administrator, you can change the permission for that extension. In contrast to the system administrator, there may be several accounts that have the permission to act as domain administrator, even within one domain. The first time when you log in, there is only the system administrator account available.

To log in as domain administrator, you must enter the username and domain name in the "user@domain" form and enter the password, for example "123@test.com". If you have just one domain, you may omit the domain name after the "@" sign. If you have more than one domain and omit the domain name, the system will automatically append a "@localhost" begind the account name.

The domain administrator password is the same as the SIP password for that account.

Next Steps

After you have initially set up your PBX, you should register more extensions and try outbound and inbound calls. Check out the Reference Manual on how to set up additional accounts for conferencing, customize the auto attendant, define outbound DID numbers and other useful things.

Once that you are finished with your setup, you should go back to the administrator mode and fine out where your configuration data is stored. You find this information in the Status window. Just ZIP the whole directory and store it in a safe place. If you loose or corrupt the configuration, you can always replace the current configuration with this snapshot.