Installation

Requirements#

• Omeka S 3.x or 4.x
• PHP 8.1 or later
• MySQL or MariaDB (any version supported by Omeka S)

The module has no external dependencies and loads no CDN assets. Batch rollback and pruning run as Omeka S background jobs, so the PHP CLI path in your Omeka S configuration must work for those two features. Single restores run immediately in the request.

Installing#

1. Copy the ResourceVersioning folder into your Omeka S modules/ directory.
2. Log in to the Omeka S admin panel as a Global Administrator.
3. Go to Admin > Modules and click Install next to ResourceVersioning.

Installation creates one database table, resource_version, and writes the default settings listed in Configuration. Existing resources are not touched: the first time one of them is edited, its pre-edit state is captured automatically as a baseline version.

After installing:

• A Version History tab appears on every admin item, media, and item set show page.
• A Resource Versions link appears in the admin sidebar under Modules, pointing at /admin/resource-versioning.
• Capture is on for items, media, and item sets. Nothing else needs to be configured.

Upgrading#

Copy the new version over the existing modules/ResourceVersioning folder, then visit Admin > Modules. If the module shows an upgrade available, click Upgrade. Stored versions are kept across upgrades.

Uninstalling#

Go to Admin > Modules and click Uninstall next to ResourceVersioning. Uninstalling:

• drops the resource_version table, which permanently deletes all stored version history, and
• removes the six resource_versioning_* settings from the global settings table.

Items, media, and item sets themselves are not affected. Restores that were already applied stay applied, because a restore is an ordinary API update of the live resource.

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

DROP TABLE IF EXISTS resource_version;