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).

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 simstudio

Open http://localhost:3000

Docker must be installed and running. Use -p, --port <port> to run Sim on a different port, or --no-pull to skip pulling the latest Docker images.

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, knowledge, and scheduled tasks 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

Scheduled tasks in Sim — recurring agent runs on a calendar

Scheduled tasks — runs on your schedule

Self-hosting

Docker Compose

git clone https://github.com/simstudioai/sim.git && cd sim
docker compose -f docker-compose.prod.yml up -d

Open http://localhost:3000

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

Manual Setup

Requirements: Bun, Node.js v20+, PostgreSQL 12+ with pgvector

  1. Clone and install:
git clone https://github.com/simstudioai/sim.git
cd sim
bun install
bun run prepare  # Set up pre-commit hooks
  1. Set up PostgreSQL with pgvector:
docker run --name simstudio-db -e POSTGRES_PASSWORD=your_password -e POSTGRES_DB=simstudio -p 5432:5432 -d pgvector/pgvector:pg17

Or install manually via the pgvector guide.

  1. Configure environment:
cp apps/sim/.env.example apps/sim/.env
# Create your secrets
perl -i -pe "s/your_encryption_key/$(openssl rand -hex 32)/" apps/sim/.env
perl -i -pe "s/your_internal_api_secret/$(openssl rand -hex 32)/" apps/sim/.env
perl -i -pe "s/your_api_encryption_key/$(openssl rand -hex 32)/" apps/sim/.env
# DB configs for migration
cp packages/db/.env.example packages/db/.env
# Edit both .env files to set DATABASE_URL="postgresql://postgres:your_password@localhost:5432/simstudio"
  1. Run migrations:
cd packages/db && bun run db:migrate
  1. Start development servers:
bun run dev:full  # Starts Next.js app and realtime socket server

Or run separately: bun run dev (Next.js) and cd apps/sim && bun run dev:sockets (realtime).

Chat API Keys

Chat is a Sim-managed service. To use Chat on a self-hosted instance:

  • Go to https://sim.ai → Settings → Chat keys and generate a Chat API key
  • Set COPILOT_API_KEY environment variable in your self-hosted apps/sim/.env file to that value

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

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

Related apps

Explore more like this

Explore all

Details

Repository
ghcr.io/simstudioai/realtime:latest
Last Updated2026-07-17
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