2017 © Pedro Peláez
 

craft-plugin 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.

image

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.

  • Wednesday, October 26, 2016
  • by benjamin-smith
  • Repository
  • 0 Watchers
  • 3 Stars
  • 32 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 1 Forks
  • 1 Open issues
  • 2 Versions
  • 3 % Grown

The README.md

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., (*1)

DEPRECATED

This plugin is for Craft CMS v2, which is no longer supported. See https://craftcms.com/knowledge-base/supported-versions, (*2)

Installation

To install, follow these steps:, (*3)

1) Install with Composer (recommended), (*4)

composer require benjamin-smith/craft-healthcheck

-OR- download & unzip the codebase and place the healthcheck directory into your craft/plugins directory, (*5)

2) Install plugin in the Craft Control Panel under Settings > Plugins, (*6)

Configuration

The default configuration file explains the various options that are available, and uses sensible defaults that do not necessarily require modification., (*7)

To customize the config, copy that file to craft/config/healthcheck.php and modify as needed., (*8)

Usage

Once installed and configured, your health check URL should be responding to requests as expected (the default url is http://mydomain.com/health-check). 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., (*9)

Roadmap

  • Allow for whitelisting IP ranges using CIDR block notation.

The Versions

26/10 2016

dev-master

9999999-dev

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

  Sources   Download

MIT

The Requires

 

26/10 2016

v1.0.0

1.0.0.0

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

  Sources   Download

The Requires