Installation

Requirements#

• Omeka Classic 2.5 or later. Backup is built and tested on Omeka Classic 3.2.2; it installs on older versions so that an older site can make an archive to move to a newer server.
• PHP 7.4 or later, with the zip extension. The curl extension is needed for sites whose files are in cloud storage and for downloading archives from a link.
• MySQL or MariaDB.
• Omeka's background jobs. Backups, restores and downloads run as Omeka's "long-running" jobs, which start PHP on the command line, so they are not cut short by the web server's time limit. If your server cannot run them, use the command line instead.
• Room for the archives: about as much free space as the site's files take, for each backup you keep.

Installing#

1. Unzip Backup-1.0.0.zip and copy the Backup folder into your Omeka Classic plugins/ folder.
2. Log in to the admin as a Super User and go to Settings > Plugins (the Plugins link at the top of the admin).
3. Click Install next to Backup.

Backups then appears in the admin's main menu, for Super Users only: an archive holds every account, and a restore replaces them, so Admins and other roles cannot see it.

Backup creates two tables, for the list of archives and the history of restores. They are never put in an archive and never replaced by a restore, so each server keeps its own list.

Upgrading#

Deactivate the plugin, replace the plugins/Backup folder with the new version, then click Upgrade (or Activate) on the Plugins page. Archives and the list are kept.

Uninstalling#

Click Uninstall on the Plugins page, then delete the folder. The list of archives and the restore history are removed, but the archives themselves stay in the backup directory (files/backups unless you changed it) or, on a site with cloud storage, under backups/ in the storage: they may be the only copy of the site. Delete them yourself when you no longer need them.