Download the PHP package zaengle/craft-phonehome without Composer
On this page you can find all versions of the php package zaengle/craft-phonehome. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download zaengle/craft-phonehome
More information about zaengle/craft-phonehome
Files in zaengle/craft-phonehome
Package craft-phonehome
Short Description Phone Home plugin for Craft CMS
License MIT
Informations about the package craft-phonehome
Phone Home Plugin for Craft CMS
Monitor the status of your #CraftCMS projects remotely
Phonehome a secure API endpoint that returns comprehensive information about a Craft CMS installation and the server environment it is installed in.
Requirements
This plugin requires Craft CMS 4.0.0+ or 5.0.0+, and PHP 8.1+.
Quickstart Installation
then in config/phonehome.php add:
Documentation
See the full documentation online or in the docs/ directory of this repository.
API Schema
The plugin provides a JSON schema that defines the structure of the API response. The schema is located at src/schemas/PhonehomeApi.schema.json and follows semantic versioning.
You can retrieve the schema via the API endpoint:
Important for contributors: When modifying the API response structure in Report::getInfo(), you must update the schema file accordingly and bump the schema version following semantic versioning rules. See CLAUDE.md for detailed schema maintenance guidelines.
Configuration
Additional Environment Variables
You can configure the plugin to include additional environment variables in the API response by setting additionalEnvKeys in your config/phonehome.php:
These values will be included in the meta section of the API response, making it easy to include deployment-specific information alongside the standard system metrics.
Extensibility
Custom Status Checks
You can register custom status checks to monitor application-specific health metrics. Status checks are registered via Craft's event system:
Your status check class must implement StatusCheckInterface:
Support
For support, visit the GitHub repository.
Development
See the development guide for details on how to contribute to this project.