SeuraaEdge
Docs/Getting Started
Getting Started

Learn how Edge connects your backend and application users.

Introduction

Seuraa Edge is a managed realtime service for delivering application events to connected clients. It makes sense when you need realtime features but do not want to build and operate the delivery infrastructure yourself.

Edge is built for applications that want a European realtime provider with strict EU data governance. Event delivery, account data, operational logs, and product analytics are kept within EU-operated systems, with the active Edge region documented in Regions.

Your backend controls identity and access. It authenticates users, chooses the channels they may access, and issues channel tokens. Client applications use those tokens to subscribe and, when permitted, publish events.

We recommend using short token lifetimes for client-issued channel access, especially for private and presence channels.

Core Concepts

ConceptDescription
AppAn isolated Edge tenant identified by an app key.
ChannelA named stream of events within an app.
EventA named JSON payload published to a channel.
Channel tokenA credential granting a user specific channel permissions.
PresenceLive membership information for a presence:* channel.
API tokenA scoped credential for account-level integrations.

Application Flow

  1. A user signs in to your application.
  2. A client application subscribes to a channel.
  3. The Edge client requests a channel token from your backend.
  4. Your backend authorizes the user and signs the token.
  5. Edge validates the token and connects the user to the channel.
  6. Events published to the channel are delivered to its subscribers.

Install

Install the SDK for each runtime you use:

bash
pnpm add @seuraa/edge@0.1.2
pnpm add @seuraa/edge-node@0.1.2