Giter Club home page Giter Club logo

craft-audit's Introduction

Audit plugin for Craft CMS 3.x

Audit log for Craft 3.

Plugin icon

Note: This plugin costs $99.00 through the Craft Plugin Store when used in production.

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 an 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,

    // Toggle specific event types
    'logElementEvents'            => true,
    'logChildElementEvents'       => false,
    'logDraftEvents'              => false,
    'logPluginEvents'             => true,
    'logUserEvents'               => true,
    'logRouteEvents'              => true,

    
    // Prune old records when a admin is logged in
    'pruneRecordsOnAdminRequests'          => false,

    // Enable geolocation status
    'enabledGeolocation' => true,
    'maxmindLicenseKey' => '',
    
    // Where to save Maxmind DB files
    'dbPath' => '',
];

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.)
  • Saving global sets
  • Creating/saving/deleting routes
  • Installing/uninstalling and enabling/disabling plugins
  • Login/logout

More events like Commerce-specific event handling is planned.

Geolocation

To enable geolocation lookup with the help of the MaxMind GeoLite2 databases, you first have to generate a license key.

Add your MaxMind.com License Key obtained from the MaxMind.com account area.

Clearing old records

You can prune records older than n days (configured by the pruneDays setting) either by using the console command ./craft audit/default/prune-logs or by a button on the Audit index screen.

Credits

Brought to you by Superbig

craft-audit's People

Contributors

aj-adl avatar johnfmorton avatar mofman avatar sjelfull avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.