Documentation

Introduction

Learn how Celeris delivers live updates and build your first browser and Node application.

What is Celeris?

Celeris delivers live updates between your backend, browsers, and other services. A chat message can appear without refreshing a page; an order dashboard can update as the order changes.

Your backend saves the important data, decides who may access it, and publishes updates. Celeris maintains live connections and routes messages to permitted subscribers. Your application decides how to display or process them.

How an update reaches the browser

  1. Your browser asks your application's backend for signed access credentials.
  2. Your backend verifies the user and grants limited channel and segment permissions.
  3. The browser connects to a channel and automatically joins its default segment. It can also subscribe to additional named segments.
  4. A publisher sends bytes to that segment.
  5. The browser receives the bytes, decodes them, and updates its interface.
Your backend or another publisher
              |
              v
    Celeris channel / segment
              |
              v
    Permitted receiving apps

A channel carries related streams over a connection. A segment is one named stream inside it, such as chat messages or typing indicators. See Channels and Segments.

Every channel has a default segment. Use it when you need one message stream; you do not have to create another segment or call subscribe() to join it. Register an onMessage() listener to handle incoming messages, and grant the connection the read/write permissions it needs.

What Celeris does not replace

Keep authentication decisions, business logic, durable data, and application-level acknowledgements in your application. Publish completion is not a delivery receipt. Reconnection can have gaps or duplicates, and independent publishers are not one globally ordered stream.

You choose the payload format: text, JSON, MessagePack, Protobuf, or other bytes. No particular serializer is required.

Start here

  1. Quickstart: build a complete local two-tab messaging example.
  2. Authentication: replace demo access with your real authorization.
  3. JavaScript SDK: continue through the task-based guides.
  4. Reconnection and Recovery: decide how to recover important state.

We use Google Analytics cookies to understand how people use Celeris, only if you allow it. See our Cookie Policy.