Getting Started Omeka Classic plugin

Installation

Requirements

  • Omeka Classic 3.1 or later. Audit Trail is built and tested on 3.2.2.
  • PHP 8.1 or later.
  • MySQL or MariaDB (any version Omeka Classic supports: the log keeps its data as plain text, with no JSON column type).
  • Optional: Omeka's background jobs, for the Run purge now button. They need the path to PHP's command-line program in application/config/config.ini (background.php.path), which most hosts set. Purging also works from the command line and, if you turn it on, by itself once a day.
  • Optional: Simple Pages and Exhibit Builder, whose pages and exhibits are logged when they are installed.

The plugin has no other dependencies.

Installing

  1. Unzip AuditTrail-1.0.0.zip and copy the AuditTrail folder into your Omeka Classic plugins/ folder.
  2. Log in to the admin as a Super User and click Plugins at the top of the page.
  3. Click Install next to Audit Trail.

Installing creates one table, audit_trail (with your database prefix, for example omeka_audit_trail), and saves the default settings: logging on, 50 entries per page, 365-day retention, no automatic purge, IP redaction off, the log for Super Users only, and every kind of event. See Configuration.

Logging starts at once; the first entry is the plugin's own installation. Audit Trail appears in the admin menu for Super Users, a Recent Activity panel appears at the bottom of the dashboard, and each user page gets an Activity tab.

Upgrading

Deactivate the plugin, replace the plugins/AuditTrail folder with the new version, then click Upgrade on the Plugins page. Existing entries and settings are kept, and the upgrade is logged.

Deactivating

A deactivated plugin records nothing: Omeka Classic does not load it. Its deactivation is the last entry it writes (even when plugin events are not being logged). Its reactivation cannot be logged, since the plugin is off at that moment, but the next events are.

Uninstalling

Uninstalling drops the audit_trail table, which permanently deletes every entry, and removes the plugin's settings. Export the log first if you need to keep it (see Exporting the Log).

If the plugin cannot be uninstalled from the admin, drop the table by hand and remove the folder:

DROP TABLE IF EXISTS omeka_audit_trail;

(with your own table prefix in place of omeka_).

Log in for Support