PHPackages                             benjamin-smith/craft-healthcheck - 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. benjamin-smith/craft-healthcheck

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

benjamin-smith/craft-healthcheck
================================

Adds a health check route to your site to indicate that Craft is health and ready to accept web traffic from a load balancer.

v1.0.0(9y ago)4962[1 issues](https://github.com/benjamin-smith/craft-healthcheck/issues)PHP

Since Oct 26Pushed 2y agoCompare

[ Source](https://github.com/benjamin-smith/craft-healthcheck)[ Packagist](https://packagist.org/packages/benjamin-smith/craft-healthcheck)[ RSS](/packages/benjamin-smith-craft-healthcheck/feed)WikiDiscussions master Synced 4w ago

READMEChangelogDependencies (1)Versions (2)Used By (0)

Health Check plugin for Craft CMS v2
====================================

[](#health-check-plugin-for-craft-cms-v2)

Adds a health check route to your site to indicate that Craft is healthy and ready to accept web traffic from a load balancer.

### DEPRECATED

[](#deprecated)

*This plugin is for Craft CMS v2, which is no longer supported. See *

Installation
------------

[](#installation)

To install, follow these steps:

1. Install with Composer (recommended)

```
composer require benjamin-smith/craft-healthcheck

```

-OR- [download](https://github.com/benjamin-smith/craft-healthcheck/archive/master.zip) & unzip the codebase and place the `healthcheck` directory into your `craft/plugins` directory

2. Install plugin in the Craft Control Panel under Settings > Plugins

Configuration
-------------

[](#configuration)

The [default configuration file](https://github.com/benjamin-smith/craftcms-healthcheck/blob/master/config.php) explains the various options that are available, and uses sensible defaults that do not necessarily require modification.

To customize the config, copy that file to `craft/config/healthcheck.php` and modify as needed.

Usage
-----

[](#usage)

Once installed and configured, your health check URL should be responding to requests as expected (the default url is ). If the site goes offline for any reason, a non 200 HTTP status code should be returned, which your load balancer should take as a signal to remove this site/server from the load balancer rotation.

Roadmap
-------

[](#roadmap)

- Allow for whitelisting IP ranges using CIDR block notation.

###  Health Score

28

—

LowBetter than 52% of packages

Maintenance15

Infrequent updates — may be unmaintained

Popularity15

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity63

Established project with proven stability

 Bus Factor1

Top contributor holds 100% 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

Unknown

Total

1

Last Release

3534d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/87b5c3edc9db528238b82272681dcb2051a32fc783e0354408b339bf389bed7d?d=identicon)[benjamin-smith](/maintainers/benjamin-smith)

---

Top Contributors

[![benjamin-smith](https://avatars.githubusercontent.com/u/1483102?v=4)](https://github.com/benjamin-smith "benjamin-smith (5 commits)")

### Embed Badge

![Health badge](/badges/benjamin-smith-craft-healthcheck/health.svg)

```
[![Health](https://phpackages.com/badges/benjamin-smith-craft-healthcheck/health.svg)](https://phpackages.com/packages/benjamin-smith-craft-healthcheck)
```

###  Alternatives

[helsingborg-stad/municipio

A bootstrap theme for creating municipality sites.

4028.3k10](/packages/helsingborg-stad-municipio)[mautic/core

Mautic Open Source Distribution

9.8k2.6k9](/packages/mautic-core)[mediawiki/maps

Adds various mapping features to MediaWiki

78149.7k3](/packages/mediawiki-maps)[rainlab/blog-plugin

Blog plugin for October CMS

17158.6k](/packages/rainlab-blog-plugin)[civicrm/civicrm-drupal-8

Open source constituent relationship management for non-profits, NGOs and advocacy organizations.

19246.3k2](/packages/civicrm-civicrm-drupal-8)[starcitizentools/citizen-skin

A beautiful, usable, responsive MediaWiki skin with in-depth extension support. Originally developed for the Star Citizen Wiki.

3355.8k](/packages/starcitizentools-citizen-skin)

PHPackages © 2026

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