Walkie for Craft CMS

Walkie is a Craft 6 plugin. Craft 6 is still in beta, and so is Walkie (6.0.0-beta.1) — try it on staging first and use caution on production sites.

Configuration

Walkie is for Craft 6, which is still in beta (so is Walkie, 6.0.0-beta.1). Use caution on production sites.

Settings → Walkie, or config/craft/walkie.php (which overrides the stored settings, per environment).

SettingDefaultWhat it does
broadcastSavesonBroadcast entry and asset saves (created, saved). Drafts, revisions, duplicates and bulk resaves never are.
broadcastDeletesonBroadcast deletes and restores (deleted, restored).
broadcastStatusChangesoncraft:walkie:scheduled broadcasts status when a post or expiry date passes.
presenceoffAllow presence channels (who else is viewing an element).
publicSectionsnoneSection UIDs whose live entries are announced on public channels.
connectionapp defaultA connection from config/broadcasting.php. Validated: an unknown name is refused.
queueBroadcastsonSend from the queue. Off sends during the request (a down server is logged, never fails the save).
queuedefaultQueue name for broadcasts.
registerAuthRouteonRegister POST /broadcasting/auth (an app's own route still wins).
clientHost / clientPortfrom the connectionThe WebSocket host/port browsers use, when they differ from the server side (e.g. Reverb behind a proxy).
// config/craft/walkie.php
return [
    'connection' => env('WALKIE_CONNECTION', 'reverb'),
    'queueBroadcasts' => true,
    'queue' => 'broadcasts',
    'clientHost' => env('VITE_REVERB_HOST'),
    'clientPort' => (int) env('VITE_REVERB_PORT', 443),
];

What the browser gets

walkie.config() and GraphQL's walkieChannels.echo hand the browser the broadcaster, the public app key, host, port and TLS flag. Never the secret or the app id. Drivers browsers can't connect to (log, null, redis, and ably, whose key is a secret) give null: configure Echo yourself for those.