Installing in Windows
From Pbxnsip Wiki
 |
Please notice that the PBX should not be run in virtual machines. This is simply to avoid that the virtual machine is bringing in RTP jitter. We feel that for testing purposes this is okay, however for production systems you should run it in a "real" machine. Please also make sure that your personal firewall allows the execution of the pbxctrl service. If you cannot connect to the PBX, there is a high probability that your personal firewall is blocking access to the system. |
Contents |
Fresh Installation
If you are installing the system on Windows the installation process is a matter downloading the pbxnsip windows executable, saving it to your computer, execute it, and clicking through the install shield.
The software can be downloaded from http://www.pbxnsip.com/downloads. Click on the pbx executable to download it to your system and start it.
Once launched the following installation screens will be displayed. This is the first installation screen.
You must read and accept the license agreement if you want to use the software.
At this point you can change the directory where the executable runs and where the configuration files, prompts, and voicemails are stored. This directory will contain all relevant information about the configuration of the PBX. If you choose a local directory, you will minimize the risk of latency when accessing audio files.
Once that is done click finish to complete the installation.
During the installation, the installer will show the progress of the installation. This step may take a few seconds.
The installer will eventually reach the “Completed” state and show the picture below.
We recommend that after the installation, you go to the services manager and verify that the service with the name “pbxnsip PBX” is running. If you want to be sure that everything is working fine, you also might want to reboot the system and verify that after a power failure the PBX will also restart.
Also, we recommend that you tell the services manager to restart the service after a failure. This will make sure that users do not have to manually start the service or reboot the machine if the service should fail for whatever reason.
In Windows, you need to change the registry to enable the tagging of RTP packets for the Type of Service. There is a article from Microsoft on this topic: http://support.microsoft.com/kb/248611/en-us.
After installing the software, please make sure that there is no problem with your local firewall running on the PC (see Firewall Issue).
Installation of Additional Languages
The audio files for additional languages can be found at http://www.pbxnsip.com/downloads.php. Only the US-English prompts are included in the installer, if you want to install additional languages, you need to install them. The language packages contain IVR prompts and optionally tone files.
After downloading the appropriate files, you need to put the audio files into a directory that uses the name audio_xx, where xx is the country identifier (e.g. de for Germany, ru for Russia, sp for Spain).
After loading the languages, you need to restart the service. The PBX will then try to detect the new language. Log in and check if your language appears in the drop-down list.
Upgrade
Typically, you will use the same installer executable (approx. 10 MB) to upgrade the software. But you can also do a "quick" manual software upgrade as described below.
Installer Upgrade
If there is already a copy of the software on your machine the following screen will appear.
This is the second screen that appears if it is an upgrade; you can modify, repair, or remove the software from the system.
After the upgrade is complete, you will see the completion dialog. Click on “Finish” to finish the installation.
After the upgrade you need either to reboot the machine or restart the service. If you can, you should reboot the machine; this will make sure that after a power failure everything will start up fine.
If you don’t like to restart the machine, you must at least restart the service. After this, log in and check the status web page of the administrator mode to see if the version number meets your expectations.
Manual Upgrade
The manual upgrade just swaps out the executable. This has the advantage that you can do software upgrades very quickly. The following steps are neccessary:
- Go to the web page of the PBX and determine the working directory of the PBX and the version number.
- You might want to make a backup of the directory, just in case that you want to move back.
- Then go into the working directory and rename the pbxctrl.exe file into a file that contains the version number (e.g. "pbxctrl-2.0.3.1713"). You can do this while the PBX is running. Keep the file in the directory, so that you can later easily determine what file had what version.
- Then download the new executable from the web page. Typically this will be available at the location http://www.pbxnsip.com/download/pbxctrl-2.0.4.1743.exe. This file has typically a size about 4 MB.
- After downloading, rename the file to "pbxctrl.exe".
- If you are still in the web interface of the PBX, check if there are any calls going on. Is this is the case, wait until the calls are finished. Or barge into the call and tell the participants that you would like to upgrade the system.
- Then go to the services manager and restart the PBX.
Removal of the Software
In Windows, the software can be removed using the “Add or Remove Programs” dialog of Windows. Select the PBX service and then click on Remove.
Backup
In Windows, you can make a backup of the system configuration by copying the content of the working directory into a safe location. We recommend to do this from time to time, so that whenever there should be a problem, you can move back to that state. This is useful when your hardware is in trouble, but it is also useful if you make configuration changes that make the system instable and you want to move back to a previous version.
There are several ways to make a backup.
- You can use an archive program that just "ZIPs" the whole directory. This has the advantage that it also compresses the data significantly and it puts everything in one file, which makes it easier to handle
- If you want to copy the whole directory, consider using XCOPY instead of COPY from the command lile. XCOPY allows to skip errors (/C), which is useful when the PBX is deleting files (e.g. CDR) during the copy. This can happen if you have a lot of data and the copy takes quite some time.
