PHP download

Download the PHP package martino/kirby-debug-toggle without Composer

On this page you can find all versions of the php package martino/kirby-debug-toggle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

Table of contents
Download martino/kirby-debug-toggle
More information about martino/kirby-debug-toggle
Files in martino/kirby-debug-toggle

Vendor martino
Package kirby-debug-toggle
Short Description A Kirby 5 CMS panel plugin for safe, time-limited debug mode toggling with automatic expiry
License MIT
Homepage https://github.com/JoaoMartino/kirby-debug-toggle

Keywords debug development panel kirby kirby-plugin kirby-cms

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:

If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

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 PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

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.

Please rate this library. Is it a good library?

Example code of martino/kirby-debug-toggle

Informations about the package kirby-debug-toggle

Debug Toggle for Kirby 5

A Kirby 5 CMS panel plugin that provides a safe, time-limited debug mode toggle with automatic expiry and git-safe flag file management.

Features

Flag-based debug control - Uses a .debug_enabled flag file instead of modifying config.php
Panel auto-debug - Automatically enables debug for panel when authorized users are logged in (prevents panel lockout)
Auto-expiry - Debug mode automatically disables after configured hours
Permission system - Restrict access by admin status, role name, or custom callback
Git-safe - Automatically adds flag file to .gitignore
Panel UI - Clean card-based interface with status indicator
Dark/Light mode - Fully responsive to Kirby panel theme (Kirby 5) and fallback for Kirby 4
Real-time status - Shows who enabled debug and when it expires

Demo

Why this exists

The built-in Kirby workarounds for toggling debug mode didn't fully fit my needs. So I built this for myself. It does exactly what I need and nothing more. If it fits yours too, feel free to use it.

Installation

Manual Installation

Download and extract the plugin to site/plugins/debug-toggle/
The plugin structure should be:

Composer Installation

Configuration

⚠️ Required: Add the following to your site/config/config.php:

Important: The debug closure is required for the plugin to work. Without it, the panel UI will appear but debug mode won't actually activate when toggled.

Panel Auto-Debug: By default, debug mode is automatically enabled in the panel for authorized users (even when the toggle is OFF). This prevents panel corruption from hiding errors. You can disable this by setting 'Martino.debug-toggle.panel-auto-debug' => false.

Configuration Options

`Martino.debug-toggle.expiry-hours`

Type: int
Default: 4

Number of hours until debug mode automatically disables.

`Martino.debug-toggle.permission`

Type: string|callable
Default: 'admin'

Controls who can access and toggle debug mode.

Options:

'admin' - Only users with admin status (uses isAdmin())
Role name - Only users with specific role
Custom callback - Custom permission logic

`Martino.debug-toggle.panel-auto-debug`

Type: bool
Default: true

Automatically enables debug mode in the panel for authorized users, even when the toggle is OFF.

Why this exists: If the panel breaks due to an error, you need debug mode to see what went wrong. With this enabled, authorized users always see panel errors, preventing you from being locked out.

Behavior:

✅ Frontend: Controlled by the toggle (manual)
✅ Panel (authorized users): Always ON (auto-debug)
✅ Panel (public/unauthorized): Controlled by the toggle

Usage

Log in to the Kirby panel as an authorized user
Click Debug in the sidebar menu
Click Turn ON to enable debug mode
Debug mode will automatically disable after the configured expiry time
Click Turn OFF to manually disable debug mode

Panel Interface

The debug toggle interface displays:

Status - Current state (ON/OFF)
Enabled by - Email of user who enabled debug
Expires at - Timestamp when debug will auto-disable
Warning message - Reminder that errors are visible to all visitors
Status indicator - Visual dot (orange = active, gray = inactive)

How It Works

Flag File System

The plugin uses a flag file at site/config/.debug_enabled to control debug mode:

Benefits:

No modification of config.php required
Git-safe (automatically added to .gitignore)
Automatic expiry prevents forgotten debug mode
Tracks who enabled debug and when

Security

All API routes require authentication and permission checks
Flag file is created with chmod 0600 (owner read/write only)
Expired flags are automatically deleted on next state check
Default state is OFF (no flag file = no debug)

API Routes

The plugin provides two API endpoints:

GET `/api/debug-toggle/state`

Returns current debug state and metadata.

Response:

POST `/api/debug-toggle/state`

Toggles debug mode on or off.

Request:

Response: Same as GET endpoint

Requirements

Kirby 5.x
PHP 8.2+
Panel access with appropriate permissions

Troubleshooting

Debug toggle menu not visible

Verify you're logged in as an admin user (or user with configured permission)
Check that the plugin files are in site/plugins/debug-toggle/
Hard refresh the panel (Cmd+Shift+R / Ctrl+Shift+R)

Debug mode not working

Verify the debug config closure is added to config.php
Check file permissions on site/config/ directory
Ensure .debug_enabled file can be created/deleted

Permission denied errors

Verify your user has the required permission level
Check the Martino.debug-toggle.permission config option

Development

File Structure

Helper Functions

The plugin provides these helper functions:

debugFlagPath() - Returns path to flag file
debugFlagData() - Reads and decodes flag file
debugFlagExpired() - Checks if flag has expired
debugFlagActive() - Checks if debug is currently active
debugHasPermission() - Checks if current user has permission
ensureGitIgnore() - Adds flag file to .gitignore

License

See LICENSE file for details.

Author

João Martino
nonverbal
nonverbalclub.pt

Support

For issues, questions, or contributions, please visit the GitHub repository.

Questions or doubts:

Made with ❤️ for the Kirby community

All versions of kirby-debug-toggle with dependencies

PHP Build Version

Package Version

Version 1.0.0 Release 07. Apr 2026
create-project require 0 people chose require and
0 people chose create-project.

Download

Download latest version of kirby-debug-toggle from vendor martino

Requires getkirby/composer-installer Version ^1.2

Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package martino/kirby-debug-toggle contains the following files

Loading the files please wait ...