Settings are global. Open them from Admin > Modules, then click Configure next to AuditTrail, or use the Settings button at the top of the Audit Trail page. The direct URL is /admin/module/configure?id=AuditTrail.
Settings
| Setting | Default | Description |
|---|---|---|
| Enable audit trail | On | Master switch. When off, no new entries are written, the dashboard widget and user history panel are hidden, and the CLI purge script skips its run unless --days is given. Existing entries are kept and the log page stays available. |
| Retention period (days, 0 = keep forever) | 365 | Entries older than this many days are deleted when a purge runs. Purges are not scheduled automatically; see Purging Old Entries. Set to 0 to disable purging. |
| Redact IP addresses (store partial address only) | Off | When on, the last octet of an IPv4 address is replaced with 0 (203.0.113.42 becomes 203.0.113.0) and only the first three groups of an IPv6 address are kept, followed by :****. Applies to entries written after the setting is saved; existing entries are not changed. |
| Entries per page (list view) | 50 | Rows per page on the Audit Trail page and in the per-user Audit History panel. Must be at least 1. |
| Events to log | Items, Media, Item sets, Users, Sites, Site pages, Vocabularies, Resource templates, Assets, User logins, User logouts | Resource types whose create, update and delete operations are recorded. Properties and Resource classes are available but off by default. |
Note that User logins and User logouts are always recorded while the module is enabled, whether or not their boxes are checked. Unchecking every box records logins and logouts only.
Permissions
Access is based on the user's Omeka S role. Roles below site administrator do not see the Audit Trail sidebar entry and receive a permission error at /admin/audit.
| Role | View log and entry details | Export CSV/JSON | Run retention purge |
|---|---|---|---|
| Researcher | — | — | — |
| Author | — | — | — |
| Reviewer | — | — | — |
| Editor | — | — | — |
| Site Admin | ✓ | ✓ | — |
| Global Admin | ✓ | ✓ | ✓ |
The Audit History panel on a user's admin page and the Recent Activity dashboard widget follow the same rule as the pages they appear on: anyone who can open the user page or the dashboard sees them.
What is recorded for each entry
| Field | Content |
|---|---|
| Timestamp | Server time when the action completed |
| Actor | The logged-in user's name (or email if the name is empty) and user ID |
| Action | <type>.<operation>, for example item.create, media.update, site_page.delete, user.login |
| Resource | Type, ID, a label (title, name or filename) and a link to the resource in the admin |
| IP address | Taken from the X-Forwarded-For header when present, otherwise the direct client address; redacted if the option is on |
| User agent | The browser's user agent string, up to 1,000 characters |
| Extra data | For API events, the raw operation and API resource name (items, site_pages, and so on) |
See Logged Events for the complete list of actions and resource types.