porro / craft-connector

v0.1.2 2026-10-20 14:46 UTC

Requires

• php: ^8.2
• craftcms/cms: ^4.0|^5.0
• porro/php-core: ^0.1.2

Requires (Dev)

• laravel/pint: ^1.18
• pestphp/pest: ^3.0|^4.0

MIT

• security
• monitoring
• Craft
• craftcms
• porro

Published on Packagist.org on 2026-10-20 14:46 UTC

README

Read-only Porro connector for Craft CMS 4–5. It sends one signed report about your site to Porro every 15 minutes. It never changes the site and never accepts commands: Porro never connects in.

Install

composer require porro/craft-connector
php craft plugin/install porro
php craft porro/connect <site key>

Copy the site key from the site's page in Porro. porro/connect saves PORRO_KEY to .env and sends the first report.

Reports then go every 15 minutes from cron. porro/connect offers to add the line to the server's crontab for you, with the right PHP binary and project folder, and never adds it twice. If it can't, it prints the line to paste into Forge, Ploi or crontab -e:

*/15 * * * * cd /path/to/site && php craft porro/report --scheduled > /dev/null 2>&1

Use --cron to add it without asking (handy in provisioning scripts) or --no-cron to leave the crontab alone. Skipped it, or connected from another machine? Run php craft porro/cron on the server; it needs no key. Add php craft porro/report to your deploy script so Porro hears about deploys straight away.

What leaves a site

• Craft version, edition and environment name
• Installed plugins and their versions, and package versions from composer.lock (the list is only sent when the lock file changes)
• Whether dev mode is on, as true or false
• Pending migrations, and Craft's queue: whether it runs automatically, jobs waiting, failed jobs, and how long the oldest job has waited
• When cron last ran

What never does

Content, entries, assets, users, settings values or secrets. Run php craft porro/status --json to see the exact report your site would send.

Commands

Command	Does
porro/connect <key>	Saves the key, sends the first report and sets up cron (--cron, --no-cron, --url)
porro/cron	Adds the cron line on its own, no key needed
porro/report	Sends a report now (--packages forces the package list)
porro/status	Shows what the next report contains (--json for the raw report)

Config

Env	Default
PORRO_KEY		The site key
PORRO_ENABLED	true	Turn reporting off, e.g. on staging

Developing

The tests drive a real Craft install with the plugin installed:

composer install
CRAFT_PATH=/path/to/craft-site composer test

CI builds fresh Craft 4 and Craft 5 sites on Postgres for every push.

Security

Please email [e-mail] rather than opening an issue. We reply within one working day.

License

MIT