Backup Tools

Your installation of Squore includes some scripts designed to help save and restore snapshots of your analysis data. These scripts will allow you to:

The scripts are located in the <SQUORE_HOME>/bin folder of the Squore installation directory.

The Windows and Linux backup scripts accept a parameter that is used as the path to store the backup file. This makes it possible to use a scheduled task on Windows or a cron job on Linux to automate your backups. If you do not specify this parameter, the default backup folder will be used and each new backup will replace the previous one.

Warning

  • Before launching a backup or restore operation, stop Squore Server completely and ensure that the Squore Database is started.

  • Backups can be launched while the server is running, but it is recommended to regularly perform a backup while the server is stopped. This guarantees that the database and the data files are in sync, which may not be the case if your server is started and analyses are running.

  • If your database is not running on the same machine as Squore Server, the backup will only include the Squore Server data files. When running in this configuration, you need to perform database backup and restore operations manually.

Backing-Up the Squore Data

The contents of the Squore Database and file system can be saved using the backup script from the <SQUORE_HOME>/bin folder.

There are several ways to create a backup:

  • By running <SQUORE_HOME>/bin\backup.bat [%BACKUP_FOLDER%] on Windows

  • By launching Start > Squoring > Squore > Admin > Backup Data on Windows

  • By running <SQUORE_HOME>/bin/backup [$BACKUP_FOLDER] on Linux

Executing this script creates a folder with a compressed database dump and a backup of the projects folder in the location configured in <SQUORE_HOME>/config.xml, or the backup folder specified on the command line. This backup can later be used by a script that restores database and file system snapshots, which we will cover in the next section.

Restoring Squore Data

A previously backed-up Squore snapshot can be restored using the restore script from the <SQUORE_HOME>/bin folder.

There are several ways to restore data:

  • By running <SQUORE_HOME>/bin\restore.bat [%BACKUP_FOLDER%] on Windows

  • By launching Start > Squoring > Squore > Admin > Restore Saved Data on Windows

  • By running <SQUORE_HOME>/bin/restore [$BACKUP_FOLDER] on Linux

The script uses the data dump in the backup folder specified in your <SQUORE_HOME>/config.xml or the backup folder specified on the command line to restore the database and file data for this snapshot.