Installation

Requirements#

• Omeka S 3.x or 4.x
• PHP 8.1 or later
• MySQL 5.7+ or MariaDB 10.2+ (the audit table uses a JSON column)

The module has no external dependencies.

Installing#

1. Copy the AuditTrail 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 AuditTrail.

Installation creates one database table, audit_trail, and writes the default settings (logging enabled, 50 entries per page, 365-day retention, IP redaction off, the default set of resource types). See Configuration for the full list.

Logging starts immediately. An Audit Trail entry appears in the admin sidebar for site administrators and global administrators, and a Recent Activity panel appears at the bottom of the admin dashboard.

Upgrading#

Copy the new version over the existing modules/AuditTrail folder, then visit Admin > Modules. If the module shows Upgrade available, click Upgrade. Existing log entries and settings are kept.

Uninstalling#

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

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

DROP TABLE IF EXISTS audit_trail;