Realtime Collaboration

Gossip + overlay cache for distributed realtime updates, while Git stays the source of truth.

MkDocs is the SSOT for documentation. This page is a short summary for kanb.us.

←Back to Realtime Collaboration feature page
Realtime Collaboration architecture diagram

Quickstart (Local UDS)

Terminal
# Terminal 1: start local broker
kbs gossip broker

# Terminal 2: watch + update overlay
kbs gossip watch

Quickstart (Local MQTT)

Terminal
kbs gossip watch --transport mqtt --broker auto

If Mosquitto is installed and no broker is reachable, Kanbus can autostart a local broker and write~/.kanbus/run/broker.json.

Config

.kanbus.yml
realtime:
  transport: auto            # auto | uds | mqtt
  broker: auto               # auto | off | mqtt://... | mqtts://...
  autostart: true            # autostart mosquitto if unreachable (MQTT only)
  keepalive: false           # keep autostarted broker running
  uds_socket_path: null      # override UDS socket path
  topics:
    project_events: "projects/{project}/events"

overlay:
  enabled: true
  ttl_s: 86400

Canonical Docs

For envelope schema, dedupe rules, overlay merge semantics, GC + hooks, and troubleshooting, use the canonical MkDocs page.

Open docs source on GitHub →

Tip: set GATSBY_MKDOCS_BASE_URL in the kanb.us build to link to a deployed MkDocs site.