PHPackages govigilant/joomla-healthchecks - 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. govigilant/joomla-healthchecks ActiveLibrary[Utility & Helpers](/categories/utility) govigilant/joomla-healthchecks ============================== A Joomla plugin that provides a healthcheck endpoint for any site and integrates seamlessly with govigilant.io 1.0.2(4mo ago)00MITPHPPHP ^8.2CI passing Since Dec 26Pushed 4mo agoCompare [ Source](https://github.com/govigilant/joomla-healthchecks)[ Packagist](https://packagist.org/packages/govigilant/joomla-healthchecks)[ Docs](https://govigilant.io)[ RSS](/packages/govigilant-joomla-healthchecks/feed)WikiDiscussions main Synced 1mo ago READMEChangelog (3)Dependencies (3)Versions (4)Used By (0) [ ![Banner](./art/banner.png)](https://github.com/govigilant/vigilant "Vigilant")Vigilant Joomla Healthchecks ============================ [](#vigilant-joomla-healthchecks) [![Tests](https://camo.githubusercontent.com/653fe09ef1176f1d21adbece0689eb212c0878758c291f294b1f309a51e64b9a/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f676f766967696c616e742f6a6f6f6d6c612d6865616c7468636865636b732f74657374732e796d6c3f6c6162656c3d7465737473267374796c653d666c61742d737175617265)](https://github.com/govigilant/joomla-healthchecks) [![Analysis](https://camo.githubusercontent.com/76d88fa346c472aa5d4a4b2984c650e2894ae25d9579c769a89ebdd65f67bb8d/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f676f766967696c616e742f6a6f6f6d6c612d6865616c7468636865636b732f616e616c7973652e796d6c3f6c6162656c3d616e616c79736973267374796c653d666c61742d737175617265)](https://github.com/govigilant/joomla-healthchecks) [![Total downloads](https://camo.githubusercontent.com/6f19ad97da0c94008c68f43743c8a99752c45a7e95a59fc8b62e25e35e1bfbf1/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f676f766967696c616e742f6a6f6f6d6c612d6865616c7468636865636b733f636f6c6f723d626c7565267374796c653d666c61742d737175617265)](https://packagist.org/packages/govigilant/joomla-healthchecks) A Joomla plugin that provides a healthcheck endpoint for any site and integrates seamlessly with [Vigilant](https://github.com/govigilant/vigilant). Features -------- [](#features) - Exposes health information and metrics on `POST /index.php?option=io_govigilant&task=health.check`. - Default checks for Joomla included - Allows registration of custom checks and metrics Installation ------------ [](#installation) Install the package via Composer inside your Joomla project root: ``` composer require govigilant/joomla-healthchecks ``` Copy the plugin files to `plugins/system/vigilanthealthchecks` and enable the **System - Vigilant Healthchecks** plugin in the Joomla administrator. Configuration ------------- [](#configuration) Set a bearer token in the plugin options. Requests must include the header: ``` Authorization: Bearer YOUR_TOKEN ``` Usage ----- [](#usage) Once enabled, the health endpoint is reachable at: ``` POST /index.php?option=io_govigilant&task=health.check ``` Example request: ``` curl -X POST "https://your-site.test/index.php?option=io_govigilant&task=health.check" \ -H "Authorization: Bearer $VIGILANT_HEALTHCHECK_TOKEN" \ -H "Content-Type: application/json" ``` Extending --------- [](#extending) Use the `Vigilant\JoomlaHealthchecks\HealthCheckRegistry` service to register additional checks and metrics. A simple example inside a custom Joomla extension: ``` use Vigilant\HealthChecksBase\Checks\Metrics\DiskUsageMetric; use Vigilant\JoomlaHealthchecks\HealthCheckRegistry; $registry = $container->get(HealthCheckRegistry::class); $registry->registerMetric(DiskUsageMetric::make()); ``` Checks extend `Vigilant\HealthChecksBase\Checks\Check` and metrics extend `Vigilant\HealthChecksBase\Checks\Metric`. Available Checks ---------------- [](#available-checks) CheckDescription**CoreEnvironmentCheck**Checks required PHP extensions, `display_errors`, and pending Joomla core updates.**FilesystemHealthCheck**Validates `configuration.php` permissions, writable directories, installation directory cleanup, and plugin version alignment.**DatabaseHealthCheck**Tests database connectivity, utf8mb4 support, schema alignment with Joomla core, and table integrity.**ExtensionsHealthCheck**Confirms critical plugins are enabled, the debug plugin is disabled, and the default `admin` user is removed.**ConfigurationLanguageCheck**Ensures Joomla's `language` and `metalang` configuration values are set.**SecuritySettingsCheck**Verifies secure settings such as session handler, `force_ssl`, secret length, and admin login notification plugin.**SchedulerHealthCheck**Flags overdue Joomla scheduler tasks whenever the scheduler tables exist.**CacheCheck**Runs a read/write probe against the configured cache store.**DiskSpaceCheck**Monitors available disk space.Available Metrics ----------------- [](#available-metrics) MetricDescription**CpuLoadMetric**Reports the current CPU load average.**MemoryUsageMetric**Reports overall system memory usage.**DiskUsageMetric**Reports disk space utilization percentages.Development Environment ----------------------- [](#development-environment) A ready-to-use Docker Compose setup lives in `devenv/`. Start the stack: `docker compose -f devenv/docker-compose.yml up --build`. This provisions Joomla 5 and Joomla 6, MariaDB, and mounts this package as **System - Vigilant Healthchecks**.The admin credentials are `admin` / `Admin1234!@#` and a default bearer token is set to `testing`. Joomla 5 is reachable on port 8000 and Joomla 6 on port 8001. Stop everything with `docker compose -f devenv/docker-compose.yml down -v` when you're finished. Quality ------- [](#quality) Run the quality checks locally: ``` composer quality ``` Packaging for the Joomla Extension Directory -------------------------------------------- [](#packaging-for-the-joomla-extension-directory) Build an installable ZIP (with production dependencies) via: ``` scripts/package-jed.sh ``` The script assembles the plugin in a temporary directory, runs `composer install --no-dev`, and writes `dist/plg_system_vigilanthealthchecks.zip` for upload to the JED. Security Vulnerabilities ------------------------ [](#security-vulnerabilities) Please review [our security policy](../../security/policy) on how to report security vulnerabilities. Credits ------- [](#credits) - [Vincent Boon](https://github.com/VincentBean) - [All Contributors](../../contributors) License ------- [](#license) The MIT License (MIT). Please see [License File](LICENSE) for more information. ### Health Score 34 — LowBetter than 77% of packages Maintenance75 Regular maintenance activity Popularity0 Limited adoption so far Community6 Small or concentrated contributor base Maturity49 Maturing project, gaining track record 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 Every ~0 days Total 3 Last Release 136d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/f21e3a721fc25c880371c5d3af4925fe83e4b9d425bf50a2cbce18ee1af45931?d=identicon)[vincentbean](/maintainers/vincentbean) --- Top Contributors [![VincentBean](https://avatars.githubusercontent.com/u/3906942?v=4)](https://github.com/VincentBean "VincentBean (8 commits)") --- Tags joomlahealthchecksvigilant ### Code Quality TestsPHPUnit Static AnalysisPHPStan Type Coverage Yes ### Embed Badge ![Health badge](/badges/govigilant-joomla-healthchecks/health.svg) ``` [![Health](https://phpackages.com/badges/govigilant-joomla-healthchecks/health.svg)](https://phpackages.com/packages/govigilant-joomla-healthchecks) ``` ### Alternatives [joomlatools/composer A Composer plugin to install Joomla extensions into your installation. 5332.9k24](/packages/joomlatools-composer) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)