TryLearn More

Use SIP trunks, WebRTC & Apps

Slash your Phone Bill by 80%

Backup, Restore & Failover

On this topic

Backup, Restore & Failover

Introduction

Creating Backups

Step 1: Configure a Location to Store Backups

Step 2: Create a Backup

Restoring a Backup

Immediate Restore

Scheduled Restore

Failover (PRO & Enterprise)

Upgrade a Previous Version of 3CX

See Also

Introduction

3CX Phone System integrates backup and restore functionality, to enable you to:

  • Create regular backups.
  • Allow for easy upgrades to newer versions of the 3CX Phone System.
  • Allow hassle-free moving from one machine to another.
  • Configure a standby server for fault tolerance.

Creating Backups

To backup your system, you need to decide where, what and when to backup your PBX:

  • Where - choose between local drive, Google Drive or remote FTP.
  • What - system configuration, voicemail, recordings etc.
  • When - one-off or at scheduled intervals.

During backup or restore operations 3CX services need to be stopped, so we recommend doing it at off-peak hours.

Step 1: Configure a Location to Store Backups

3CX saves and restores backups to a central local or remote backup location. To choose a location to store backups select the Backup and Restore function in 3CX Management Console and:

  1. Click on Location to select the backup location type and configure accordingly:
  • “Local disk” - click the browse button to choose the location.
  • “Google Drive” - a folder on Google Drive.
  • “FTP” - requires a path to the FTP server and the account username and password with rights to access the FTP folder.
  1. We recommend to configure using Google Drive by logging in with a single user Google account or a business G Suite account in the same browser window and:

  1. Select Google Drive as location type and click “Authorize”.
  2. Click “Allow” to confirm that your 3CX install can access the folder to use as backup location - just your install gains access, not 3CX.
  3. Copy the generated authorization code.
  4. Paste the code into the relevant field in 3CX and click “OK” to select the folder to use for storing backups.
  1. Click OK to save the backup location.

Backups are stored to this location, to download or remove via the “Backup and Restore” function.

Warning: Do not specify the Backup Location to be in any of the 3CX Phone System installation folders on the local disk, as these folders are removed during the uninstall process.

Step 2: Create a Backup

To create a backup from the Backup and Restore function:

  1. Click the Backup button and specify a name for the backup.
  2. Select the items to include in the backup.
  3. Click OK to start the backup immediately and get notified via email to the admin’s address when the backup completes. The new backup appears in the backup repository window.

To schedule a backup from the Backup and Restore function:

  1. Click the Backup Schedule button and enable the Enable Schedule Backup option.
  2. Choose what to backup and then choose between Daily or Weekly specifying the time.
  3. Choose a backup rotation, i.e. the number of backups to keep before overwriting the oldest.

Example: If you choose a weekly backup schedule and a rotation of 5, you have 5 weekly backups to restore from, going back 5 weeks.

  1. Click OK to schedule your backup.

Restoring a Backup

You can restore a backup immediately, in case you are moving 3CX to another server or upgrading from an old version. Alternatively, you can schedule a restore and specify whether the 3CX services start after the restore or not. The main purpose of a scheduled restore is to keep a second system on standby with up to date configuration and user data.

Tip: You can store backups from a previous version or another installation into the backup location you specified, so 3CX recognizes them and uses them for restore.

Immediate Restore

To perform an immediate restore from the Backup and Restore function:

  1. Select the backup to restore and click the Restore button.
  2. Click OK to confirm the restore in the warning dialog and stop all 3CX services during the operation.
  3. The management console logs you out to proceed to the restore. You can log back in when the restore is complete.

Scheduled Restore

A scheduled restore is used for keeping a second server on standby and up to date with the latest data and configuration. To perform a scheduled restore from the Backup and Restore function:

  1. Click on the Restore Schedule button and enable the Enable Schedule Restore option.
  2. Select when to start the restore process (daily or weekly) and at what time.
  3. Select whether you want to start the 3CX Services after the restore or not.
  4. The scheduled backup (3CXScheduledBackup.zip file) is to be restored automatically, based on the defined schedule. Manually triggered backups are NOT restored automatically.

Failover (PRO & Enterprise)

3CX PRO and Enterprise editions support failover out of the box to easily setup an active - passive failover using just two machines. Effectively a second server is configured, continuously updated via scheduled restore, while additionally monitoring the primary system. When it detects a failure on the primary server, it switches itself to active. For more info see the detailed Failover how-to Guide.

Note: With an ENT license key the DNS TTL resolution for a 3CX provided FQDN is set to 5 minutes whereas a Pro license key uses a 6 hour TTL, causing a much longer reconnect time for IP-Phones, 3CX Apps, 3CX SBCs or the 3CX Web Client.

Upgrade a Previous Version of 3CX

To upgrade from a previous version of 3CX:

  1. Take a backup of your current 3CX configuration using the “Backup and Restore” function to select what to include in your backup.
  2. Uninstall the current 3CX PBX version on:
  • Windows from “Control Panel” > “Programs and Features”.
  • Linux by running the command as root:
    apt-get remove 3cxpbx 
  1. Now download the latest 3CX Phone System and proceed with the installation.
  2. Restore your configuration when prompted during the configuration phase.


Important:

  • After upgrading the recordings quota is set to 5GB. To set a higher recording volume, navigate to “Recordings” > “Quota” and adjust the recordings quota as needed.
  • Upgrading via backup from version 14 and higher is directly supported.
  • Any installs below version 14 need to be converted to version 14 first in order to be restored, following the below conversion path for:
  • v12 SP 6.1, upgrade to v12.5, then to v14 SP3. Download V12.5 here.
  • v12.5 SP2, upgrade to v14 SP3. Download V14 here.
  • v14 SP3, upgrade to v15.5 directly.
  • Backups from previous versions can only be restored during the PBX installation.

See Also

Free for up to 1 year! Select preferred deployment:

On-Premise

for Linux on a $200 appliance or as a VM

Get the ISO

On-Premise

for Windows as a VM

Download the setup file

On the cloud

In your Google, Amazon, Azure account

Take the PBX Express