TypeKey Logo TypeKey Academy
Back to Support Center
DOCUMENTATION

Backup & Restore Guide

A complete step-by-step manual to secure and recover your school's data effectively.

1. Cloud Backup

How it works Your database is automatically backed up to our secure cloud servers every Friday. No manual intervention is required for this backup process. The system securely retains your most recent 8 cloud backups.

2. Restoring a Cloud Backup

Important Warning Before restoring, ensure that no teachers or students are connected to the server. All users must save their work and disconnect, as there should be no communication with the server during the restore process.
  1. Navigate to the Restore Page
    From your main Dashboard, click on the Restore option to open the restoration page.
  2. View Cloud Backups
    In the Cloud Backups section, you will see a list of all successful automated backups. You can click the Refresh button to ensure the list is up-to-date.
  3. Initiate Restore
    Find the desired backup date in the list and click the Restore button next to it.
  4. Confirm and Restart
    A confirmation prompt will appear warning you that current data will be overwritten. Confirm the action. Once the restore is successful, the server will automatically restart with the restored data.

3. Taking a Local Backup

Create an immediate, offline copy of your database to a secure folder on your local computer or an external USB drive.

  1. Navigate to the Backup Page
    From your main Dashboard, click on the Backup option.
  2. Trigger Manual Backup
    Scroll down to the Manual Local Backup section and click the Take Local Backup button.
  3. Save the File
    The system will open a file dialog asking you to choose a location to save your database backup. Once you select the location, the backup file (ending in .db) will be created there and a success message will appear.

4. Restoring a Local Backup

Important Warning Before restoring, ensure that no teachers or students are connected to the server. All users must save their work and disconnect, as there should be no communication with the server during the restore process.

If you need to revert to a manual backup or restore data while offline, you can upload your locally saved database file.

  1. Navigate to the Restore Page
    From your Dashboard, access the Restore page.
  2. Select Local File
    Under the Manual Local Restore section, click the Select Local File button.
  3. Choose the Backup File
    A file explorer window will open. Browse to the location where you saved your local backup file (must be a .db or .gz file) and select it.
  4. Complete Restoration
    The system will validate the file, replace the current database safely, and prompt a success message. The server will restart automatically to apply the changes.