Download the PHP package shel/neos-healthcheck without Composer
On this page you can find all versions of the php package shel/neos-healthcheck. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download shel/neos-healthcheck
More information about shel/neos-healthcheck
Files in shel/neos-healthcheck
Package neos-healthcheck
Short Description Rest endpoint to check the health and customisable metrics of a Neos CMS instance
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package neos-healthcheck
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
Install the package via composer:
Example of backend integration
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.
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 and create a token for the
role Shel.Neos.HealthCheck:Client:
Run
This will create a token which you can use to authenticate the request either as request argument
_authenticationHashToken=<myToken> or as Authorization header with the value Bearer <myToken>.
Configuration
You can configure some of the individual checks in your Settings.yaml file.
See Configuration/Settings.HealthChecks.yaml for the available options.
Authorization
The package provides a very simple token based authentication for the endpoint.
You can configure the token in your Settings.yaml file:
This would read the token from the environment variable and allow you to access the endpoint via
<host>/healthcheck?token=<myToken> 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 and add the following configuration:
Make sure to read the documentation of the authentication provider you are using to configure it correctly.
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
See the LICENSE.txt file for details.
