PHPackages                             shel/neos-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. shel/neos-healthcheck

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

shel/neos-healthcheck
=====================

Rest endpoint to check the health and customisable metrics of a Neos CMS instance

1.1.0(11mo ago)3724↓50%MITPHPPHP ^8.1

Since May 13Pushed 11mo ago1 watchersCompare

[ Source](https://github.com/Sebobo/Shel.Neos.HealthCheck)[ Packagist](https://packagist.org/packages/shel/neos-healthcheck)[ RSS](/packages/shel-neos-healthcheck/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (2)Dependencies (1)Versions (5)Used By (0)

Healthcheck endpoint for Neos CMS
=================================

[](#healthcheck-endpoint-for-neos-cms)

This package provides a healthcheck endpoint for Neos CMS and a UI integration for the Neos backend.

This should help with monitoring and checking the health of your Neos installations. The backend integration allows to quickly check customizable details about the various environments of the application, f.e. local dev, staging and production.

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

[](#installation)

Install the package via composer:

```
composer require shel/neos-healthcheck
```

Example of backend integration
------------------------------

[](#example-of-backend-integration)

[![Backend integration](HealthCheckExample.jpg)](HealthCheckExample.jpg)

Example output of the endpoint
------------------------------

[](#example-output-of-the-endpoint)

The package includes various implementations of the `Shel\Neos\HealthCheck\Checks\HealthCheckInterface`which are executed when the endpoint is called. In addition several of them provide configuration options to customize their behavior.

```
{
    "status": "ok",
    "message": "The system is healthy.",
    "timestamp": 1747112482,
    "packageVersions": {
        "Neos.Neos": "8.3.23",
        "Neos.Neos.Ui": "8.3.13"
    },
    "releaseDate": "2025-05-13 06:39:00",
    "releaseVersion": "5.4.1",
    "phpConfiguration": {
        "memory_limit": "4096M",
        "max_execution_time": "0",
        "max_input_time": "60",
        "post_max_size": "200M",
        "upload_max_filesize": "200M"
    }
}
```

Accessing the endpoint
----------------------

[](#accessing-the-endpoint)

The JSON endpoint `/healthcheck` is secured by default, so you need to provide a mechanism to authenticate the request.

The recommended way is to install the package [flownative/token-authentication](https://github.com/flownative/flow-token-auth) and create a token for the role `Shel.Neos.HealthCheck:Client`:

Run

```
./flow hashtoken:createhashtoken --roleNames Shel.Neos.HealthCheck:Client
```

This will create a token which you can use to authenticate the request either as request argument `_authenticationHashToken=` or as Authorization header with the value `Bearer `.

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

[](#configuration)

You can configure some of the individual checks in your `Settings.yaml` file. See [Configuration/Settings.HealthChecks.yaml](Configuration/Settings.HealthChecks.yaml) for the available options.

### Authorization

[](#authorization)

The package provides a very simple token based authentication for the endpoint. You can configure the token in your `Settings.yaml` file:

```
Shel:
  Neos:
    HealthCheck:
      token: '%env:HEALTHCHECK_TOKEN%'
```

This would read the token from the environment variable and allow you to access the endpoint via `/healthcheck?token=` or via the same url but a `Bearer` header instead of the query param. You can also set the token directly in the `Settings.yaml` file, but this is not recommended for security reasons.

You can also configure your own authentication provider or use a more configurable token authentication like [flownative/token-authentication](https://github.com/flownative/flow-token-auth) and add the following configuration:

```
Neos:
  Flow:
    security:
      authentication:
        providers:
          'Shel.Neos.HealthCheck:TokenAuthenticator':
            provider: Flownative\TokenAuthentication\Security\HashTokenProvider
```

Make sure to read the documentation of the authentication provider you are using to configure it correctly.

### UI integration configuration

[](#ui-integration-configuration)

It is recommended to either only configure the ui integration in the development context or have an environment specific configuration for each context. Also don't commit the hashed tokens to your repository which are required for the integration to access the various systems.

License
-------

[](#license)

See the [LICENSE.txt](LICENSE.txt) file for details.

###  Health Score

35

—

LowBetter than 79% of packages

Maintenance50

Moderate activity, may be stable

Popularity22

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity48

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 ~3 days

Total

4

Last Release

357d ago

Major Versions

0.0.1 → 1.0.02025-05-19

### Community

Maintainers

![](https://www.gravatar.com/avatar/5c9f106db319e8698dcb4aedfe8034f0442d379ebbd78fcd67b884999b2236f1?d=identicon)[Sebobo](/maintainers/Sebobo)

---

Top Contributors

[![Sebobo](https://avatars.githubusercontent.com/u/596967?v=4)](https://github.com/Sebobo "Sebobo (10 commits)")

---

Tags

neoscmsflowNeosneoscmshealthcheck

### Embed Badge

![Health badge](/badges/shel-neos-healthcheck/health.svg)

```
[![Health](https://phpackages.com/badges/shel-neos-healthcheck/health.svg)](https://phpackages.com/packages/shel-neos-healthcheck)
```

###  Alternatives

[shel/neos-colorpicker

A plugin for Neos CMS which provides a colorpicker editor

1494.4k6](/packages/shel-neos-colorpicker)[shel/neos-hyphens

A plugin for Neos CMS which provides hyphens for the inline editor

20200.7k1](/packages/shel-neos-hyphens)[techdivision/ckstyles

Neos package which enables you adding your custom style classes for the CkEditor with a simple Yaml configuration

21166.3k](/packages/techdivision-ckstyles)[moc/notfound

Neos CMS package that loads a normal editable page for displaying a 404 error

18167.5k](/packages/moc-notfound)[carbon/includeassets

Include your assets (css, js) in an easy way into Neos

14228.6k10](/packages/carbon-includeassets)[shel/neos-workspace-module

An alternative workspace module with additional features for Neos CMS

1738.6k1](/packages/shel-neos-workspace-module)

PHPackages © 2026

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