Welcome
Product docs for CachePuppy: realtime topics, distributed cache, and JavaScript clients.
CachePuppy combines realtime messaging and a distributed cache in one system you run yourself (or with your vendor). The service is built on the BEAM (Erlang VM) using Elixir, so scaling is a matter of adding nodes: processes migrate, sockets stay coherent across the cluster, and cache partitions follow the same routing rules wherever your code touches them.
Use this site to:
- Ship quickly — Quick start with Docker and a short JavaScript example.
- Understand behavior — Core concepts for channels, envelopes, topic state, session state, and cache semantics.
- Integrate from JS — JavaScript covers
@cachepuppy/core,@cachepuppy/react, and the admin HTTP client. - Look up contracts — API reference for HTTP paths, websocket events, and exports.
Quick start
Docker, make compose-up, then connect from JavaScript.
Core concepts
How topics, cache, and the cluster fit together.
JavaScript
Core SDK, React wrapper, and admin HTTP in one place.
API reference
Routes, events, envelopes, and TypeScript surface.
Need the wire format?
When you are integrating a non-JavaScript client, start from the API reference and mirror the JSON envelopes described there.