superbig / craft-audit
记录元素的添加/更新/删除操作
3.0.3
2024-01-31 17:30 UTC
Requires
- php: ^8.0.2
- craftcms/cms: ^4.0.0
- donatj/phpuseragentparser: ^1.7.0
- geoip2/geoip2: ^2.5
README
Craft 4的审计日志
注意:在生产环境中使用时,此插件通过Craft Plugin Store售价为99.00美元。
截图
要求
此插件需要Craft CMS 4.0.0或更高版本。
安装
要安装此插件,请按照以下说明操作。
-
打开您的终端并转到您的Craft项目
cd /path/to/project
-
然后让Composer加载插件
composer require superbig/craft-audit
-
在控制面板中,转到设置→插件,并点击Audit的“安装”按钮。
Audit概述
Audit会自动记录登录用户执行的操作。
配置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' => '', ];
使用Audit
只要插件已安装,它将自动记录以下事件
- 创建/保存/删除元素(包括用户、Commerce产品/变体等)
- 保存全局设置
- 创建/保存/删除路由
- 安装/卸载以及启用/禁用插件
- 登录/登出
计划增加更多事件,如Commerce特定的事件处理。
地理位置
要启用使用MaxMind GeoLite2数据库的地理位置查找,您首先必须生成一个许可证密钥。
添加从MaxMind.com获取的MaxMind.com许可证密钥。
清除旧记录
您可以使用控制台命令./craft audit/default/prune-logs
或通过Audit索引屏幕上的按钮来清除超过n
天(由pruneDays
设置配置)的记录。
鸣谢
由Superbig提供