PHPackages                             ledgehq/ledge-craft - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Logging & Monitoring](/categories/logging)
4. /
5. ledgehq/ledge-craft

ActiveCraft-plugin[Logging & Monitoring](/categories/logging)

ledgehq/ledge-craft
===================

Health, uptime, and compliance monitoring for your Craft CMS sites.

5.1.0(2w ago)0118↑37%mitPHPPHP >=8.2

Since Jan 28Pushed 1w agoCompare

[ Source](https://github.com/ledgehq/ledge-craft)[ Packagist](https://packagist.org/packages/ledgehq/ledge-craft)[ RSS](/packages/ledgehq-ledge-craft/feed)WikiDiscussions 5.x Synced 1w ago

READMEChangelogDependencies (10)Versions (27)Used By (0)

Ledge
=====

[](#ledge)

Health, uptime, and compliance monitoring for your Craft CMS sites.

Requirements
------------

[](#requirements)

This plugin requires Craft CMS 5.0.0 or later, and PHP 8.2 or later.

Installation
------------

[](#installation)

You can install this plugin from the Plugin Store or with Composer.

#### From the Plugin Store

[](#from-the-plugin-store)

Go to the Plugin Store in your project’s Control Panel and search for “Ledge”. Then press “Install”.

#### With Composer

[](#with-composer)

Open your terminal and run the following commands:

```
# go to the project directory
cd /path/to/my-project.test

# tell Composer to load the plugin
composer require ledgehq/ledge-craft

# tell Craft to install the plugin
./craft plugin/install ledge

# generate a secret key for the health endpoint
./craft ledge/generate-key
```

Configuration
-------------

[](#configuration)

Ledge requires a secret key to authenticate requests to the `/_ledge/health` endpoint. You can either:

- Run `./craft ledge/generate-key` to generate a key and save it to your `.env` file automatically
- Add your own key to `.env` manually: `LEDGE_SECRET_KEY=your-secret-key`

The health endpoint can then be accessed by including the key in the `X-Ledge-Key` header:

```
curl -H "X-Ledge-Key: your-secret-key" https://your-site.com/_ledge/health
```

Acquire (automated update testing & backups)
------------------------------------------------

[](#acquire-automated-update-testing--backups)

Beyond `/health`, Ledge can act as an **acquisition agent**: on a signed command from the Ledge service, the plugin produces an encrypted bundle of the site (a database dump — plus an environment + crawlable-URL manifest for update-test runs) and uploads it to object storage. This powers automated "does this update break the site?" testing and scheduled database backups.

This capability is **off by default** and higher-privilege than `/health`: every command must carry an Ed25519 signature (verified against Ledge's published keyset) on top of the shared key, and nothing is registered until an operator opts in. To enable it:

```
// config/ledge.php
return [
    'secretKey' => '$LEDGE_SECRET_KEY',
    'acquireEnabled' => true, // or LEDGE_ACQUIRE_ENABLED=true
];
```

Bundle uploads and callbacks may only be sent to allowlisted hosts; the allowlist defaults to `['ledgehq.app', '*.ledgehq.app']` and can be overridden with `acquireAllowedHosts` (or `LEDGE_ACQUIRE_ALLOWED_HOSTS`) for self-hosted or dev setups.

While disabled, the acquire routes return `404` and the plugin behaves exactly as a health-only install. A companion opt-in endpoint, `GET /_ledge/uris` (enabled with `urisEnabled` / `LEDGE_URIS_ENABLED`), returns the site's crawlable public URL map on demand.

See [docs/acquire-protocol.md](docs/acquire-protocol.md) for the full wire protocol, bundle format, callback events, and command-signing snippets.

###  Health Score

47

—

FairBetter than 93% of packages

Maintenance97

Actively maintained with recent releases

Popularity14

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity58

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~7 days

Total

25

Last Release

17d ago

Major Versions

0.5.2 → 5.0.02026-05-27

4.0.0 → 5.0.22026-05-28

4.0.5 → 5.0.52026-06-02

4.x-dev → 5.x-dev2026-07-07

PHP version history (2 changes)0.1.0PHP >=8.0.2

5.0.0PHP >=8.2

### Community

Maintainers

![](https://www.gravatar.com/avatar/e5d1f11b17c20900cfc142244115ba629d618fa0e7d1da155338f94f87a299f8?d=identicon)[bbordersbwd](/maintainers/bbordersbwd)

---

Top Contributors

[![BrandonJamesBorders](https://avatars.githubusercontent.com/u/6044898?v=4)](https://github.com/BrandonJamesBorders "BrandonJamesBorders (60 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/ledgehq-ledge-craft/health.svg)

```
[![Health](https://phpackages.com/badges/ledgehq-ledge-craft/health.svg)](https://phpackages.com/packages/ledgehq-ledge-craft)
```

###  Alternatives

[verbb/vizy

A flexible visual editor field for Craft.

4250.4k](/packages/verbb-vizy)[verbb/hyper

A user-friendly links field for Craft.

24147.8k12](/packages/verbb-hyper)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)