Package Exports
- payload-auditor
- payload-auditor/client
- payload-auditor/rsc
Readme
📦 Payload Auditor
Payload Auditor is a powerful plugin for Payload CMS that provides centralized event tracking, auditing, and security enhancements. This tool is designed for developers and teams looking to monitor critical actions, analyze user behaviors, and enhance backend security within their Payload projects.
⚙️ Installation & Usage
Install with your preferred package manager:
npm install payload-auditor
# or
pnpm add payload-auditor
# or
yarn add payload-auditor
Then, register the plugin in your Payload config:
import { auditorPlugin } from 'payload-auditor'
export default buildConfig({
plugins: [
auditorPlugin({
// your plugin config here
}),
],
})
🔧 Plugin Options
Customize the plugin with the following configuration:
auditorPlugin({
autoDeleteInterval: '1d',
collection: {
trackCollections: [
{
slug: 'media',
hooks: {
afterChange: {
update: {
enabled: true,
},
},
},
},
],
},
}),
🧠 When Should You Use It?
You need to track critical collection changes (e.g., user logins, updates)
You want additional backend security for your Payload project
You work in a multi-user admin environment with role-specific needs
You're building a SaaS or enterprise-grade Payload-based product