Bắt đầu nhanh

Tệp nguồn liên quan

Trang này được tạo dựa trên các tệp nguồn sau:

• README.md
• docker-compose.prod.yml
• docker-compose.ollama.yml
• .devcontainer/devcontainer.json
• .devcontainer/post-create.sh
• apps/sim/app/workspace/[workspaceId]/w/[workflowId]/utils/workflow-execution-utils.ts
• apps/sim/lib/workflows/executor/execution-events.ts
• packages/python-sdk/setup.py
• packages/db/index.ts
• apps/sim/tools/index.ts

Sim là nền tảng mã nguồn mở để xây dựng các AI agent và điều phối quy trình làm việc tự động. Dự án hỗ trợ kết nối hơn 1,000 tích hợp và các mô hình ngôn ngữ lớn (LLM) khác nhau, cho phép người dùng thiết kế workflow trực quan trên canvas.

Yêu cầu môi trường

Yêu cầu hệ thống

Dựa trên cấu hình Docker Compose, các yêu cầu tài nguyên tối thiểu như sau:

Giới hạn tài nguyên theo cấu hình Docker (docker-compose.prod.yml:7-L10):

• Service simstudio: giới hạn 8GB memory
• Service realtime: giới hạn 1GB memory (docker-compose.prod.yml:45-L48)

Cổng mạng

Các cổng được sử dụng bởi hệ thống:

Cấu hình cổng (docker-compose.prod.yml:5-L6, docker-compose.prod.yml:43-L44, docker-compose.prod.yml:81-L82).

Cài đặt nhanh với NPM Package

Phương thức được khuyến nghị

Đây là cách nhanh nhất để chạy Sim cục bộ:

bash
1npx simstudio

Sau khi chạy, ứng dụng sẽ có sẵn tại http://localhost:3000 (README.md:49-L52).

Lưu ý quan trọng: Docker phải được cài đặt và đang chạy trên máy (README.md:54-L55).

Các tùy chọn dòng lệnh

(README.md:57-L62)

Triển khai với Docker Compose

Cài đặt tiêu chuẩn

Phương thức này phù hợp cho môi trường production:

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

Truy cập ứng dụng tại http://localhost:3000 (README.md:64-L71).

Sử dụng mô hình AI cục bộ với Ollama

Để chạy Sim với các mô hình AI cục bộ (không cần external APIs):

bash
1# Với GPU support (tự động download gemma3:4b model)
2docker compose -f docker-compose.ollama.yml --profile setup up -d
3
4# Cho hệ thống chỉ có CPU:
5docker compose -f docker-compose.ollama.yml --profile cpu --profile setup up -d

(README.md:73-L83)

URL Ollama được cấu hình mặc định: http://ollama:11434 trong docker-compose.ollama.yml (docker-compose.ollama.yml:22-L23).

Thêm mô hình mới:

bash
1docker compose -f docker-compose.ollama.yml exec ollama ollama pull llama3.1:8b

(README.md:85-L88)

Sử dụng Ollama Instance bên ngoài

Nếu Ollama đang chạy trên host machine, sử dụng host.docker.internal thay vì localhost:

bash
1OLLAMA_URL=http://host.docker.internal:11434 docker compose -f docker-compose.prod.yml up -d

(README.md:90-L96)

Trên Linux, cần sử dụng IP address của host hoặc thêm extra_hosts: ["host.docker.internal:host-gateway"] vào compose file.

Cài đặt thủ công (Manual Setup)

Yêu cầu chi tiết

• Bun runtime
• Node.js v20+
• PostgreSQL 12+ với pgvector extension

(README.md:111-L113)

Bước 1: Clone và cài đặt dependencies

bash
1git clone https://github.com/simstudioai/sim.git
2cd sim
3bun install

(README.md:115-L121)

Bước 2: Thiết lập PostgreSQL với pgvector

Sử dụng Docker để chạy PostgreSQL:

bash
1docker run --name simstudio-db -e POSTGRES_PASSWORD=your_password -e POSTGRES_DB=simstudio -p 5432:5432 -d pgvector/pgvector:pg17

(README.md:123-L127)

Hoặc cài đặt thủ công theo pgvector guide.

Bước 3: Cấu hình biến môi trường

bash
1cp apps/sim/.env.example apps/sim/.env
2cp packages/db/.env.example packages/db/.env
3# Chỉnh sửa cả hai file .env để set DATABASE_URL="postgresql://postgres:your_password@localhost:5432/simstudio"

(README.md:131-L137)

Bước 4: Chạy migrations

bash
1cd packages/db && bunx drizzle-kit migrate --config=./drizzle.config.ts

(README.md:139-L143)

Bước 5: Khởi động development servers

bash
1bun run dev:full  # Khởi động cả Next.js app và realtime socket server

(README.md:145-L149)

Hoặc chạy riêng biệt:

• bun run dev (Next.js app)
• cd apps/sim && bun run dev:sockets (realtime server)

Biến môi trường bắt buộc

Các biến môi trường quan trọng

(README.md:160-L174)

Cấu hình trong Docker Compose

Các biến môi trường được cấu hình trong docker-compose.prod.yml:

