Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated for 13

...

It is critical that you have a backup procedure in place. Schmooze Com, Inc. offers We offer 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 , or 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 Warm Standby with 2 PBX systems please see this guide for Setting up our Warm Spare BackupsSetup wiki.

Logging in

Logging into the Backup and Restore module and you will see a screen like the one below. 

...

At the bottom of the list will be all the current backup jobs you have created.

Image RemovedImage Added

Backups

The backups 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.

Restores

The restore 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.

Servers

The servers Servers section is where we you define any PBX servers or database tables that we want you 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 want to include 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 it to define what is all going to be backed up for that backup job.

Backups

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.

Backup Settings

Image Removed

Backup Settings

Click the New Backup button to create a new backup, or click an existing backup to edit its settings.

Image Added

Backup Name

Give your backup job a name to easily identify it.

...

Here you can optionally define a longer description if you want for this backup.or add notes.

Status Email

If defined, the system will send status updates to this e-mail address when the backup task is run.

Backup Items

Image RemovedImage Added

Items

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 you would want to use for a normal daily backup you would want to use is the full backup. 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:

 

the Templates bin to the Items bin.

Info
titleAPPLICATION NOTE

 

Advanced users can also press the

green

plus sign iconImage Added to add your own files or directory paths to be included in

your

a backup.

 

Please see templates section on how to modify or create your own templates.

 

 

Image Removed

Once you add an item, you will see the items that will be backed up, as well as any exclusions:

Image Added

Info
titleAPPLICATION NOTE

With the full backup we are not including The Full Backup template does not include any voicemails, custom music on hold, or system prompt recordings. If you want these to be included also, drag over the “System Audio” and “Voicemail Templates” from the ride side Templates bin to the left side Items bin.

Hooks

Hooks allow you to have base the backup job based on the following actions in order 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 would like to customize the following actions:.

Info
titleAPPLICATION NOTE

Make sure your script has execute permissions for the Asterisk user.

Image RemovedImage Added

Pre-

...

Backup Hook

Hook to run before starting the actual backup.

Post-

...

Backup Hook

Hook to run after completing the backup.

Pre-

...

Restore Hook

Hook to run before starting the actual restore of the backup.

Post-

...

Restore Hook

Hook to run after completing the restore of the backup.

Backup Server

This is where we you choose which server we want to backupback up. 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” Server,” since that is what we want to backupback up.

Image RemovedImage Added

Storage Location

Storage location locations are servers that have been setup set up to store the actual backup on. By default we include the local server as a storage location.

Info

"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 The Available Servers list shows servers that have been setup set up 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.

Image Removed

Image Added

The Storage Servers list defines where to store the backups. Drag one or more storage servers to the left side to define where to store the backups. These servers are defined under "servers"Image Removedfrom the Available Servers bin to the Storage Servers bin.

Image Added

Backup Schedule

Image RemovedImage Added

Never

Never run the backup

...

Allows you to define your own schedule on when to run upgrades.

Image RemovedImage Added

Maintenance

Here we can define how many copies of the backup we want to keep and when they should be deleted

Image RemovedImage Added

Delete After Time Frame

...

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

...

When you have things the way you want them, click "the Save button.

Image RemovedImage Added

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.

Image Removed

Image Removed

Run

You can manually run your backup at any time by visiting the Backups section and clicking the run button (Image Added). 
Image Added

When you do this, a window will pop-up displaying the status of the backup. You should see "Backup successfully completed!"

Image Added

Restore

When on In the restore Restore section we , you can see a list of all the servers that we have setup on and can pick any server to restore the backup from.

Image RemovedImage Removed

You can also choose to select a server to restore the backup from, or select a backup file on your local computer.

Restoring from a Server

Available servers are shown at the bottom of the list on the right side of the screen. Select a server.

Image Added

Available backups will be displayed. Browse the folders to view available files.

Image Added

Browse the folders and select a backup to restore from. More details will be shown to the right.
Image Added

Click the Go! button. You will be taken to a page where you can select which items to restore.

Use the checkboxes to select which items you would like to restore, then click the Restore button.

Image Added

A window will pop up showing the status of the restore.
Image Added 

The status window will say Done! when the restore is complete.

Image Added

Restoring from a Local File

You can upload a backup file from your local computer if you have it stored on the computer the same computer you are logged using to log into the backup Backup & Restore 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

Image Removed

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.

Image Removed

Check the boxes for the items you wish In the Restore section of the Backup & Restore module, click the Browse button.

Image Added

Select a file from your local computer.

Click the Restore button to begin the restore process. You will be taken to a page where you can select which items to restore.

Use the checkboxes to select which items you would like to restore, then click "the Restore" button.

Image Removed

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.

 

Servers

When clicking on the servers section we will see a list of all the servers created and can create new servers.

Image RemovedImage Added

A window will pop up showing the status of the restore.
Image Added 

The status window will say Done! when the restore is complete.

Image Added

Servers

The Servers section shows the servers that have been created and allows you to create new servers.

Image Added

Backup Server Types

Email

This would be used to send Sends a backup file as an email attachment for storing the backup.

FTP

This would be used to send Sends a backup file to when a backup is created. It also will allow you to restore a backup an FTP server. The backup can be directly restored from the FTP server direct.

Local

...

This is the local PBX (server) that the backup is stored on. This is where the backups can be restored from and where the backup job will actually perform the backup of the files and configurationsThe backup job will be performed on this local server and can be restored from here as well.

MySQL Server

This is where we define where the MySQL server is located and how to log into it so we can backup back up the database.

SSH Server

This could be another PBX that we you log into and perform the backup on. For example, if you have a warm spare backup box, you would set up the backup job on the warm spare we would setup the backup job to log into the production server and , perform the backup on the production server, and then move the backup file to the backup server and restore it on a night nightly basis.

Info
titleAPPLICATION NOTE

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.

 

Templates

When clicking on the templates section we will see a list of all The Templates section shows the templates that we created and can also have been created and allows you to create or edit templates.

Image RemovedImage Added

Templates that are were included at install can not cannot be modified. You can create your own templates, but there typically is no need for this unless you need to include want to simplify the process of including custom files, directories, or databases , and you want to simplify it to in a backup. You can 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.for the custom files, then drag that template into a backup job instead of adding the custom files to the backup one-by-one.

Creating a Template

In the Templates section of the Backup & Restore module, click the New Template button.

When creating a template you will need to give it a name and optionally, a description.

Image RemovedImage Added

Clicking Click the green plus button will allow you to pick which file, directory or database to be included.

Image Removed

Image Removed

Above shows an example each item type sign button (Image Added) to select which files, directories or databases will be included. Select the item type and then fill in the appropriate fields. Repeat the process for each type of item you would like to add to the template.
Image Added

Image Added

The example below shows the four types of items that can be chosen from the drop-down menu.

When you have the items the way you want them remember to click "Save"

Image Added

Click the Save button when finished.
Image Added