TryLearn More

Use SIP trunks, WebRTC & Apps

Slash your Phone Bill by 80%

Installing 3CX on Debian Linux

On this topic

Installing 3CX on Debian Linux

Introduction

System Requirements

Supported VM Platforms

Supported Mini PC’s

Network, Firewall & Other Requirements

Installing Debian for 3CX

Removing Debian for 3CX

Manual Installation

See Also

Introduction

3CX created an ISO (get ISO here) of Debian Linux dedicated to 3CX. This makes installation faster and management easier. Most of the OS management can be done from within the 3CX web management console.

We strongly recommend that you dedicate your Debian Linux instance to 3CX. Do not install other packages or change its configuration, as this will prevent us from upgrading your operating system to a new version and we will not be able to support your install.

System Requirements

As a rule of thumb, your machine or VM will need at least one 1 CPU core and 1 Gbyte RAM (although it will run on a Google Cloud  f1 micro instance with 612 MB RAM for very small installs). Additional CPU time and RAM should be allocated based on:

  • Number of simultaneous calls the system will handle.
  • Number of active users (100 users using the web client all day is very different from 100 IP Phones in hotel rooms making the occasional call).
  • If you will be using call recording (places significant load on the system because of audio mixing and writing to storage).

Suggested Hardware Specifications for different usage scenarios can be found here.

Supported VM Platforms

3CX Phone System is well suited to be run as a Virtual Machine. Tested and supported hypervisor platforms are:

  • VMware ESX 5.X and above.
  • Microsoft HyperV 2008 R2 and above. See our Hyper-V Page for required settings.
  • KVM
  • Citrix XenServer 7.0 and above

Supported Mini PC’s

3CX has tested this on the following MiniPC models:

Network, Firewall & Other Requirements

  • If you are installing on the local LAN, your network must be properly configured using a RFC 1918 private network (e.g. IP 172.16.0.0 /10.0.0.0/192.168.0.0 range).
  • If the machine you are installing 3CX on is behind a NAT device, its ports need to be forwarded. See the Firewall & Router Configuration Guide to learn how to do this.
  • You need to use the latest version of Firefox, Google Chrome, Edge to access the 3CX web interface.
  • The machine you are installing 3CX on needs a constant internet connection to activation.3cx.com on port 443.
  • The machine also needs on demand HTTPs connection to downloads.3cx.com/* for 3CX Management Console downloads and additional information.
  • Do not install VPN software on the machine you are installing 3CX.

Installing Debian for 3CX

To install Debian for 3CX:

  1. Download the Debian for 3CX ISO from here.
  2. If you are using a hypervisor/virtualized OS set the CD option to boot from the ISO and ensure the CD drive is set to connect on startup. If you are installing on a mini PC, then create a bootable image, plug it into one of the available Mini PC’s USB ports, set the BIOS to boot from the USB drive and the installation will start.

  1. Boot your system with the downloaded 3CX ISO. Select Install from the main boot screen and press the <Enter> key.

  1. Now enter a hostname for the computer so you can easily identify it on your network, using the characters 'a' to 'z', numbers '0' to '9' and the '-' character. NOTE: If you need to configure a static IP address, press ESC when asked for the hostname. You will be taken back to configuring the hostname when you have set the IP address of the system. If you don’t want to set a static IP address, enter a host name and select <Continue> to go to Step 6.

  1. Select “Configure Network Manually” and press the <Enter> key to set a static IP address. The installer will ask you to enter the system's static IP address and select <Continue>. Then enter the network netmask and select <Continue>. Then enter the network default gateway IP address and select "Continue". Finally, enter the name server IP address and select <Continue>.

  1. Enter a domain name. If this is a network, use the same domain as you use on other computers in the network, for example mycompany.com. After you enter a domain that the machine will belong to, select <Continue> to proceed.

  1. Now select the language you wish to install as the default system language and press the <Enter> key.

  1. Select your geographical location from the location menu to update the system locale and press the <Enter> key to proceed.

  1. Specify the root password for the machine and select <Continue>  to re-enter the password for verification purposes. Finally, select <Continue> to proceed.

Note: We recommend you set a strong password for the 'root' user, as this account has no restrictions!

  1. Select your timezone to configure the system's clock and press the <Enter> key to proceed
  2. Partition your disk, selecting “Guided - use entire disk”. Press the <Enter> key to proceed.

  1. Confirm your disk selection by pressing the <Enter> key.

Note: If you are installing to a bare metal machine, please remember that all the data on your disk will be erased!

  1. Select the “All files in one partition” partitioning scheme and press the <Enter> key to proceed.

  1. Select “Finish partitioning and write changes to disk and press the <Enter> key to proceed to the Debian for 3CX installation.

  1. Select Yes and press the <Enter> key to confirm writing the changes to the disk. The install process can take about 10-20 minutes, depending on your machine’s performance. When the Debian installer finishes, the machine will be rebooted and the 3CX installation will start automatically.

  1. On the “3CX Update Channel” screen you need to select which 3CX package to install on the machine. Choose:
  • 3CX Stable for the stable edition of the PBX and proceed to the next step.
  • 3CX Beta for the evaluation edition of the PBX and proceed to the next step.
  • 3CX SBC for the Session Border Controller edition of 3CX and follow this guide to configure the SBC.

  1. After the 3CX installation is complete, you need to select how you want to configure 3CX. The 2 options are (1) via a Web Browser and (2) using the command line. Select option (1) to use a web browser on another machine, and point your browser to http://<ip of machine>:5015.

Warning:
The command
sudo /usr/sbin/3CXWizard --cleanup
resets the 3CX installation, deleting all data including backups and recordings! Before running this command, please make sure that you have copies of this data stored outside of this machine, as it requires no confirmation.

  1. Now you need to go through the wizard. It will detect your IP, ask whether you are behind a NAT device and confirm these options with you. You get to choose a subdomain and admin credentials for your PBX. Afterwards, you will be presented with a summary page to login to your PBX. Save the login credentials and don’t lose them! Visit this guide for step by step instructions.

Removing Debian for 3CX

In case you want to uninstall 3CX there are 2 options you can use:

  1. apt-get remove 3cxpbx 
    : Use this command when you want to uninstall 3CX keeping all the 3CX Data on the machine (Recordings, Database, Data files etc). This option is useful in case you want to re-install 3CX at a later time.
  2. apt-get remove --purge 3cxpbx
     : Use this command when you want to completely remove 3CX and all 3CX related files

Manual Installation

If you want to install Debian and 3CX manually without using our ISO, for cases where the 3CX ISO cannot be used because the hoster does not allow custom ISOs to be uploaded, see this guide.

See Also