simstudio-realtime

simstudio-realtime

Docker app from rorar's Repository

Overview

Sim Studio Realtime WebSocket Server for live collaboration and real-time updates. This service handles WebSocket connections for collaborative features, live notifications, and real-time data synchronization between clients and the main Sim Studio application. Requires: simstudio-db (PostgreSQL), simstudio-valkey (Valkey for session persistence).

Readme

View on GitHub

Sim.ai Documentation Slack X

Ask DeepWiki Set Up with Cursor

Sim — Integrate, Context, Build, and Monitor AI agents

A workspace to build, deploy and manage AI agents and workflows.

Quickstart

Cloud-hosted: sim.ai

Open sim.ai

Self-hosted

npx sim-setup

Open http://localhost:3000

The Sim platform — chat on the left, the visual workflow builder on the right

Capabilities

  • Connect 1,000+ integrations and every major LLM
  • Add Slack, Notion, HubSpot, Salesforce, databases, and more
  • Build agents visually, conversationally, or with code
  • Ingest files, knowledge bases, and structured table data
  • Monitor runs, logs, schedules, and workflow activity

One workspace, every surface

Chat and workflows are just the start — tables, files, and knowledge all live in the same workspace.

Tables in Sim — structured data your agents can query

Tables — a database, built in

 Files in Sim — documents for your team and every agent

Files — one store for your team and every agent
Knowledge bases in Sim — synced docs your agents can search

Knowledge — your agents' memory

Self-hosting

Requirements: Node.js 20+ and Docker.

npx sim-setup is an interactive wizard that creates a small sim/ deployment directory, provisions the database, generates secrets, writes .env, connects a Chat API key, and starts the published Sim images with Docker Compose. It does not clone the repository.

When it finishes, open http://localhost:3000.

Inside a cloned Sim repository, run bun run sim-setup to unlock the source-only local development and Kubernetes modes.

Reconfigure an optional capability without rerunning the full wizard:

npx sim-setup config
npx sim-setup add email
npx sim-setup add storage
npx sim-setup add sandbox
npx sim-setup add jobs
npx sim-setup add cache
npx sim-setup add knowledge
npx sim-setup add chat
npx sim-setup add llm
npx sim-setup add integration slack

npx sim-setup config detects the effective local-dev, Docker Compose, or current-context Helm configuration and reports configured, missing, or invalid capabilities and OAuth integrations without printing credential values. This is separate from npx sim-setup status, which reports whether installed services are running and healthy.

Manage your install from its directory:

npx sim-setup start | stop | restart   # bring your install up / down / cycle
npx sim-setup update                   # pull and apply Compose images
npx sim-setup status                   # what's installed and healthy
npx sim-setup logs                     # follow logs
npx sim-setup doctor                   # diagnose configuration problems
npx sim-setup down                     # remove containers (data kept)
npx sim-setup reset                    # archive .env and wipe managed data

The setup package detects how you're running and acts accordingly. Use --dir <path> to create or manage a deployment somewhere other than ./sim.

Sim also supports local models via Ollama and vLLM. See the self-hosting docs for details.

Chat API Keys

Chat is a Sim-managed service. npx sim-setup connects a Chat API key for you — sign in when it opens your browser and the key is stored automatically. To view, create, or revoke keys later, go to sim.ai/selfhost/settings/chat-keys.

Environment Variables

See the environment variables reference for the full list, or apps/sim/.env.example for defaults.

Tech Stack

Next.js · Bun · PostgreSQL · Drizzle · Better Auth · Tailwind — and the rest of the stack

Contributing

We welcome contributions! Please see our Contributing Guide for details.

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

Built by the Sim team in San Francisco

Install simstudio-realtime on Unraid in a few clicks.

Find simstudio-realtime in Community Apps on your Unraid server, review the template, and click Install. Unraid handles the Docker app or plugin setup from the published template.

Open the Apps tab on your Unraid server Search Community Apps for simstudio-realtime Review the template variables and paths Click Install
Explore Unraid OS

Requirements

Requires simstudio-db on the same Docker network (simstudio_internal). Requires simstudio-valkey for session persistence and scaling.

IMPORTANT: Before adding this container, you must create the Docker network 'simstudio_internal' first. Follow these steps in Unraid:

  1. Open Terminal (Go to Main, click Terminal button)
  2. Run: docker network create simstudio_internal
  3. Go to Settings > Docker
  4. Set "Enable Docker" to "No" and click Apply
  5. Set "Preserve user defined networks" to "Yes" and click Apply
  6. Set "Enable Docker" to "Yes" and click Apply
  7. The network is now ready for use with all Sim Studio containers

Categories

Development

Related apps

Explore more like this

Explore all
Development

Links

Projectsimstudio.aiSupportgithub.comRegistrygithub.comTemplateraw.githubusercontent.com

Details

Repository
ghcr.io/simstudioai/realtime:latest
Registry
https://github.com/simstudioai/sim/pkgs/container/realtime
Last Updated2026-08-30
First Seen2026-07-17

Runtime arguments

Web UI
http://[IP]:[PORT:3002]/health
Network
simstudio_internal
Shell
sh
Privileged
false
Extra Params
--health-cmd="curl -fsS http://127.0.0.1:3002/health" --health-interval=90s --health-retries=3 --health-start-period=10s --health-timeout=5s

Template configuration

Port: WebSocket ServerPorttcp

Realtime WebSocket server port

Target
3002
Default
3002
Value
3002
--- Database ---Variable

PostgreSQL connection settings. Must match simstudio-db configuration.

DATABASE_URLVariable

PostgreSQL connection URL (format: postgresql://user:password@host:port/database)

Default
postgresql://postgres:postgres@simstudio-db:5432/simstudio
Value
postgresql://postgres:postgres@simstudio-db:5432/simstudio
--- Authentication &amp; Security ---Variable

Auth and security configuration for realtime service.

BETTER_AUTH_SECRETVariable

Authentication secret key (shared with simstudio-app). Must be 32+ characters. Generate: openssl rand -base64 32

BETTER_AUTH_URLVariable

Base URL for authentication (e.g. http://your-server:3000)

Default
http://localhost:3000
Value
http://localhost:3000
INTERNAL_API_SECRETVariable

Secret for internal service-to-service communication (shared with simstudio-app). Generate: openssl rand -base64 32

--- Application URLs ---Variable

Public URLs for the application.

NEXT_PUBLIC_APP_URLVariable

Public URL of the application (used by browser clients)

Default
http://localhost:3000
Value
http://localhost:3000
--- Valkey Session Storage ---Variable

Valkey connection for session persistence and scaling.

REDIS_URLVariable

Valkey connection URL (format: redis://host:port/db)

Default
redis://simstudio-valkey:6379/0
Value
redis://simstudio-valkey:6379/0
--- System ---Variable

Node.js and timezone configuration.

NODE_ENVVariable

Node.js environment (production/development)

Default
production
Value
production
Variable: TZVariable

Timezone. See: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List

Target
TZ
Default
Europe/Berlin
Value
Europe/Berlin
--- Advanced ---Variable

Advanced performance and debugging settings.

LOG_LEVELVariable

Log verbosity: error, warn, info, debug

Default
info
Value
info