WP Manifestindependent plugin directory
manifest / unclassified / downtime-wordpress

DownTime Uptime Monitoring

WordPress plugin for DownTime: one-click connect, uptime monitoring, status badges and embeddable status pages

by opscalelab · github.com/opscalelab/downtime-wordpress · website

★ 0stars

Install

Download source zip No release zip yet

This is the repository archive. It installs, but the folder name will carry the branch suffix and updates will not flow.

Install straight from GitHub with WP-CLI:

wp plugin install https://github.com/opscalelab/downtime-wordpress/archive/refs/heads/main.zip
No built-in updater. New versions won't appear under Dashboard → Updates. Install new releases yourself, or let Git Updater track the repository.
Readme github.com/opscalelab/downtime-wordpress ↗

DownTime for WordPress

WordPress plugin for DownTime. Connect a site in one click, monitor it, and embed a status badge or status page. readme.txt is the WordPress.org listing; this file is for developers.

Tracking: OpScaleLab/downtime#363 (epic OpScaleLab/downtime#364).

Layout

File Purpose
downtime.php Plugin header and bootstrap. DOWNTIME_BASE_URL can be overridden in wp-config.php
includes/class-downtime-api.php Server-side API client. The key lives in the downtime_api_key option (autoload off) and never reaches a browser
includes/class-downtime-admin.php Settings → DownTime: Connect/Disconnect, "Monitor this site", status page creation
includes/class-downtime-embed.php [downtime_badge], [downtime_status], and the dynamic downtime/status block's render
blocks/status/ Block metadata and editor UI (plain wp.* globals, no build step)
assets/embed.js Auto-resizes status iframes from the page's downtime:status:resize postMessage (DownTime origin only)

DownTime API contract

Call Endpoint Needs
Connect redirect GET {base}/connect?client=wordpress&site=<home_url>&redirect_uri=<admin-post callback>&state=<random> downtime#362
Code exchange (server-side) POST /api/auth/integrations/exchange {code, redirect_uri} → {api_key} downtime#362
Disconnect DELETE /api/auth/integrations/self (revokes the calling key) downtime#362, plus an integration scope rule
Account GET /api/auth/user downtime#361 integration scope
Monitors GET/POST /api/monitors downtime#361
Status pages GET/POST /api/status-pages downtime#361
Badges / embed GET /api/status/{slug}/badge.svg, uptime.svg, /status/{slug}?embed=1 public (embed: downtime#360)

For development without the Connect flow, set a key directly:

wp option update downtime_api_key <integration-scoped key> --autoload=no

Local testing

docker compose up -d   # see docker-compose.yml: WordPress + MariaDB, plugin mounted

Then open http://localhost:8088, finish the WordPress install, and activate DownTime Uptime Monitoring.

Before a release, run Plugin Check against the built ZIP (not the repo checkout) on the latest WordPress: wp plugin check downtime-uptime-monitoring.

Release

The WordPress.org slug and text domain are downtime-uptime-monitoring.

  1. Bump Version in downtime.php, DOWNTIME_PLUGIN_VERSION, and Stable tag plus the changelog in readme.txt.
  2. Tag the release: git tag vX.Y.Z && git push origin vX.Y.Z.
  3. Build the ZIP: bin/build-zip.sh vX.Y.Z. It contains a single downtime-uptime-monitoring/ folder; .gitattributes leaves out the dev-only files.
  4. Publish it: gh release create vX.Y.Z downtime-uptime-monitoring.zip.
  5. Once the plugin is on WordPress.org, copy the same tree to SVN trunk/ and tags/X.Y.Z/.

The plugin is GPL-2.0-or-later, as WordPress.org requires.