{"id":16798909,"url":"https://github.com/sjelfull/craft-audit","last_synced_at":"2025-08-27T17:05:37.040Z","repository":{"id":57061881,"uuid":"112320342","full_name":"sjelfull/craft-audit","owner":"sjelfull","description":"Audit log for Craft 3","archived":false,"fork":false,"pushed_at":"2024-04-24T12:17:11.000Z","size":2694,"stargazers_count":20,"open_issues_count":33,"forks_count":11,"subscribers_count":3,"default_branch":"v3","last_synced_at":"2024-04-24T16:16:15.099Z","etag":null,"topics":["craft","craft-plugin","craft3","craftcms","craftcms-plugin"],"latest_commit_sha":null,"homepage":"https://superbig.co","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sjelfull.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-11-28T10:21:06.000Z","updated_at":"2024-04-24T12:17:16.000Z","dependencies_parsed_at":"2023-12-30T16:26:39.516Z","dependency_job_id":"164ce9bf-7ed9-44f5-b254-84a975a9b324","html_url":"https://github.com/sjelfull/craft-audit","commit_stats":{"total_commits":117,"total_committers":3,"mean_commits":39.0,"dds":"0.017094017094017144","last_synced_commit":"68f3ce89c2d1177a968883d551a7b921ad0f0d3c"},"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sjelfull%2Fcraft-audit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sjelfull%2Fcraft-audit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sjelfull%2Fcraft-audit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sjelfull%2Fcraft-audit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sjelfull","download_url":"https://codeload.github.com/sjelfull/craft-audit/tar.gz/refs/heads/v3","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249181294,"owners_count":21225878,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["craft","craft-plugin","craft3","craftcms","craftcms-plugin"],"created_at":"2024-10-13T09:27:15.535Z","updated_at":"2025-04-16T01:27:22.029Z","avatar_url":"https://github.com/sjelfull.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Audit plugin for Craft CMS 3.x\n\nAudit log for Craft 4.\n\n![Plugin icon](resources/img/icon.png)\n\n_Note: This plugin costs $99.00 through the [Craft Plugin Store](https://plugins.craftcms.com/audit) when used in production._\n\n## Screenshots\n\n![Screenshot of index view](resources/screenshots/audit-index.png)\n\n![Screenshot of details view](resources/screenshots/audit-details.png)\n\n## Requirements\n\nThis plugin requires Craft CMS 4.0.0 or later.\n\n## Installation\n\nTo install the plugin, follow these instructions.\n\n1. Open your terminal and go to your Craft project:\n\n        cd /path/to/project\n\n2. Then tell Composer to load the plugin:\n\n        composer require superbig/craft-audit\n\n3. In the Control Panel, go to Settings → Plugins and click the “Install” button for Audit.\n\n## Audit Overview\n\nAudit automatically keeps an audit log for actions done by logged in users.\n\n## Configuring Audit\n\n```php\n\u003c?php\nreturn [\n    // How many days to keep log entries around\n    'pruneDays'          =\u003e 30,\n\n    // Enable logging\n    'enabled'            =\u003e true,\n\n    // Toggle specific event types\n    'logElementEvents'            =\u003e true,\n    'logChildElementEvents'       =\u003e false,\n    'logDraftEvents'              =\u003e false,\n    'logPluginEvents'             =\u003e true,\n    'logUserEvents'               =\u003e true,\n    'logRouteEvents'              =\u003e true,\n\n    \n    // Prune old records when a admin is logged in\n    'pruneRecordsOnAdminRequests'          =\u003e false,\n\n    // Enable geolocation status\n    'enabledGeolocation' =\u003e true,\n    'maxmindLicenseKey' =\u003e '',\n    \n    // Where to save Maxmind DB files\n    'dbPath' =\u003e '',\n];\n```\n\n## Using Audit\n\nAs long as the plugin is installed, it will log the following events automatically:\n\n- Creating/saving/deleting elements (including users, Commerce product/variants etc.)\n- Saving global sets\n- Creating/saving/deleting routes\n- Installing/uninstalling and enabling/disabling plugins\n- Login/logout\n\nMore events like Commerce-specific event handling is planned.\n\n### Geolocation\n\nTo enable geolocation lookup with the help of the MaxMind GeoLite2 databases, you first have to generate a license key. \n\nAdd your [MaxMind.com License Key](https://support.maxmind.com/account-faq/license-keys/can-generate-new-license-key/) obtained from the [MaxMind.com account area](https://www.maxmind.com/en/accounts/current/people/current).  \n\n## Clearing old records\n\nYou 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. \n\n## Credits\n\n- [Auditing icon by Ralf Schmitzer](https://thenounproject.com/term/auditing/960985)\n\nBrought to you by [Superbig](https://superbig.co)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsjelfull%2Fcraft-audit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsjelfull%2Fcraft-audit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsjelfull%2Fcraft-audit/lists"}