Boru Automated Backup User Guide

[accordions]
[accordion title=”Boru Automated Backup Settings”]

• Go to “Settings” > “Boru Automated Backup”.
• This displays the main control panel for the module.
• At the top you may choose to perform Local, Offsite, or both types of backups.

[/accordion]
[accordion title=”Local Backup Settings”]

• This allows you to write a compressed copy of your vTiger build to a folder on the server.
• Test Write Access
  • This button is used to make sure the chosen folder exists and is writable. It attempts to write a tiny file to the directory and then remove it.
• Frequency of local file/db backups
  • This can be daily, weekly, monthly or quarterly. Quarterly backups are done in Jan, Apr, Jul and Oct.
• Number of backups to retain
  • The module will maintain a rolling history of this many iterations of backups. The oldest will be trimmed to make room for the newest.
• Full path to backup folder
  • This is the location where you wish to store your backup files on the local server. 
    • An absolute path (beginning with /) or a relative path can be used.
    • Relative paths (any path not beginning with a /) will be appended to the root of your vTiger build. Example: Setting it to ‘myvtigerbackups’ would write to your vtiger root under a new folder with that name, whereas ‘/home/myvtigerbackups’ would write files to /home/myvtigerbackups.

[/accordion]
[accordion title=”Offsite Backup Settings”]

• This allows you to transfer a backup to a remote server via FTP or SFTP. 
• Test Connection
  • This button will attempt to use the connection settings to write a small file to the remote server into the “Offsite folder”. 
• Number of backups to retain
  • The module will maintain a rolling record this many iterations of backups. The oldest will be trimmed to make room for the newest.
• Protocol
  • You may select from FTP or SFTP protocols. SFTP uses SSH to transfer the files securely.
• Server and port
  • You must enter a server name or IP here. If your server uses a non-standard port you may set that here also.
• Offsite folder
  • The module will transfer the backup into this folder, and attempt to create it if it does not exist.
• Username and Password
  • Log in credentials for the offsite server.

[/accordion]
[accordion title=”Global Backup Settings”]

• Email address
  • Notifications will be sent to this address every time a backup is created. A weekly summary of backup activity will also be emailed every Monday.
• View Backup History
  • This shows you records of past backups.
• View Error Log
  • This is a listing of activities in more detail so you may help debug any issues.
• Perform backup at
  • This is the hour of the day to perform your backups. 
• Perform weekly backups on
  • Any backups scheduled for ‘Weekly’ will be run on this day of the week.
• Perform monthly backups on day X of the month
  • Any backups scheduled for ‘Monthly’ will run on this day of the month.
• Perform quarterly backups on day X of Jan, Apr, Jul, Oct
  • Any backups scheduled for ‘Quarterly’ will run on this day of the months shown.
    

[/accordion]
[/accordions]