Run the 3CX PBX Configuration Tool
On this topic
After 3CX has been installed, it will need to be configured for your network. The PBX configuration tool obtains important network and security settings and configures 3CX accordingly. To run it, enter the IP followed by port 5015 (eg. http://10.172.1.88:5015) in a browser on another machine. Alternatively you can run the configuration tool from the command line.
You will be asked the following questions:
- You will be asked whether you are creating a new installation of 3CX or whether you wish to restore an existing configuration. If it’s a new install, select 1, if you have a backup of a previous version or other installation to restore, select 2. Option. See also upgrading from a previous version.
- Enter your license key. If you already own a 3CX license, copy and paste the key here, unless you are restoring a backup, in which case the key will be restored automatically. If you don’t own a license, copy and paste the free PBX edition license key that was sent to you by e-mail. Check your spam folder if you can’t find it. You can have the email resent here. IMPORTANT: Partners & Customers that already have commercial/NFR license keys should use their existing key during installation. Don’t use a license key twice, as your old install will be invalidated.
- Now specify the username and password to access the 3CX Management Console. Make sure to use a strong password to prevent unauthorised access to your PBX. Usernames and passwords are both case sensitive.
- Confirm your Public IP Address. Enter 1 to confirm, or 2 to specify another one (In case your HTTP traffic is routed on different network - be sure to enter the correct one!).
- Specify whether your public IP is static or dynamic. For professional use, a static IP (which does not change) is required. For residential use or evaluation purposes, you can use a dynamic IP. A dynamic IP will change at certain intervals. Although 3CX will detect the IP change and update the FQDN accordingly, your calls will not route until it does so.
- Select the network interface which is connected to the internet / public IP you specified. If you have multiple interfaces ensure this interface is the one with the default gateway configured. (In case the 3CX host features a private and direct wan interface and users will connect to this installation locally and remotely, select the internal interface, which will not have the default gateway configured, and alter the following setting after the installation “Settings ⇒ Network ⇒ Tab:Public IP ⇒ Section:Network Card Interface” to the public interface IP address)
- The PBX configuration tool will now detect whether you are using NAT or not based on your IP. If it’s Local IP, and thus you are behind a NAT, you will have to configure your firewall / router accordingly. More information here.
- 3CX requires a fully resolvable FQDN and a matching SSL certificate for security. This allows 3CX to work seamlessly in and out of the office. To ease setup, you can choose a 3CX supplied FQDN and Lets encrypt certificate. This is provided FREE of charge in the first year and requires only valid maintenance in subsequent years. If you wish, you can configure your own FQDN and upload your own SSL certificate. IMPORTANT: the FQDN/Subdomain you choose will be linked to your license key. If using a trial key be sure to leave your eventual subdomain of choice free.
- 3CX provided FQDN and trusted SSL certificate - You will be prompted for your preferred domain suffix. The configuration tool will then setup your FQDN on the 3CX DNS servers and proceed to generate a trusted SSL certificate via the Let’s Encrypt service. 3CX provides this service free of charge in the first year and as part of the maintenance package for subsequent years!
- Your own FQDN and SSL certificate - You will have to create an FQDN and configure your DNS accordingly, as well as upload a trusted SSL certificate. If you are not familiar with this, do not choose this option! You will be asked for a pfx, cer or crt file and optional passwords. Note we no longer support self signed certificates. In this case you must specify whether you have a DNS server which you can manage or not (for example Microsoft DNS):
- I manage my DNS, use single FQDN - In this case we recommend using a single FQDN, for example: “mycompany.3cx.us”. The FQDN must resolve on your LAN to the machine on which 3CX Phone System is installed, and from the internet it must resolve to your Public IP. You will need to use “Split DNS” on your router/DNS Server. More information on how to Create FQDN using Split DNS.
- I do not manage my DNS, use a separate External FQDN/Local IP or FQDN, for example pbx.interobit.com / 192.168.0.1 or pbx.interobit.local. If you do not have access to your DNS server, specify a separate external FQDN a local IP or local FQDN internally. The external FQDN will be used for devices connecting from outside the LAN. The local IP / local FQDN will be used for internal devices.
- Select which web ports you wish to use for the management console. Use alternative ports only if 80 or 443 are already in use.
- The configuration tool will now configure 3CX and start the services. This may take some time. Once done, a confirmation page will be shown with important information. Make a screenshot and/or print this information - it can not be retrieved afterwards!
- Now you can login to the management console to run the 3CX setup wizard.
To upgrade from a previous version of 3CX:
- Make a backup of your current configuration using the 3CX Backup and restore tool.
- Tick the options to include in your backup, then choose where to save your backup. Warning: Do not choose to store the backup inside any of the 3CX Phone System installation folders as these folders are removed during the uninstall process.
- Uninstall the current version from the “Windows Control Panel > Programs and Features”.
- Now download the 3CX Phone System v15 of choice.
- Proceed with the installation.
- Restore your configuration when prompted.
- From v9 and v10 you must upgrade to v11 SP 4a first, then to v12 SP 6.1
- From v12 SP 6.1 you must go to v12.5 first. *
- From v12.5 SP2 you can go to 15(.5) *
- From v14 you can go to v15(.5) directly.
- Backups from previous versions can only be restored during the installation of the pbx.
*To retain call history information in v15 you must run the call history convert tool after the restore and completion of the configuration wizard. This tool is available only on Windows installs and is located in "C:\Program Files\3CX Phone System\Instance1\Bin\CHconverter.exe". Follow the instructions given to convert your call history. After the conversion you may take a new backup and restore it on Linux.
- See our guides with instructions for installing and upgrading the 3CX Clients for Windows, Android, iOS and Mac.
- Find instructions here on installing 3CX as a Virtual PBX Server.
- See the Hyper-V Page for the specific settings for running 3CX Phone System on Hyper V.
- Check Ports used by 3CX Phone System for the list of ports that must always be available.
- The Firewall & Router Configuration Guide provides details on which ports to open.
- Recommended Hardware Specifications for 3CX Phone System.
- See our guide on how to use the Backup & Restore feature within the 3CX Management Console.
- FQDN Management and Allocation
- 504 Gateway Time-out message
- V15: How to Use your Own SSL & FQDN Certificate