Skip to content

Installation ​

Install from your application's root:

bash
composer require dereuromark/cakephp-setup

Composer checks the supported PHP and CakePHP versions from the package constraints. Maintenance middleware and healthchecks in production require a production dependency. For development-only use, install with --dev and load using bin/cake plugin load Setup --no-routes --only-debug; do not register a development-only package unconditionally.

Load the plugin ​

For CLI tools and middleware, load Setup with its web routes disabled:

bash
bin/cake plugin load Setup --no-routes

This keeps its administration endpoints out of your application's route table. The plugin does not automatically add middleware; Getting started shows where to add it.

If Setup is already registered, edit its existing entry in config/plugins.php instead of adding it twice. Enable routes only when you need the web backend or web healthcheck and have configured access.

Optional dependencies ​

FeatureAdditional package
Web administration, Tools helpers, default enhanced bake base classesdereuromark/cakephp-tools
Template customization in the administration backenddereuromark/cakephp-templating
Generate application classes or healthcheckscakephp/bake
Run generated database migrationscakephp/migrations
L10n panelcakephp/debug_kit
Healthcheck Queue taskCommunity dereuromark/cakephp-queue

Install the packages for the features you use, then load their plugins. For the administration tools:

bash
composer require dereuromark/cakephp-tools
bin/cake plugin load Tools

The core maintenance middleware needs no Tools dependency. The development dependencies in this repository are not automatically installed in applications consuming the package.

Follow CakePHP's plugin loading documentation for registration through Application::bootstrap().

Released under the MIT License.