README

A lightweight Kirby CMS plugin that exposes a secured status endpoint for the Moniter dashboard — tracks version and uptime of client websites.

Installation

Via Composer (recommended)

composer require rllngr/kirby-moniter

Manual

Copy the folder into site/plugins/moniter/.

Configuration

Add the API key to site/config/config.php:

return [
    'moniter.key' => 'your-key-generated-by-moniter',
    // ...
];

The key is automatically generated by the Moniter dashboard when adding a client.

Endpoint

GET /moniter/status
Header: X-Moniter-Key: <key>

Response

{
  "kirby": "5.3.2",
  "plugins": {
    "author/plugin": "1.2.0"
  }
}

Error (invalid key)

{ "error": "Unauthorized" }

HTTP 401

Security

• Key comparison uses hash_equals() (timing attack protection)
• Without a valid X-Moniter-Key header, the endpoint always returns 401
• Never commit the key in the client site repository — use an environment variable if needed

Requirements

• Kirby 4.x or 5.x
• PHP 8.0+

License

MIT — rollinger.design