PHPackages                             zaengle/craft-phonehome - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. zaengle/craft-phonehome

ActiveCraft-plugin[Utility & Helpers](/categories/utility)

zaengle/craft-phonehome
=======================

Phone Home plugin for Craft CMS

1.4.0(6mo ago)05.6k↓25%[1 issues](https://github.com/zaengle/craft-phonehome/issues)[5 PRs](https://github.com/zaengle/craft-phonehome/pulls)MITPHPPHP >=8.1CI failing

Since Jul 16Pushed 1w agoCompare

[ Source](https://github.com/zaengle/craft-phonehome)[ Packagist](https://packagist.org/packages/zaengle/craft-phonehome)[ RSS](/packages/zaengle-craft-phonehome/feed)WikiDiscussions develop Synced 2d ago

READMEChangelog (1)Dependencies (12)Versions (22)Used By (0)

Phone Home Plugin for Craft CMS
===============================

[](#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
------------

[](#requirements)

This plugin requires Craft CMS 4.0.0+ or 5.0.0+, and PHP 8.1+.

Quickstart Installation
-----------------------

[](#quickstart-installation)

```
composer require zaengle/craft-phonehome
./craft plugin/install phonehome
```

then in `config/phonehome.php` add:

```
return [
     'token' => getenv('PHONEHOME_TOKEN'), // Your secure token from Zaengle Phone Home service
];
```

Documentation
-------------

[](#documentation)

[See the full documentation online](https://craft-phonehome-docs.zaengle.com/) or in the [`docs/`](./docs/index.md) directory of this repository.

API Schema
----------

[](#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:

```
GET /actions/phonehome/api/schema
X-Auth-Token: your-token-here

```

**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
-------------

[](#configuration)

### Additional Environment Variables

[](#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`:

```
return [
    'token' => getenv('PHONEHOME_TOKEN'),
    'additionalEnvKeys' => [
        'MY_CUSTOM_ENV_VAR',
        'DEPLOYMENT_ID',
        'BUILD_NUMBER',
    ],
];
```

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
-------------

[](#extensibility)

### Custom Status Checks

[](#custom-status-checks)

You can register custom status checks to monitor application-specific health metrics. Status checks are registered via Craft's event system:

```
use yii\base\Event;
use zaengle\phonehome\services\Report;
use zaengle\phonehome\events\RegisterStatusChecksEvent;

Event::on(
    Report::class,
    Report::EVENT_REGISTER_STATUS_CHECKS,
    function(RegisterStatusChecksEvent $event) {
        $event->checks[] = MyCustomStatusCheck::class;
    }
);
```

Your status check class must implement `StatusCheckInterface`:

```
use zaengle\phonehome\statuschecks\StatusCheckInterface;
use zaengle\phonehome\models\StatusCheckResult;
use zaengle\phonehome\enums\StatusCheck;

class MyCustomStatusCheck implements StatusCheckInterface
{
    public static function getName(): string
    {
        return 'My Custom Check';
    }

    public static function getDescription(): string
    {
        return 'Monitors custom application metrics';
    }

    public static function check(): StatusCheckResult
    {
        return new StatusCheckResult([
            'name' => self::getName(),
            'status' => StatusCheck::OK,
            'description' => self::getDescription(),
            'meta' => [
                'custom_metric' => 'value',
            ],
        ]);
    }
}
```

Support
-------

[](#support)

For support, visit the [GitHub repository](https://github.com/zaengle/craft-phonehome).

Development
-----------

[](#development)

See the [development guide](./DEVELOPMENT.md) for details on how to contribute to this project.

###  Health Score

46

—

FairBetter than 92% of packages

Maintenance85

Actively maintained with recent releases

Popularity23

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity55

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 68.5% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~15 days

Recently: every ~36 days

Total

12

Last Release

180d ago

PHP version history (2 changes)1.0.0PHP >=8.0.2

1.1.0PHP >=8.1

### Community

Maintainers

![](https://www.gravatar.com/avatar/1ffae66f8a3c9ea283079e6e74e520b39fd68a00dab4485aee819a69c0f3fa25?d=identicon)[jesseschutt](/maintainers/jesseschutt)

![](https://www.gravatar.com/avatar/469bfbd3e1b1b6b42d65bf3fba4e6c7a0c0113188d7efc17411800d5686f5655?d=identicon)[tomdavies](/maintainers/tomdavies)

---

Top Contributors

[![tomdavies](https://avatars.githubusercontent.com/u/136308?v=4)](https://github.com/tomdavies "tomdavies (37 commits)")[![jesseschutt](https://avatars.githubusercontent.com/u/353047?v=4)](https://github.com/jesseschutt "jesseschutt (16 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (1 commits)")

---

Tags

cmsCraftcraftcmscraft-plugin

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/zaengle-craft-phonehome/health.svg)

```
[![Health](https://phpackages.com/badges/zaengle-craft-phonehome/health.svg)](https://phpackages.com/packages/zaengle-craft-phonehome)
```

###  Alternatives

[verbb/formie

The most user-friendly forms plugin for Craft.

102393.6k70](/packages/verbb-formie)[verbb/comments

Add comments to your site.

13753.9k](/packages/verbb-comments)[verbb/navigation

Create navigation menus for your site.

92705.0k18](/packages/verbb-navigation)[verbb/vizy

A flexible visual editor field for Craft.

4250.4k](/packages/verbb-vizy)[verbb/hyper

A user-friendly links field for Craft.

24147.8k12](/packages/verbb-hyper)[verbb/workflow

Enforce multi-step review processes for creating entries.

138124.2k1](/packages/verbb-workflow)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)