Quickstart

Get your first SummonFlow app running in minutes. Choose the path that fits your team.

Clone the repo, deploy to Railway or your own infra. Full control, zero cost.

Option A: Self-Hosted Setup

Terminal

bun add @summoniq/summon-flow

# install the OSS server package from its standalone distribution

The WebSocket server needs a persistent process. Railway is the recommended option for most teams.

# Deploy via Railway template (one-click)

railway run --template summoniq/summon-flow-server

# Or run locally for development

bun run dev

Add the SummonFlow client to your frontend project.

bun add @summoniq/summon-flow

# or: npm install @summoniq/summon-flow

The client SDK is distributed separately from the hosted console and managed web app.

// Initialize the client

import { SummonFlow } from '@summoniq/summon-flow';

const realtime = new SummonFlow('your-app-key', {

wsHost: 'your-server.railway.app',

forceTLS: true,

channelAuthorization: {

endpoint: '/api/realtime/auth',

});

// Subscribe to a public channel

const channel = realtime.subscribe('public-status-board');

channel.bind('new-event', (data) => console.log(data));

// Subscribe to a presence channel (requires auth endpoint)

const room = realtime.subscribe('presence-project-123');

room.bind('summon:member_added', (member) => {

console.log(member.info.name + ' joined');

});

If you want to skip server management entirely, the managed service handles everything.

1
Create an account
Sign up at summonflow.com/signup — the Hobby tier is free.
2
Create an app
The console gives you an app key and configures your auth endpoint, channel policies, and deployment targets.
3
Install the client SDK
bun add @summoniq/summon-flow
4
Connect with your app key
Use the app key from the console. The managed service handles the WebSocket server, Redis, and TLS for you.

Now that you have basic connectivity, set up subscription signing to secure your private and presence channels.