| Note |
|---|
This information on this page applies only to PBX versions 15.x and above. For version 14.x or lower please see: Warm Spare Setup |
| Table of Contents |
|---|
Introduction
...
The Warm Spare setup on PBX 15+ has changed from the way it used to be in older versions.
We are now using the Filestore , API and Backup & Restore modules for the Warm spare Backup configuration, so we need to ensure that all 3 mentioned modules are present in both Primary and Secondary server.
...
the process needs to send data from the primary to the warmspare. We can either use FTP or SSH protocol to perform this task using Filestore module (SSH is the recommended path)
...
In this section, we will describe how to configure "SSH" to use for Warm Spare setup.
First, we will set up shared keys between the two servers so they can communicate across SSH on port 22. PBX 15+ onward there is no need of generating SSH Keys for the Primary server. Backup & Restore module will take care of generating SSH Keys by itself. But we have to copy the Primary Server SSH Keys to Secondary server to ensure that Primary can communicate with Secondary server easily.
We can use any one of the following 2 methods to copy the SSH keys to Secondary (Warm spare) server.
Manually copy the SSH Keys to Secondary Server
"FreePBX GUI - > Admin → Backup & Restore → Global Settings" has server SSH keys which we can copy to Secondary server manually. (note some browsers may not let you copy this data)
...
You may copy this key to spare/Secondary server manually to /root/.ssh/authorized_keys file. Create a file called "authorized_keys" (if not present) and add your Public Key in that file. If that file already exists just add your Key to the end of the file (make sure each key is separated by a new line!)
...
Using SSH CLI command to copy Primary SSH keys to Secondary server
...
(preferred method)
| Note |
|---|
Please note if you are doing this from a fresh install and have never visited the backup and restore module these steps will FAIL. Before proceeding go to the backup and restore module in the GUI , this triggers creation of keys referenced below. Once in the module click on the global settings tab and confirm the key is present as shown above |
...
Once SSH Setup done, we have to configure the Filestore module for the SSH.
Please follow the guide Filestore Module#SSH to perform the SSH configuration on the primary server.
...
We have to enable FTP protocol on the Warm Spare (Secondary) server by following System Admin - Provisioning Protocols#ProvisioningProtocols-Enable/DisableFTP
| Info |
|---|
filestore FTP If you have selected the FTP filestore, make sure that your FTP username and password are not removed from the Warm Spare Server |
...
Once FTP Setup as mentioned as above done then we have to configure "Filestore" module for the FTP.
Please follow the guide Filestore Module#FTP to perform the FTP configuration i.e. Add Warm Spare (Secondary) server.
...
Create the Application Machine to Machine App
Allow the scope(gql:backup) to access the backup module and then "Add Application".
Copy the Access details to notepad or text editor, you will need this info when we setup the replication job on the Primary server.
| Info |
|---|
SSL Certificates If you are using self Singed Certificates, DO NOT use HTTPS in the below URLs on primary server Which can result this error (cURL error 60: Issuer certificate is invalid. ) 1. Token URL |
| Info |
|---|
HTTP / HTTPS ports When the PBX WebUI is configured to use non-standard ports for HTTP (80) / HTTPS (443), then you need to include the port number in the URLs. http://192.168.3.249:2001/admin/api/api/token |
How to setup a Warm Spare Backup job
Build your backup job as you normally would however make sure you are adding your Warm Spare server as one of the backup Storage Locations (note you can select multiple Storage Locations here)
...
Enable the "Warm Spare" option.
...
Once we enable the "Warm spare" option. Now you can see the Warmspare configuration options as shown below.
...
Warm Spare Server Input fields
 | The Warm Spare settings will show up once "Enable" is set to "Yes" |
 |
| Should NAT settings from primary system be restored to the Warm Spare system? |
 | Should Bind Address settings on the primary system be restored to the Warm Spare Server ? |
 | Should DNS settings on the primary system be restored to the Warm Spare Server ? |
 | Should we run "Apply Configs" on the Warm Spare Server after a restore is completed? |
 | The Warm Spare Server which is added in the Filestore module (FTP/SSH) |
| Warm Spare server Access Token URL |
| Client ID generated on the Warm Spare Server API |
 | Client Secret generated on the Warm Spare Server API |
 | GraphQl URL Generated on the Warm Spare Server API |
 | This is the Access Token which will be generated on the Warm Spare Server |
 | By clicking on this button, you can TEST the connectivity between the servers |
  | Exculde Certman while restoring the backup If this option is set to yes then certificate will not be restored which require HTTPS config to be rebuild manually with spare server certificate. |
|---|---|
  | Exclude Trunks While restring the backup exculde the trunks from primary server |
...
Warm spare job output will be something like below and at the end "Restore Status" will display the response from the API (which triggered the restore process in warm spare server).
...
| Info |
|---|
IMPORTANT Operational notes:
|