Setup Component

Attach this component to your AppController to power up debugging:

• Quick-switch: layout, maintenance, debug, clear cache (password-protected in production mode).
• Notify the admin by email about self-inflicted 404s or loops (configurable).

Production-mode commands are emergency-only

The debug, clear-cache, and maintenance switches for production mode require a password and are emergency commands only — for when you cannot quickly get SSH shell access.

Change your password immediately afterward for security reasons, since passwords should not be passed in plain text via the URL.

Prefer the CLI

For normal execution, prefer the CLI and the Setup plugin's console commands.

How to set up

// In your (App) controller
public function initialize(): void {
    parent::initialize();

    $this->loadComponent('Setup.Setup');
}

Configuration

Session key

The component uses the session to identify users for 404 notifications. By default it reads from Auth.User.

If you use the CakeDC/Users plugin or a different session structure, configure the session key:

// In your app.php or app_local.php
'Setup' => [
    'sessionKey' => 'Auth', // For the CakeDC/Users plugin
],

The component will then read the user ID from Auth.id instead of Auth.User.id.

See also

• Maintenance Mode — the component adds URL-based maintenance switching.
• Console Commands — the preferred way to run setup tasks.