查看“备份和还原模块配置”的源代码

'''备份还原模块用户使用指南'''

注意，此模块已经在13版本更新，请检查。


'''总览'''

备份生成呼叫的PBX是非常重要的工作。我们提供商业版本的备份还原模块。请不要删除标注"Schmooze POMPs"，否则你的备份可能不能保存。

再次提示，备份工作的IPPBX系统是非常重要的工作，请务必谨慎操作。

'''Logging in'''

* 点击顶部菜单 '''Admin'''
* 下拉菜单中点击 '''Backup & Restore'''

在右侧栏中，系统会列出不同的备份模块。

http://wiki.freepbx.org/download/attachments/26509506/backup-restore-home-screen.png

'''Backups'''

备份模块支持用户对系统必要文件进行安全备份。 用户可以创建一个备份任务，根据时间周期来定期执行任务进行备份。

'''Restores'''

还原模块则是如果系统出现故障以后，用户可以把备份的文件通过还原模块来进行系统还原。用户可以通过本地还原，FTP还原或者SSH，或者本地存储服务器还原。

'''Servers'''

服务器部分是用来定义哪一台服务器或者数据库需要进行备份配置。用户也可以配置一台linux服务器或者FTP服务器来进行备份任务。

'''Templates'''

模板用来创建文件组，路径，或者数据库，这些数据可以包括在备份文件中。我们已经定义了一些标准的模板，当然用户也可以添加自己的模板。 当创建备份任务时，用户也可以通过鼠标拖拉这些模板，添加这些模板到备份任务中。

'''Backup Settings'''

点击 '''New Backup''' 按钮创建一个新的备份任务，或者点击已存在的备份进行编辑设置。

http://wiki.freepbx.org/download/attachments/26509506/backup-name-description.png

'''Backup Name'''

指定一个备份文件名称。

'''Description'''

对其备份添加描述。

'''Status Email'''

如果已定义，备份开始运行时，系统会发送状态更新数据到邮箱。

'''Backup Items'''

http://wiki.freepbx.org/download/attachments/26509506/backup-items-drag-list.png

'''Items'''

选择备份项。

如果选择完整备份，从这些相关项目拖拉进来。

''注意''

高级用户可以按 http://wiki.freepbx.org/download/attachments/26509506/plus-sign.png 添加自己的文件或者路径。

完成添加项目后，用户可以看到所有需要备份的项目:

http://wiki.freepbx.org/download/attachments/26509506/backup-items.png

''注意''

完整备份中没有包括语音邮箱，自定义的音乐等待，系统提示录音文件。如果用户需要添加这些文件，使用鼠标从模板中拖“System Audio”和“Voicemail Templates”到需要备份的项目中。

'''Hooks'''

Hooks allow you to base the backup job on the following actions in order to execute a custom&nbsp;script at the location defined for each action. This is for advanced users who would like to customize the following actions.

APPLICATION NOTE

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

http://wiki.freepbx.org/download/attachments/26509506/backup-hooks.png

