feat(docs): add mintlify documentation with docker compose guide

This commit is contained in:
yiling
2026-06-04 11:19:52 +08:00
parent df3831bde3
commit 11b34736d2
7 changed files with 191 additions and 6 deletions
BIN
View File
Binary file not shown.

After

Width:  |  Height:  |  Size: 364 KiB

+98
View File
@@ -0,0 +1,98 @@
---
title: Get Started with Docker
description: Learn how to spin up the Shumai stack using Docker Compose.
---
We support two Docker Compose setups depending on your environment and use case:
1. **Local Pre-built Stack**: A lightweight setup to run the core API and frontend using pre-built images.
2. **Temporal Stack**: A production-like environment with full background worker orchestration (Agent and Transcode workers) and Temporal services, built from your local source code.
---
## Prerequisites
Before starting, ensure you have the following installed on your machine:
- **Docker**: [Install Docker Desktop](https://docs.docker.com/get-docker/) or Docker Engine.
- **Docker Compose**: Included in Docker Desktop, or [installed separately](https://docs.docker.com/compose/install/).
- **Git**: To clone and manage the repository.
---
## 1. Local Pre-built Stack
This setup runs a PostgreSQL database (with `pgvector`) and the Shumai application container.
### Step 1: Navigate to the local docker-compose folder
From the root of your Shumai workspace, run:
```bash
cd docker-compose/local
```
### Step 2: Start the services
Spin up the containers in detached mode:
```bash
docker compose up -d
```
### Step 3: Access the application
Once all containers are running and healthy:
- Open your browser and navigate to **`http://localhost:3000`** to access the Shumai Web UI.
### Step 4: Tear down
To stop and remove the containers, run:
```bash
docker compose down
```
---
## 2. Temporal Stack (Recommended for Development)
This setup builds the containers from your local workspace source code and starts the API, workers, and Temporal scheduler.
### Step 1: Navigate to the temporal docker-compose folder
From the root of your Shumai workspace, run:
```bash
cd docker-compose/temporal
```
### Step 2: Start the services
Build the images and run the full stack:
```bash
docker compose up -d --build
```
### Step 3: Access the services
- **Web UI**: Access the Shumai application at **`http://localhost:3000`**.
- **Temporal Dashboard**: View active workflows and orchestration logs at **`http://localhost:8080`**.
### Step 4: Tear down
To stop the services and clean up volumes, run:
```bash
docker compose down -v
```
---
## Troubleshooting
### Port Conflicts
If you receive port conflict errors, ensure that port `3000` (Web UI), `5432` (PostgreSQL), `7233` (Temporal), or `8080` (Temporal UI) are not currently being used by other processes on your machine.
+26
View File
@@ -0,0 +1,26 @@
---
title: Introduction
description: Welcome to Shumai, a modern AI agent and media processing platform.
---
## What is Shumai?
**Shumai** is a highly decoupled, modular platform built with a layered monorepo architecture. It integrates a React-based frontend, a fast Hono API backend, business logic services, and background workflow engines (supporting both local and Temporal-based execution).
### Key Features
- **Decoupled Monorepo Structure**: Managed via Bun Workspaces, ensuring each domain or layer is its own self-contained package.
- **Robust API & Core Service Layers**: Built on Bun and Hono, featuring strict end-to-end type safety with Zod schemas and DTOs.
- **Workflow & Activity Engine**: An orchestration engine capable of polling-based execution locally and enterprise-grade execution via Temporal.
- **Modern UI**: A responsive, clean React interface powered by Tailwind CSS and Shadcn UI.
- **Database Resilience**: Prisma ORM with PostgreSQL and `pgvector` for vector similarity and search capabilities.
## Explore the Documentation
Start by setting up Shumai on your local machine using our step-by-step guides.
<CardGroup cols={2}>
<Card title="Get Started with Docker" icon="docker" href="/getting-started/docker">
Learn how to build and spin up the Shumai stack quickly using Docker Compose.
</Card>
</CardGroup>
+35
View File
@@ -0,0 +1,35 @@
<svg viewBox="0 0 100 100" fill="none" xmlns="http://www.w3.org/2000/svg">
<defs>
<clipPath id="bg-clip">
<rect x="5" y="5" width="90" height="90" rx="22" />
</clipPath>
</defs>
<!-- Background -->
<rect x="5" y="5" width="90" height="90" rx="22" fill="#D95A66" />
<!-- Long Shadow -->
<path
d="M 35 75 L 65 75 L 80 60 L 75 30 L 175 130 L 135 175 Z"
fill="#A8384D"
clipPath="url(#bg-clip)"
/>
<!-- Left Cream -->
<path d="M 25 30 Q 38 36 50 42 L 35 55 L 35 75 L 20 60 Z" fill="#FDF0D5" />
<!-- Right Orange -->
<path d="M 50 42 Q 62 36 75 30 L 80 60 L 65 75 L 65 55 Z" fill="#E77A65" />
<!-- Front Peach -->
<path d="M 35 75 L 65 75 L 65 55 L 50 42 L 35 55 Z" fill="#F5B895" />
<!-- Top Pink -->
<path d="M 50 42 Q 38 36 25 30 Q 38 26 50 20 Q 62 26 75 30 Q 62 36 50 42 Z" fill="#F4B8B8" />
<!-- Hole Left -->
<path d="M 50 25 L 42 30 L 50 35 Z" fill="#E57A5F" />
<!-- Hole Right -->
<path d="M 50 25 L 58 30 L 50 35 Z" fill="#C2523C" />
</svg>

After

Width:  |  Height:  |  Size: 1016 B

+20
View File
@@ -0,0 +1,20 @@
{
"$schema": "https://mintlify.com/schema.json",
"name": "Shumai",
"logo": {
"light": "/logo.svg",
"dark": "/logo.svg"
},
"favicon": "/favicon.ico",
"colors": {
"primary": "#D95A66",
"light": "#F5B895",
"dark": "#A8384D"
},
"navigation": [
{
"group": "Getting Started",
"pages": ["introduction", "getting-started/docker"]
}
]
}
+4 -2
View File
@@ -195,7 +195,8 @@ describe('AgentService', () => {
const svc = new AgentService()
const { team, provider, model } = await setupTestData(db)
const avatarPresigned = 'https://shumai.s3.amazonaws.com/files/01JK23456789ABCDEF01234567?AWSAccessKeyId=foo'
const avatarPresigned =
'https://shumai.s3.amazonaws.com/files/01JK23456789ABCDEF01234567?AWSAccessKeyId=foo'
const agent = await svc.createAgent({
teamId: team.id,
name: 'Agent with URL',
@@ -216,7 +217,8 @@ describe('AgentService', () => {
const svc = new AgentService()
const { agent } = await setupTestData(db)
const avatarPresigned = 'https://shumai.s3.amazonaws.com/files/01JK23456789ABCDEF01234567?AWSAccessKeyId=foo'
const avatarPresigned =
'https://shumai.s3.amazonaws.com/files/01JK23456789ABCDEF01234567?AWSAccessKeyId=foo'
const updated = await svc.updateAgent({
agentId: agent.id,
name: 'Updated with URL',
File diff suppressed because one or more lines are too long