Installation

LesliAudit adds account and user activity history to a Lesli application. It requires Ruby 3.x, Rails ~> 8.1, and Lesli ~> 5.1.0, and stores its records in the host database.

Install the Engine

bundle add lesli_audit

The standard Lesli router mounts it at /audit:

Rails.application.routes.draw do
  Lesli::Router.mount(self)
end

Mount it directly only when the host does not use the standard router:

Rails.application.routes.draw do
  mount LesliAudit::Engine => "/audit"
end

Prepare migrations and initialize existing accounts:

bin/rails lesli:db:prepare

LesliAudit uses device_detector to classify the user agent for successful logins. Ordinary request logging does not capture device information. No additional initializer is required for the default integration. Request counters and journals are written synchronously. Schedule LesliAudit::RetentionCleanupJob once per day after selecting the appropriate retention periods for the host application.

Review the configuration reference before enabling production retention. LesliShield and LesliDashboard are optional; Shield supplies an opaque session reference when available, while Dashboard can render the registered Audit component.

Upgrade

After updating the gem, run the standard preparation task. It loads new engine migrations and initializes missing engine accounts without replacing existing Audit data:

bundle update lesli_audit
bin/rails lesli:db:prepare
bin/rails db:migrate:status

Verify the Installation

bin/rails routes -g audit
bin/rails server

Visit http://127.0.0.1:3000/audit. Install LesliDashboard and run bin/rails lesli_dashboard:register when the Audit dashboard component should be available to existing accounts.

See Activity Events, Tasks, Dashboards, Translations, Database, and Frontend for integration details.