mirror of
https://github.com/simstudioai/sim.git
synced 2026-02-10 06:35:01 -05:00
be2a9ef0f8
* fix(docs): update requirements to be more accurate for deploying the app * updated kb to support 1536 dimension vectors for models other than text embedding 3 small * fix(storage): support Azure connection string for presigned URLs * fix(kb): update test for embedding dimensions parameter * fix(storage): align credential source ordering for consistency
66 lines
3.2 KiB
Plaintext
66 lines
3.2 KiB
Plaintext
---
|
|
title: Self-Hosting
|
|
description: Deploy Sim on your own infrastructure
|
|
---
|
|
|
|
import { Card, Cards } from 'fumadocs-ui/components/card'
|
|
import { Callout } from 'fumadocs-ui/components/callout'
|
|
|
|
Deploy Sim on your own infrastructure with Docker or Kubernetes.
|
|
|
|
<div className="flex gap-2 my-4">
|
|
<a href="https://cursor.com/link/prompt?text=Help%20me%20set%20up%20Sim%20locally.%20Follow%20these%20steps%3A%0A%0A1.%20First%2C%20verify%20Docker%20is%20installed%20and%20running%3A%0A%20%20%20docker%20--version%0A%20%20%20docker%20info%0A%0A2.%20Clone%20the%20repository%3A%0A%20%20%20git%20clone%20https%3A%2F%2Fgithub.com%2Fsimstudioai%2Fsim.git%0A%20%20%20cd%20sim%0A%0A3.%20Start%20the%20services%20with%20Docker%20Compose%3A%0A%20%20%20docker%20compose%20-f%20docker-compose.prod.yml%20up%20-d%0A%0A4.%20Wait%20for%20all%20containers%20to%20be%20healthy%20(this%20may%20take%201-2%20minutes)%3A%0A%20%20%20docker%20compose%20-f%20docker-compose.prod.yml%20ps%0A%0A5.%20Verify%20the%20app%20is%20accessible%20at%20http%3A%2F%2Flocalhost%3A3000%0A%0AIf%20there%20are%20any%20errors%2C%20help%20me%20troubleshoot%20them.%20Common%20issues%3A%0A-%20Port%203000%2C%203002%2C%20or%205432%20already%20in%20use%0A-%20Docker%20not%20running%0A-%20Insufficient%20memory%20(needs%2012GB%2B%20RAM)%0A%0AFor%20local%20AI%20models%20with%20Ollama%2C%20use%20this%20instead%20of%20step%203%3A%0A%20%20%20docker%20compose%20-f%20docker-compose.ollama.yml%20--profile%20setup%20up%20-d">
|
|
<img src="https://img.shields.io/badge/Set%20Up%20with-Cursor-000000?logo=cursor&logoColor=white" alt="Set Up with Cursor" />
|
|
</a>
|
|
</div>
|
|
|
|
## Requirements
|
|
|
|
| Resource | Small | Standard | Production |
|
|
|----------|-------|----------|------------|
|
|
| CPU | 2 cores | 4 cores | 8+ cores |
|
|
| RAM | 12 GB | 16 GB | 32+ GB |
|
|
| Storage | 20 GB SSD | 50 GB SSD | 100+ GB SSD |
|
|
| Docker | 20.10+ | 20.10+ | Latest |
|
|
|
|
**Small**: Development, testing, single user (1-5 users)
|
|
**Standard**: Teams (5-50 users), moderate workloads
|
|
**Production**: Large teams (50+ users), high availability, heavy workflow execution
|
|
|
|
<Callout type="info">
|
|
Resource requirements are driven by workflow execution (isolated-vm sandboxing), file processing (in-memory document parsing), and vector operations (pgvector). Memory is typically the constraining factor rather than CPU. Production telemetry shows the main app uses 4-8 GB average with peaks up to 12 GB under heavy load.
|
|
</Callout>
|
|
|
|
## Quick Start
|
|
|
|
```bash
|
|
git clone https://github.com/simstudioai/sim.git && cd sim
|
|
docker compose -f docker-compose.prod.yml up -d
|
|
```
|
|
|
|
Open [http://localhost:3000](http://localhost:3000)
|
|
|
|
## Deployment Options
|
|
|
|
<Cards>
|
|
<Card title="Docker" href="/self-hosting/docker">
|
|
Deploy with Docker Compose on any server
|
|
</Card>
|
|
<Card title="Kubernetes" href="/self-hosting/kubernetes">
|
|
Deploy with Helm on Kubernetes clusters
|
|
</Card>
|
|
<Card title="Cloud Platforms" href="/self-hosting/platforms">
|
|
Railway, DigitalOcean, AWS, Azure, GCP guides
|
|
</Card>
|
|
</Cards>
|
|
|
|
## Architecture
|
|
|
|
| Component | Port | Description |
|
|
|-----------|------|-------------|
|
|
| simstudio | 3000 | Main application |
|
|
| realtime | 3002 | WebSocket server |
|
|
| db | 5432 | PostgreSQL with pgvector |
|
|
| migrations | - | Database migrations (runs once) |
|
|
|