Getting Started

Installation

Requirements

  • Omeka S 3.x or 4.x
  • PHP 8.1 or later with the zip extension (ZipArchive) enabled
  • MySQL or MariaDB, as used by Omeka S
  • A directory the web server user can write to, for storing backup archives
  • At least 100 MB of free space in the backup directory. The module refuses to start a backup below that.
  • Enough free space in the system temporary directory to hold an uncompressed copy of everything being backed up or restored. Archives are assembled there before being zipped, and unpacked there before a restore.

No external programs are needed. Database dumps and restores run through PHP and Omeka's own database connection, so mysqldump and mysql do not have to be installed or on the web server's PATH.

Only the local file store is backed up. If Omeka is configured to keep files in a remote store such as S3, those files are not included in the archive.

Installing

  1. Copy the Backup folder into your Omeka S modules/ directory, so that modules/Backup/Module.php exists.
  2. Log in to the Omeka S admin panel as a Global Administrator.
  3. Go to Admin > Modules and click Install next to Backup.

Installation creates one database table, omeka_backup, which records each archive's filename, path, size, checksum, status and creator.

After installing, a Backup link appears in the admin sidebar. It opens the backup list at /admin/backup. See Configuration to set the storage path before your first backup.

Upgrading

  1. Copy the new version over the existing modules/Backup folder.
  2. Go to Admin > Modules. If the module shows Upgrade available, click Upgrade.

No database changes are made during an upgrade. Existing backup records and archives are kept.

Uninstalling

Uninstalling from Admin > Modules does the following:

  • Drops the omeka_backup table, which removes all backup records from the list.
  • Deletes the module's settings (backup_path and backup_keep_last_n) from Omeka's settings table.

It does not delete anything from the backup directory. The ZIP archives, backup.log, the blank index.html and the .backup.lock file stay on disk until you remove them yourself. If you reinstall the module later, the archives appear on the Backups page under Archives in the backup directory, where Add to backups lists them again. See Adding Archives by FTP.

If the module cannot be uninstalled from the admin panel, drop the table manually and remove the module directory:

DROP TABLE IF EXISTS omeka_backup;
Log in for Support