README

Craft website healthcheck made easy

Requirements

This plugin requires Craft CMS 5.2.0 or later, and PHP 8.2 or later.

Installation

You can install this plugin from the Plugin Store or with Composer.

From the Plugin Store

Go to the Plugin Store in your project’s Control Panel and search for “Craft Health Check”. Then press “Install”.

With Composer

Open your terminal and run the following commands:

# go to the project directory
cd /path/to/my-project.test

# tell Composer to load the plugin
composer require mischasolaris/craft-health-check

# tell Craft to install the plugin
./craft plugin/install craft-health-check

Usage

The health check is configured to require a secret password, which can be set in the control panel. As a simple demo, you can use this form to get the JSON response of the health check tests:

            <form method="post">
                {{ csrfInput() }}
                {{ actionInput('craft-health-check/health/check-results') }}

                <label for="loginName">Username or email</label>
                {{ input('text', 'craft-health-check-secret', null, {
                    id: 'secretCode',
                }) }}

                <button>Check</button>
            </form>

mischasolaris / craft-health-check

Maintainers