WordPress.org
Get WordPress

Plugin Directory


Ignore:
Timestamp:
11/15/2026 01:34:19 AM (less than one hour ago)
Author:
owenfar
Message:

Deploy version 2.1.3

File:
1 edited

Legend:

Unmodified
Added
Removed

  • debugbundle/trunk/README.md

    r3792513 r3802637  
    11# DebugBundle WordPress Plugin
    22
    3 Patch 2.1.2 protects invitation and organisation-transfer credentials in captured text while preserving public APIs and event schemas. Upgrade the DebugBundle distribution to adopt the protection.
     3Patch 2.1.3 protects invitation and organisation-transfer credentials in captured text while preserving public APIs and event schemas. Upgrade the DebugBundle distribution to adopt the protection.
    44
    55WordPress plugin for DebugBundle.
    … …  
    88
    99![CI](https://img.shields.io/github/actions/workflow/status/debugbundle/debugbundle-wordpress/ci.yml?branch=main&label=ci)
    10 ![Version](https://img.shields.io/badge/version-2.1.2-blue)
     10![Version](https://img.shields.io/badge/version-2.1.3-blue)
    1111![License](https://img.shields.io/badge/license-GPL--2.0--or--later-blue)
    1212
    … …  
    2020for activation and runtime limits.
    2121
    22 ## Requirements
     22## Installation
     23
     24<a id="requirements"></a>
     25
     26<a id="install"></a>
    2327
    2428- WordPress 6.5 or newer (tested through WordPress 7.1)
    2529- PHP 8.2 or newer
    2630
    27 ## Installation
    28 
    29311. Install **DebugBundle** from the [WordPress.org plugin directory](https://wordpress.org/plugins/debugbundle/).
    30 2. Activate the plugin.
    31 3. Open **Settings -> DebugBundle**.
    32 4. Paste your DebugBundle project token and save.
    33 5. Use the backend and frontend test-event buttons to verify delivery.
    3432
    3533Manual ZIP installs are available from the [`debugbundle-wordpress` GitHub releases](https://github.com/debugbundle/debugbundle-wordpress/releases) page when a host or deployment process cannot install from WordPress.org.
    3634
    37 The plugin can also read the project token from `wp-config.php`:
    38 
    39 ```php
    40 define('DEBUGBUNDLE_PROJECT_TOKEN', 'dbundle_proj_xxxxxxxxxxxx');
    41 ```
    42 
    43 Version 2.0 reads remote capture policy from a local cache on visitor requests. WP-Cron refreshes it using the project token; the cache is scoped by endpoint and token hash, and an unavailable cache falls back to the minimal capture policy. WP-Cron must run for remote policy changes to arrive.
    44 
    45 ## What It Captures
     35## Initialize
     36
     37Activate the plugin, then open **Settings -> DebugBundle**, save your project token, environment and service, and enable the capture paths you need. The plugin initializes its bundled PHP and browser SDKs; no application `init()` call is required.
     38
     39## Integrations
     40
     41### What It Captures
    4642
    4743- Backend PHP errors, exceptions, shutdown failures, request context, logs, runtime facts, and probes through `debugbundle/sdk-php`
    … …  
    5248The first release focuses on public-site capture. It does not capture `wp-admin` traffic by default.
    5349
    54 ## Settings
     50## First-event verification
     51
     52Use the backend and frontend test-event buttons in **Settings -> DebugBundle** from an administrator session. Confirm both service identities in received events or incidents in DebugBundle. Saving settings or an empty relay spool is not a delivery receipt; check the delivery diagnostics and inspect the matching incident.
     53
     54## Configuration
     55
     56<a id="settings"></a>
    5557
    5658| Setting | Default | Purpose |
    … …  
    7173| Delete settings on uninstall | disabled | Remove saved settings when the plugin is uninstalled. |
    7274
     75The plugin can also read the project token from `wp-config.php`:
     76
     77```php
     78define('DEBUGBUNDLE_PROJECT_TOKEN', 'dbundle_proj_xxxxxxxxxxxx');
     79```
     80
     81Version 2.0 reads remote capture policy from a local cache on visitor requests. WP-Cron refreshes it using the project token; the cache is scoped by endpoint and token hash, and an unavailable cache falls back to the minimal capture policy. WP-Cron must run for remote policy changes to arrive.
     82
    7383## External Service Behavior
    7484
    … …  
    204214
    205215
    206 ### Unreleased acceptance-credential privacy
    207 
    208 The source candidate also scrubs standalone `dbundle_invite_`,
     216<a id="unreleased-acceptance-credential-privacy"></a>
     217
     218### Acceptance-credential privacy
     219
     220The SDK scrubs standalone `dbundle_invite_`,
    209221`dbundle_org_invite_` and `dbundle_org_transfer_` acceptance secrets before
    210222SDK-owned retention or transmission. See the [shared qualification record](https://github.com/debugbundle/debugbundle/blob/main/spec/business-credential-redaction.md).
    211 Published packages keep their released behaviour until the coordinated dependency
    212 and distribution checks are completed and a new version is published.
     223Existing installations receive this protection when upgraded to a version that includes it.
Note: See TracChangeset for help on using the changeset viewer.