yaml
1environment:
2  - DATABASE_URL=postgresql://${POSTGRES_USER:-postgres}:${POSTGRES_PASSWORD:-postgres}@db:5432/${POSTGRES_DB:-simstudio}
3  - BETTER_AUTH_URL=${NEXT_PUBLIC_APP_URL:-http://localhost:3000}
4  - NEXT_PUBLIC_APP_URL=${NEXT_PUBLIC_APP_URL:-http://localhost:3000}
5  - OLLAMA_URL=${OLLAMA_URL:-http://localhost:11434}

(docker-compose.prod.yml:11-L23)

Xác minh cài đặt

Kiểm tra trạng thái containers

bash
1docker compose -f docker-compose.prod.yml ps

Tất cả containers phải ở trạng thái "healthy" hoặc "running".

Kiểm tra sức khỏe services

Các healthcheck endpoints được cấu hình:

Healthcheck cấu hình (docker-compose.prod.yml:33-L38, docker-compose.prod.yml:60-L65, docker-compose.prod.yml:89-L93):

• simstudio: interval 90s, timeout 5s, 3 retries
• realtime: interval 90s, timeout 5s, 3 retries
• db: interval 5s, timeout 5s, 5 retries

Truy cập Web UI

Mở trình duyệt và truy cập http://localhost:3000. Nếu trang web hiển thị giao diện Sim, cài đặt thành công.

Dev Containers Setup

Yêu cầu

1. VS Code với Remote - Containers extension
2. Docker đang chạy

Các bước thực hiện

1. Mở project trong VS Code
2. Click "Reopen in Container" khi được提示
3. Chạy lệnh trong terminal:

bash
1bun run dev:full

Hoặc sử dụng alias sim-start (README.md:104-L109).

Lệnh này khởi động cả main application và realtime socket server.

Khắc phục sự cố thường gặp

Vấn đề 1: Cổng đã được sử dụng

Triệu chứng: Lỗi "port already in use" khi khởi động.

Nguyên nhân: Các cổng 3000, 3002, hoặc 5432 đã được sử dụng bởi process khác.

Giải pháp:

1. Kiểm tra process đang sử dụng cổng:

   bash
   1# Linux/macOS
   2lsof -i :3000
   3lsof -i :3002
   4lsof -i :5432

2. Dừng process đó hoặc thay đổi cổng trong docker-compose file
3. Hoặc set environment variable:

   bash
   1POSTGRES_PORT=5433 docker compose -f docker-compose.prod.yml up -d

(README.md:17-L17 - đề cập port conflicts là common issue)

Vấn đề 2: Docker không chạy

Triệu chứng: Lỗi "Cannot connect to the Docker daemon".

Giải pháp:

1. Kiểm tra Docker đã cài đặt:

   bash
   1docker --version

2. Khởi động Docker Desktop hoặc Docker service
3. Xác minh Docker đang chạy:

   bash
   1docker info

(README.md:17-L17 - đề cập "Docker not running" là common issue)

Vấn đề 3: Bộ nhớ không đủ

Triệu chứng: Containers bị kill hoặc OOM (Out of Memory).

Nguyên nhân: Hệ thống cần ít nhất 12GB RAM.

Giải pháp:

1. Kiểm tra RAM khả dụng:

   bash
   1# Linux
   2free -h
   3# macOS
   4vm_stat

2. Tăng giới hạn memory trong Docker Desktop settings
3. Giảm memory limits trong docker-compose file (không khuyến nghị)

(README.md:17-L17 - đề cập "Insufficient memory (needs 12GB+ RAM)")

Vấn đề 4: Database migration thất bại

Triệu chứng: Service migrations thoát với lỗi.

Giải pháp:

1. Kiểm tra logs:

   bash
   1docker compose -f docker-compose.prod.yml logs migrations

2. Xác minh DATABASE_URL đúng format
3. Đảm bảo database đang healthy trước khi migrations chạy

Thứ tự dependency (docker-compose.prod.yml:26-L32):

• simstudio phụ thuộc vào: db (healthy), migrations (completed), realtime (healthy)

Vấn đề 5: Không kết nối được Ollama

Triệu chứng: Lỗi kết nối đến Ollama khi sử dụng local models.

Giải pháp:

1. Kiểm tra Ollama container đang chạy:

   bash
   1docker compose -f docker-compose.ollama.yml ps ollama

2. Xác minh OLLAMA_URL đúng: http://ollama:11434 (trong Docker network)
3. Nếu chạy Ollama trên host, sử dụng:

   bash
   1OLLAMA_URL=http://host.docker.internal:11434

(docker-compose.ollama.yml:22-L23, README.md:90-L96)

Bảng so sánh các phương thức cài đặt

Các bước tiếp theo

Sau khi cài đặt thành công, có thể:

1. Khám phá Workflow Builder: Thiết kế agent workflows trực quan trên canvas - kết nối agents, tools, và blocks (README.md:20-L21)

2. Sử dụng Copilot: Tạo nodes, sửa lỗi, và iterate flows từ natural language (README.md:27-L28)

3. Tích hợp Vector Databases: Upload documents vào vector store để agents trả lời câu hỏi dựa trên nội dung cụ thể (README.md:34-L35)

4. Cấu hình Copilot API Key: Để sử dụng Copilot trên self-hosted instance:

   • Truy cập https://sim.ai → Settings → Copilot để generate API key
   • Set COPILOT_API_KEY trong file apps/sim/.env (README.md:153-L158)

5. Tham gia cộng đồng: Kết nối qua Discord hoặc follow Twitter @simdotai (README.md:10-L12)