'''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 you choose which server to back up. This can be&nbsp;the local PBX that the backup module is on, or it could be another PBX as defined in the&nbsp;servers section of the backup module. Please see the server section for more information&nbsp;on defining other servers. Most of the time you will pick “This Server,” since that is&nbsp;what we want to back up.

http://wiki.freepbx.org/download/attachments/26509506/backup-server.png

'''''''''Storage Location'''

Storage locations are servers that have been set up to store the actual backup on. By&nbsp;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

The&nbsp;'''Available Servers''' list shows servers that have been set up to store the backup&nbsp;as defined in the servers section of the backup module. Please see server section for&nbsp;more information on defining other servers.

http://wiki.freepbx.org/download/attachments/26509506/storage-servers.png

The '''Storage Servers''' list defines where to store the backups. Drag one or more storage servers from the&nbsp;'''Available Servers''' bin to the&nbsp;'''Storage Servers''' bin.

http://wiki.freepbx.org/download/attachments/26509506/selected-server.png

'''Backup Schedule'''

http://wiki.freepbx.org/download/attachments/26509506/backup-schedule.png

'''Never'''

Never run the backup

'''Hourly'''

Every hour at the top of the hour

'''Daily'''

Every day at midnight

'''Weekly'''

Every Sunday at midnight

'''Monthly'''

This first of each month at midnight

'''Annually'''

January 1st at midnight

'''Reboot'''

On a reboot command of the PBX an upgrade will be run.

'''Custom'''

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

http://wiki.freepbx.org/download/attachments/26509506/custom-backup-schedule.png

'''Maintenance'''

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

http://wiki.freepbx.org/download/attachments/26509506/maintenance.png

'''Delete After Time Frame'''

Here you can define increments, for example delete after 3&nbsp;months or 5 weeks.

'''Delete After Runs'''

Here you can define how many copies of the backup to delete versus&nbsp;deleting backups by time frame such as only keep fifteen. On the 16th backup the oldest&nbsp;backup will be deleted from the system. We recommend keeping 7-10 backups only to&nbsp;conserve hard drive space

'''Save'''

When you have things the way you want them, click the&nbsp;'''Save''' button.

http://wiki.freepbx.org/download/attachments/26509506/save-button.png

'''Run'''

You can manually run your backup at any time by visiting the '''Backups''' section and clicking the run button http://wiki.freepbx.org/download/attachments/26509506/backup-in-list.png

http://wiki.freepbx.org/download/attachments/26509506/backup-status.png



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


'''Restore'''

In the Restore section, you can 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.

http://wiki.freepbx.org/download/thumbnails/26509506/server-list-restore-from.png

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

http://wiki.freepbx.org/download/attachments/26509506/list-of-files.png

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

http://wiki.freepbx.org/download/attachments/26509506/backup-to-restore-from.png

Click the&nbsp;'''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&nbsp;'''Restore''' button.

http://wiki.freepbx.org/download/attachments/26509506/restore-selections.png

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

http://wiki.freepbx.org/download/attachments/26509506/running-restore.png

The status window will say&nbsp;'''Done!''' when the restore is complete.

http://wiki.freepbx.org/download/attachments/26509506/restore-complete.png

'''Restoring from a Local File'''

You can upload a backup file from your local computer if you have it stored on the same computer you are using to log into the Backup & Restore module.

In the '''Restore''' section of the Backup & Restore module, click the '''Browse''' button.

http://wiki.freepbx.org/download/thumbnails/26509506/browse-button.png

Select a file from your local computer.

Click the&nbsp;'''Restore''' button to begin the restore process.&nbsp;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&nbsp;'''Restore''' button.
http://wiki.freepbx.org/download/attachments/26509506/restore-selections.png

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

http://wiki.freepbx.org/download/attachments/26509506/running-restore.png

The status window will say&nbsp;'''Done!''' when the restore is complete.

http://wiki.freepbx.org/download/attachments/26509506/restore-complete.png

'''Servers'''

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

http://wiki.freepbx.org/download/attachments/26509506/servers-main-page.png

'''Backup Server Types'''

'''Email'''

Sends a backup file as an email attachment.

'''FTP'''

Sends a backup file to an FTP server. The backup can be directly restored from the FTP server.

'''Local'''

This is the local PBX (server) that the backup is stored on. The 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&nbsp;into it so we can back up the database.

'''SSH Server'''

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

APPLICATION 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.

&nbsp;

'''Templates'''

The Templates section shows the templates that have been created and allows you to create or edit templates.

http://wiki.freepbx.org/download/attachments/26509506/templates-list.png

Templates that were included at install cannot be modified. You can create your own templates, but&nbsp;there typically is no need for this unless you need to want to simplify the process of including custom files, directories, or databases in a backup. You can create a template 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&nbsp;'''New Template''' button.

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

http://wiki.freepbx.org/download/attachments/26509506/backup-template-name-desc.png

Click the plus sign button 
http://wiki.freepbx.org/download/attachments/26509506/plus-sign.png 
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.

http://wiki.freepbx.org/download/attachments/26509506/menu-options-template.png



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

http://wiki.freepbx.org/download/attachments/26509506/template-custom-items.png

Click the&nbsp;'''Save''' button when finished.
http://wiki.freepbx.org/download/attachments/26509506/save-button.png

&nbsp;