Getting Started
Learn how Edge connects your backend and application users.
Introduction
Seuraa Edge delivers application events to connected users over channels.
Your backend controls identity and access. It authenticates users, chooses the channels they may access, and issues short-lived channel tokens. Client applications use those tokens to subscribe and, when permitted, publish events.
Core Concepts
| Concept | Description |
|---|---|
| App | An isolated Edge tenant identified by an app key. |
| Channel | A named stream of events within an app. |
| Event | A named JSON payload published to a channel. |
| Channel token | A short-lived credential granting a user specific channel permissions. |
| Presence | Live membership information for a presence:* channel. |
Application Flow
- A user signs in to your application.
- A client application subscribes to a channel.
- The Edge client requests a channel token from your backend.
- Your backend authorizes the user and signs the token.
- Edge validates the token and connects the user to the channel.
- Events published to the channel are delivered to its subscribers.
Install
Install the SDK for each runtime you use:
pnpm add @seuraa/edge
pnpm add @seuraa/edge-node