Audit log for Craft 3
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
resources
src
.craftplugin
.gitignore
.scrutinizer.yml
CHANGELOG.md
LICENSE.md
README.md
composer.json
icon.sketch

README.md

Audit plugin for Craft CMS 3.x

Audit log for Craft 3.

Plugin icon

Note: This plugin will cost $99.00 once Craft 3 GA is released.

Screenshots

Screenshot of index view

Screenshot of details view

Requirements

This plugin requires Craft CMS 3.0.0-beta.23 or later.

Installation

To install the plugin, follow these instructions.

  1. Open your terminal and go to your Craft project:

     cd /path/to/project
    
  2. Then tell Composer to load the plugin:

     composer require superbig/craft-audit
    
  3. In the Control Panel, go to Settings → Plugins and click the “Install” button for Audit.

Audit Overview

Audit automatically keeps a audit log for actions done by logged in users.

Configuring Audit

<?php
return [
    // How many days to keep log entries around
    'pruneDays'          => 30,

    // Enable logging
    'enabled'            => true,

    // Enable geolocation status
    'enabledGeolocation' => true,
];

Using Audit

As long as the plugin is installed, it will log the following events automatically:

  • Creating/saving/deleting elements (including users, Commerce product/variants etc.)
  • Creating/saving/deleting routes
  • Installing/uninstalling and enabling/disabling plugins
  • Login/logout

More events like Commerce-specific event handling is planned.

Credits

Brought to you by Superbig