It is critical that you have a backup procedure in place. Schmooze Com, Inc. offers a support package that includes automated offsite backups. This module is used to backup your PBX phone system settings and configurations. If you have a support contract that includes offsite backups, the backup will be defined here. Please do not remove, edit the backup marked "Schmooze POMPs", or your backups will no longer be sent to us for offsite storage.
Backing up your PBX is a crucial step in the setup process. You have several ways to automate this process or you can do an "on the fly" backup as needed. If you are wish to create a Warm Standby with 2 PBX systems please see this guide for Setting up Warm Spare Backups.
Logging into the Backup and Restore module and you will see a screen like the one below.
- On the top menu click Admin
- In the drop down click Backup & Restore
On the right side you will see a list of all the different sections of the backup module on the top.
At the bottom of the list will be all the current backup jobs you have created.
The backups section of the backup module is where you actually define a backup job. You can create as many backup jobs as you want and set when and how often they should run, what should be included in the backup and where to store it.
The restore section of the backup module is where you pick to restore from a backup. You can restore from a backup on your local computer or from any defined FTP, SSH or Local storage server.
The servers section is where we define any PBX servers or database tables that we want to backup configurations from. You also define and Linux boxes or FTP servers you want to store the backups on.
Templates are used to create groups of files, directories or databases that you want included in a backup. We have defined some standard templates for you already but you can add your own custom templates at anytime. When creating a backup job you can drag one or more templates into the backup job to define what is all going to be backed up for that backup job.
When clicking on the backup section we can view or create any new backup jobs. For our example we will create a new backup job by pressing the “New Backup” button.
Give your backup job a name to easily identify it.
Here you can optionally define a longer description if you want for this backup.
This is where you choose what will actually be backed up. On the right side you will see a list of standard templates that are included with your PBX. The most standard template for a normal daily backup you would want to use is the full backup.
To include the full backup template, use your mouse to drag it from the right side to the left side under the“Backup Items” heading.
Once you drag over an item you will see the following on the right side:
- Advanced users can also press the green plus icon to add your own files or directory paths to be included in your backup.
- Please see templates section on how to modify or create your own templates.
With the full backup we are not including any voicemails, custom music on hold or system prompt recordings. If you want these included also, drag over the “System Audio” and “Voicemail Templates” from the ride side to the left side.
Hooks allow you to have the backup job based on the following actions to execute a custom script at the location defined for each action. This is for advanced users who may want to write custom things to happen for any of the following actions:
Make sure your script has execute permissions for the Asterisk user.
Hook to run before starting the actual backup.
Hook to run after completing the backup.
Hook to run before starting the actual restore of the backup.
Hook to run after completing the restore of the backup.
This is where we choose which server we want to backup. This can be the local PBX that the backup module is on or it could be another PBX as defined in the servers section of the backup module. Please see the server section for more information on defining other servers. Most of the time you will pick “This Server” since that is what we want to backup.
Storage location are servers that have been setup to store the actual backup on. By default we include the local server as a storage location.
"Local Storage: The backup tarball file is stored in "/var/spool/asterisk/backup/(backupjobname)/*.tgz" on the local machine
On the right side we will see a list of servers that have been setup to store the backup as defined in the servers section of the backup module. Please see server section for more information on defining other servers.
Drag one or more storage servers to the left side to define where to store the backups. These servers are defined under "servers"
Never run the backup
Every hour at the top of the hour
Every day at midnight
Every Sunday at midnight
This first of each month at midnight
January 1st at midnight
On a reboot command of the PBX an upgrade will be run.
Allows you to define your own schedule on when to run upgrades.
Here we can define how many copies of the backup we want to keep and when they should be deleted
Delete After Time Frame
Here you can define increments, for example delete after 3 months or 5 weeks.
Delete After Runs
Here you can define how many copies of the backup to delete versus deleting backups by time frame such as only keep fifteen. On the 16th backup the oldest backup will be deleted from the system. We recommend keeping 7-10 backups only to conserve hard drive space
Save and Run
When you have things the way you want them click "Save"
After you save "And Run" will appear. You can click the "and run to run the backup for the first time and test your settings.
You should see "Backup successfully completed!"
When on the restore section we can see a list of all the servers that we have setup on and can pick any server to restore the backup from.
You can also choose to upload a backup file from your local computer if you have it stored on the computer you are logged into the backup module with.
Restoring a Backup File
Once you have chosen which server you restore from or uploaded the backup file you want to restore from, you will see this screen, which will give us a list of all backups on the server
Click on one of the backup files and you will see information on what is contained in the backup. Press the “Go” button to perform the restore of the backup.
Check the boxes for the items you wish to restore, then click "Restore"
If you would like to download the actual backup file to use somewhere else you can press the “Download” button and it will download the backup file. You can then upload that backup to another system to restore the backup on.
When clicking on the servers section we will see a list of all the servers created and can create new servers.
Backup Server Types
This would be used to send a backup file as an email attachment for storing the backup.
This would be used to send a backup file to when a backup is created. It also will allow you to restore a backup from the FTP server direct.
This is the local PBX that the backup is on. This is where the backups can be restored from and where the backup job will actually perform the backup of the files and configurations.
This is where we define where the MySQL server is located and how to log into it so we can backup the database.
This could be another PBX that we log into and perform the backup on. For example if you have a warm spare backup box on the warm spare we would setup the backup job to log into the production server and perform the backup on the production server then move the backup file to the backup server and restore it on a night basis.
You can also define a SSH server for storing backups just like an FTP server, and using SCP to copy the files over to the SSH server. Any Linux box that supports SCP can be an SSH Server.
When clicking on the templates section we will see a list of all the templates that we created and can also create or edit templates.
Templates that are included at install can not be modified. You can create your own templates but there typically is no need for this unless you need to include custom files, directories or databases, and you want to simplify it to create a template of only custom items that you drag into a backup job versus adding the custom entries right into the backup job as we went over earlier.
When creating a template you will need to give it a name and optionally, a description.
Clicking the green plus button will allow you to pick which file, directory or database to be included.
Above shows an example each item type that can be chosen from the drop down.
When you have the items the way you want them remember to click "Save"