Compare commits

...
98 Commits
Author SHA1 Message Date
yiling 438ea79535 Release v0.0.7 2026-06-17 17:02:21 +08:00
Yiling-J 3455cd0b13 Merge pull request #121 from shumaiOne/feat/api-protocol-enum
feat(api): use enum for API protocol in provider config
2026-06-17 16:48:52 +08:00
yiling 2aba1c898b feat(core): allow deleting builtin providers 2026-06-17 16:39:23 +08:00
yiling 6f91b9e809 feat(webui): allow deleting builtin providers and improve dialog layout 2026-06-17 16:31:51 +08:00
yiling 10760f5a57 fix(webui): finalize provider dialog layout for better scrolling 2026-06-17 16:26:10 +08:00
yiling c150f62b4c fix(webui): improve dialog layout for scrollable content 2026-06-17 16:15:04 +08:00
yiling 1284c1de3f fix(webui): make model list in provider dialog scrollable 2026-06-17 16:12:35 +08:00
yiling 0c89616a4e feat(api): use enum for API protocol in provider config 2026-06-17 16:07:48 +08:00
Yiling-J 96a682b414 Merge pull request #118 from shumaiOne/docs/improve-shumai-docs
docs: improve and restructure shumai documentation
2026-06-17 15:48:00 +08:00
Yiling-J 5f8067cbe8 Merge pull request #120 from shumaiOne/feat/replace-overflow-with-scrollarea
feat(webui): replace native overflow with shadcn ScrollArea in settings
2026-06-17 15:43:09 +08:00
yiling ae39a98e84 feat(webui): replace native overflow with shadcn ScrollArea in settings 2026-06-17 15:41:43 +08:00
Yiling-J 0944f1ad8e Merge pull request #119 from shumaiOne/feat/ui-system-colors
feat(webui): replace hardcoded colors with system tokens
2026-06-17 15:23:46 +08:00
yiling 812a8b3b88 feat(webui): replace hardcoded colors with system tokens in settings components 2026-06-17 15:22:46 +08:00
yiling 24a2f74035 update ui 2026-06-17 11:54:42 +08:00
yiling 73d02bf319 docs: convert screenshots to webp and update documentation 2026-06-17 11:37:48 +08:00
yiling 6e98d6ee4a docs: document collection creation from search dialog and dragging assets to share links 2026-06-16 16:34:43 +08:00
yiling af381ff99c docs: update notifications and metadata documentation to match UI/API configurations 2026-06-16 16:27:11 +08:00
yiling c9da7794d9 docs: explain team member visibility scopes and role overrides 2026-06-16 15:51:35 +08:00
yiling 1fb03cd852 docs: describe unified team and project members dialog 2026-06-16 15:45:59 +08:00
yiling 74fff87a2b docs: describe search filter dialog and drag reorder rules 2026-06-16 15:33:33 +08:00
yiling 3af5940ddf docs: update version stack creation workflows 2026-06-16 15:21:10 +08:00
yiling 3bb44041d7 docs: rename upload to asset management and add delete and clipboard paste docs 2026-06-16 15:13:26 +08:00
yiling 29b7124f48 docs: move temporal deployment guide to separate advanced deployment section 2026-06-16 14:56:38 +08:00
yiling 718f50ef10 docs: add temporal deploy guide and link from quickstart 2026-06-16 14:53:03 +08:00
yiling 006774042a docs: refine documentation to be user-oriented and remove database jargon 2026-06-16 14:44:42 +08:00
yiling 2b058bde40 docs: remove legacy introduction and docker docs 2026-06-16 14:39:04 +08:00
yiling fc6ad20329 docs: improve and restructure shumai documentation 2026-06-16 12:15:53 +08:00
Yiling-J 7e5735f0cc Merge pull request #116 from shumaiOne/feat/concurrency-control
feat(workflow): configure transcode and agent concurrency via environment variables
2026-06-16 10:46:45 +08:00
yiling 6e74ede9fe fix(workflow): validate concurrency limits and fallback to defaults on invalid or non-positive values 2026-06-16 10:40:39 +08:00
yiling b8d876d28e feat(workflow): allow configuring transcode and agent concurrency via environment variables 2026-06-16 10:24:45 +08:00
Yiling-J 95984f19b1 Merge pull request #115 from shumaiOne/refactor/transcode-service-and-api-flattening
refactor(transcode): relocate TranscodeService to core and flatten API package
2026-06-16 09:58:25 +08:00
yiling 5111fcd6a5 refactor(transcode): address code review feedback on imports and dataFormatNames typing 2026-06-16 09:53:28 +08:00
yiling f16a8a7069 refactor(transcode): relocate TranscodeService to core and flatten API package 2026-06-16 09:47:27 +08:00
Yiling-J 7f6e41708a Merge pull request #114 from shumaiOne/fix/video-player-carousel-change
fix(webui): reload video player and reset state when switching assets
2026-06-16 09:35:23 +08:00
yiling 6fa69d3310 fix(webui): use fileData?.id as reset dependency to prevent loading race conditions 2026-06-16 09:25:40 +08:00
yiling 7c5f462ba5 fix(webui): reload video player and reset state when switching assets 2026-06-16 09:21:56 +08:00
yiling 5d778f1b43 Release v0.0.6 2026-06-15 23:28:18 +08:00
Yiling-J 6027c2c21c Merge pull request #113 from shumaiOne/fix/video-player-mime-type
fix(webui): force video-player mime type to video/mp4
2026-06-15 23:23:57 +08:00
yiling d0931b7181 fix(webui): force video-player mime type to video/mp4 for transcode compatibility 2026-06-15 23:17:44 +08:00
yiling 2220d35e40 regenerate providers 2026-06-15 22:42:11 +08:00
Yiling-J bbf55e22da Merge pull request #112 from shumaiOne/fix/optimize-reorder-query
fix(webui): avoid refetching all pages on file/folder reorder
2026-06-15 22:20:26 +08:00
yiling 68d0830d05 fix(webui): resolve drag-and-drop cross-row reordering layout shift 2026-06-15 22:13:46 +08:00
yiling 2858274e52 fix(core): inherit sortIndex when creating version stack container 2026-06-15 20:38:46 +08:00
yiling 45318d1eec fix(core): correctly query nextAsset for afterIndex reordering 2026-06-15 20:25:49 +08:00
yiling e8e04edfee fix(webui): address code review feedback for updateLocalCache 2026-06-15 19:57:02 +08:00
yiling cf2546c861 migration(db): add C collation to sort_index column 2026-06-15 19:51:59 +08:00
yiling 1f640ede19 test(core): add test reproducing fractional indexing collation mismatch 2026-06-15 19:33:51 +08:00
yiling 3b4751bcb2 fix(webui): avoid refetching all pages on file/folder reorder 2026-06-15 19:20:45 +08:00
Yiling-J d766edbbd0 Merge pull request #111 from shumaiOne/feat/file-detail-sidebar-carousel
feat(webui): always show right sidebar and implement left vertical carousel
2026-06-15 16:45:58 +08:00
yiling 673041e28a feat(webui): support responsive layout and transparent bg for left sidebar carousel 2026-06-15 16:35:34 +08:00
yiling eabf49f6e3 fix(webui): use callback ref for image viewer to ensure ResizeObserver setup during file type switches 2026-06-15 16:14:30 +08:00
yiling f226bc74c6 feat(webui): render bottom bar for all file types and layout carousel above it 2026-06-15 16:02:18 +08:00
yiling 2159ddfeb5 style(webui): refine carousel item sizes, active states, and background colors 2026-06-15 15:51:23 +08:00
yiling 813c003a10 style(webui): transparent carousel background, hidden scrollbar, and 60x60px active items 2026-06-15 15:45:18 +08:00
yiling 720710dbbf fix(webui): move carousel hooks before early returns to satisfy React Hook rules 2026-06-15 15:39:10 +08:00
yiling 68a1714e7f feat(webui): always show right sidebar and implement left vertical carousel 2026-06-15 15:37:10 +08:00
Yiling-J d8aaed5212 Merge pull request #110 from shumaiOne/fix/mention-agents-file-list
refactor(webui): fetch agents in mention input list dynamically
2026-06-15 11:35:32 +08:00
yiling 60c499c153 refactor(webui): fetch agents in mention input list dynamically 2026-06-15 11:30:49 +08:00
Yiling-J a9c6686843 Merge pull request #109 from shumaiOne/feat/sandbox-pending-domains
feat(sandbox): add pending domains support for network sandbox
2026-06-15 11:03:32 +08:00
yiling c2f6c85194 fix(agent): remove port from sandbox pendingDomains to match allowedDomains format 2026-06-15 10:52:53 +08:00
yiling 8e012f9353 fix(agent): reset SandboxManager before initializing to ensure fresh config for every session 2026-06-15 10:36:01 +08:00
yiling c55abbf724 fix(webui): prevent overflow on long domain names in sandbox settings 2026-06-15 09:34:36 +08:00
yiling e9e096ac9e feat(sandbox): reject blocked request on bash tool result 2026-06-15 09:28:11 +08:00
yiling 6a63e99044 feat(sandbox): add pending domains support for network sandbox 2026-06-15 00:01:55 +08:00
Yiling-J 9c3b808809 Merge pull request #108 from shumaiOne/fix/player-seekbar-drag-color
fix(player): implement seekbar dragging and match hover highlight color
2026-06-14 22:47:51 +08:00
yiling c6387dd4ef fix(player): implement seekbar dragging and match hover highlight color 2026-06-14 22:42:55 +08:00
Yiling-J a1dfc8b4f9 Merge pull request #107 from shumaiOne/feat/smooth-progress-bar
refactor(webui): use requestAnimationFrame for smooth video progress bar updates
2026-06-14 21:11:31 +08:00
yiling 443b099e12 refactor(webui): move onTimeUpdate out of requestAnimationFrame loop
Moves the onTimeUpdate callback back into the native low-frequency timeupdate handler to avoid parent performance degradation, and removes it from the requestAnimationFrame loop and useEffect dependency array.
2026-06-14 21:06:39 +08:00
yiling e9e9be71f4 refactor(webui): use requestAnimationFrame for smooth video progress bar updates
Updates the progress bar currentTime and progress state on requestAnimationFrame loops when playing, while keeping timeupdate as a fallback when paused.
2026-06-14 21:01:15 +08:00
Yiling-J 3ae74d6417 Merge pull request #106 from shumaiOne/refactor/video-player-system-colors
refactor(webui): use system color design tokens in video player components
2026-06-14 20:46:46 +08:00
yiling 821de71719 fix(webui): remove debug console.log from GuestIdentityPopup 2026-06-14 20:25:43 +08:00
yiling cbc0a7960d refactor(webui): use system color design tokens in video player components 2026-06-14 19:47:00 +08:00
Yiling-J 0e2384627d Merge pull request #105 from shumaiOne/docs/improve-readme-deployment-temporal
docs(readme): improve remote deployment and temporal execution instructions
2026-06-14 19:34:57 +08:00
yiling 0a0a8f973d docs(readme): add FFmpeg prerequisites and WORKFLOW_EXECUTOR env variable 2026-06-14 17:21:46 +08:00
yiling fc3baede99 docs(readme): correct S3 endpoint environment variable names 2026-06-14 16:20:55 +08:00
Yiling-J ca31ef02fd Change header level for Shumai Agent section 2026-06-14 16:10:25 +08:00
yiling 2824377600 docs(readme): add Agent Sandbox platform support and OS dependencies details 2026-06-14 16:06:35 +08:00
Yiling-J f285b9e327 Update README with website and documentation links
Added links to website, documentation, and demo in the README.
2026-06-14 15:24:58 +08:00
yiling 42d89eb88d docs(readme): add worker network and region proximity recommendations 2026-06-14 15:18:31 +08:00
Yiling-J 8d8eeaaf47 Update README for clarity and consistency 2026-06-14 15:10:09 +08:00
yiling 8c55897d80 refactor(auth): remove BETTER_AUTH_URL configuration and set a default baseURL fallback 2026-06-14 15:01:44 +08:00
yiling 1790149986 docs(readme): improve remote deployment and temporal execution instructions 2026-06-14 11:04:04 +08:00
Yiling-J 88e5440d5c Merge pull request #104 from shumaiOne/fix/temporal-transcode-retry
fix(transcode): make deterministic transcode activity failures non-retryable in Temporal
2026-06-14 10:39:38 +08:00
yiling d687ea495b fix(transcode): make deterministic transcode activity failures non-retryable in Temporal 2026-06-14 10:00:13 +08:00
Yiling-J e437cdfeaf Merge pull request #103 from shumaiOne/docs/add-readme
docs(readme): add comprehensive README.md
2026-06-13 22:34:32 +08:00
yiling 0294056ad9 docs(readme): clarify background worker requirements in temporal mode 2026-06-13 17:56:30 +08:00
yiling 5cf949abc0 docs(readme): update temporal setup to use curl instead of cd 2026-06-13 17:50:22 +08:00
yiling e21d419bfe docs(readme): update screenshot.webp and remove screenshot.png 2026-06-13 17:47:26 +08:00
yiling 4159c0737c docs(readme): convert screenshot.png to webp format and reference it 2026-06-13 17:44:45 +08:00
yiling 9a2bf1deaf docs(readme): use pre-rendered rounded logo with width 65 2026-06-13 17:30:54 +08:00
yiling 1a43fad77b docs(readme): update logo styling, docker instructions, and env example 2026-06-13 14:21:56 +08:00
yiling b5fb378cf8 docs(readme): add comprehensive README.md 2026-06-13 13:26:42 +08:00
Yiling-J 782316ca97 Merge pull request #102 from shumaiOne/fix/wrapper-cleanup-on-kill
fix(build): propagate termination signals to active child process in wrappers
2026-06-13 12:58:23 +08:00
yiling e5084cc8b3 fix(build): propagate termination signals to active child process in wrappers 2026-06-13 12:51:30 +08:00
yiling 02b009fbe1 Release v0.0.5 2026-06-13 10:32:59 +08:00
Yiling-J 6dcd08ae3a Merge pull request #101 from shumaiOne/feat/npm-auto-migration
feat(npm): auto deploy database migrations on package start
2026-06-13 10:27:11 +08:00
yiling d230a1fd4a feat(npm): add dotenv loading and fix variable interpolation in wrapper 2026-06-13 10:21:36 +08:00
yiling 210ed5f95a feat(npm): auto deploy database migrations on package start 2026-06-13 09:24:54 +08:00
158 changed files with 5420 additions and 2450 deletions
-3
View File
@@ -46,6 +46,3 @@ jobs:
- name: Test Local Release
run: |
bun run release:local --skip-check --out /tmp/shumai-local-release --force
cd /tmp/shumai-local-release/node
npx shumai-agent
npx shumai-transcode
+1 -1
View File
@@ -244,7 +244,7 @@ The `bunfig.toml` is configured to run `setup-tests.ts` automatically as a prelo
### API Tests
- Located in `packages/api/src/api/**/*.test.ts`.
- Located in `packages/api/src/**/*.test.ts`.
- Mock the Service layer using `vi.spyOn(service, 'method')` or `vi.mock('@shumai/core/src/team/team')`.
- Verify that the API calls the Service methods correctly.
+280
View File
@@ -0,0 +1,280 @@
<p align="center">
<img src="docs/logo-rounded.png" alt="Shumai Logo" width="65" />
</p>
<h1 align="center">Shumai</h1>
<p align="center">
<strong>An open-source platform for all your creative work.</strong>
</p>
<p align="center">
<a target="_blank" href="https://shumai.one/">Website</a> | <a target="_blank" href="https://docs.shumai.one/introduction">Docs</a> | <a target="_blank" href="https://staging.shumai.one">Demo</a>
</p>
![Shumai App Screenshot](docs/screenshot.webp)
## Features
- **S3-Compatible & Local FS Storage**: Securely store and serve your creative assets using local filesystems or any S3-compatible cloud storage (AWS S3, Cloudflare R2, MinIO, etc.).
- **Comments with Draw Annotations & Timestamps**: Give precise feedback with frame-specific drawing tools and exact timestamps directly on video and image assets.
- **Easy Share Links & Collections**: Create secure external share links and curated media collections to collaborate with external clients and stakeholders.
- **Team & Project Member Management**: Manage granular workspace permissions using team-level and project-level role-based access control.
- **Scalable Transcode Workflows via Temporal**: Offload resource-heavy video transcoding to a reliable background worker pool orchestrated by Temporal.
- **Flexible Asset Metadata System**: Customize your workspace metadata with dynamic, user-defined fields tailored to your production pipeline.
#### Shumai Agent
- **Chat with Agent as a Collaborator**: Converse with a context-aware AI agent directly within your project workspace.
- **Extend Agent with Skills**: Easily register new tools and custom skills for the agent to run and automate workflows.
- **Secure Sandboxed Execution**: Execute agent scripts and tasks in a secure, isolated sandbox environment.
- **AI-Powered Metadata Autofill**: Automatically generate tags, descriptions, and custom metadata for new assets using Google Gemini.
- **Semantic Asset Search**: Find assets instantly based on their visual and textual content using vector embeddings.
---
## Installation
### Option 1: Docker Compose (Quick Start)
The easiest way to run Shumai is using Docker Compose. You do not need to clone the repository:
1. Create a `docker-compose.yaml` file by copying the configuration from [GitHub](https://github.com/shumaiOne/shumai/blob/main/docker-compose/local/docker-compose.yaml) or download it directly:
```bash
curl -o docker-compose.yaml https://raw.githubusercontent.com/shumaiOne/shumai/main/docker-compose/local/docker-compose.yaml
```
2. Configure environment variables (if deploying remotely):
If you are deploying Shumai to a remote server (e.g., AWS ECS, EC2, VPS), you must edit `docker-compose.yaml`, set `AWS_ENDPOINT_URL_S3` to your server's public IP or domain name (e.g., `http://12.345.567.789:3000`).
3. Start the services:
```bash
docker compose up -d
```
4. Access the application in your browser at `http://localhost:3000` (or `http://<your-server-ip>:3000` for remote deployments).
### Option 2: Install from NPM
You can run Shumai using the npm package `@shumai-one/shumai`. This option allows you to install and run Shumai globally or locally via your favorite package manager.
#### Step 1: Start PostgreSQL with pgvector
Shumai requires PostgreSQL with the `pgvector` extension. You can spin up a pre-configured database container using Docker:
```bash
docker run --name shumai_postgres \
-e POSTGRES_USER=shumai \
-e POSTGRES_PASSWORD=shumai_password \
-e POSTGRES_DB=shumai_db \
-p 5432:5432 \
-d pgvector/pgvector:pg18
```
#### Step 2: Install Shumai globally
Install the main Shumai package using `npm`, `pnpm`, `bun`, or `yarn`:
> [!IMPORTANT]
> **Prerequisites**:
>
> - **Agent Sandbox**: Because Shumai uses a secure sandboxed execution environment for its AI agents, your machine must meet the platform requirements for the sandbox. Please verify you have installed the required dependencies for your OS as detailed in the [Agent Sandbox Platform Support](#agent-sandbox-platform-support) section.
> - **FFmpeg & FFprobe**: Shumai requires `ffmpeg` and `ffprobe` to be installed on your system path for handling media transcoding and metadata extraction.
> - macOS: `brew install ffmpeg`
> - Ubuntu/Debian: `sudo apt-get install ffmpeg`
> - Fedora: `sudo dnf install ffmpeg`
```bash
npm install -g @shumai-one/shumai
# or: pnpm add -g @shumai-one/shumai
# or: bun add -g @shumai-one/shumai
```
#### Step 3: Configure Environment Variables
Create a new directory for your Shumai configuration and navigate into it:
```bash
mkdir shumai
cd shumai
```
Create a `.env` file in this folder and add the following configuration (which aligns with the Docker database command in Step 1):
```env
DATABASE_URL=postgresql://shumai:shumai_password@localhost:5432/shumai_db?schema=public
BETTER_AUTH_SECRET=ySxs7DxzHDZBbeeHNPEwBuspYwipBqz5Gk5XdBjNhWw=
STORAGE_BACKEND=local
AWS_ENDPOINT_URL_S3=http://localhost:3000
```
> [!NOTE]
> If you are deploying on a remote server, make sure to change `AWS_ENDPOINT_URL_S3` from `http://localhost:3000` to your server's public IP address or domain name.
#### Step 4: Run Shumai
Start the application from your configuration folder:
```bash
shumai
```
On startup, Shumai will automatically run the necessary database migrations and start the web server at `http://localhost:3000`.
---
### Option 3: Run from Source
To run Shumai locally for development:
1. Clone the repository and install dependencies:
```bash
git clone https://github.com/shumaiOne/shumai.git
cd shumai
bun install
```
2. Start the `pgvector` database container (as described in Option 2, Step 1).
3. Create a `.env` file at the root of the workspace using the example configuration from Option 2, Step 3.
4. Run the database migrations:
```bash
bun run db:migrate
```
5. Start the development server:
```bash
bun run dev
```
---
## Advanced: Distributed Execution with Temporal
For production environments or workloads with heavy media processing and AI agent requirements, Shumai can delegate background activities to **Temporal**. This provides distributed queue management, task retries, and high availability.
### How it works
By setting the environment variable `WORKFLOW_EXECUTOR=temporal`, the main Shumai application will delegate background workflows to a Temporal cluster instead of using the local polling-based engine. This allows you to run independent worker processes (`shumai-agent` and `shumai-transcode`) on separate specialized machines (e.g., transcoding workers on GPU-accelerated instances, and agents on sandboxed environments).
> [!IMPORTANT]
> **Storage Requirement**: Because the main Shumai application and the background workers run on different machines in a distributed setup, **you must use S3-compatible storage** (e.g., AWS S3, Cloudflare R2, MinIO). Local storage (`STORAGE_BACKEND=local`) will not work because the workers and the main application do not share a common local filesystem.
### 1. Set up the Core Stack
Spin up the database, Temporal server, and the main Shumai web application on your primary host machine using Docker Compose:
1. Download the Temporal-enabled `docker-compose.yaml` file:
```bash
curl -o docker-compose.yaml https://raw.githubusercontent.com/shumaiOne/shumai/main/docker-compose/temporal/docker-compose.yaml
```
2. Configure the environment variables in `docker-compose.yaml`:
- Set the S3 storage environment variables (`AWS_ENDPOINT_URL_S3`, `S3_REGION`, `S3_BUCKET`, etc.).
- If deploying to a remote host (e.g., AWS ECS, EC2, VPS), update `AWS_ENDPOINT_URL_S3` under the `shumai` service to your server's public IP address or domain name.
- Note: The `TEMPORAL_ADDRESS` environment variable for the main Shumai application is pre-configured as `temporal:7233` (referencing the Temporal container within the same Docker network) and does not need to be changed.
3. Start the services:
```bash
docker compose up -d
```
This exposes the Shumai Web UI at `http://<host-ip>:3000`, the database at port `5432`, the Temporal gRPC service at port `7233`, and the Temporal dashboard at `http://<host-ip>:8080`. Ensure that port `7233` is exposed and accessible by your background worker machines.
### 2. Run the Background Workers
When running in Temporal mode, the main Shumai application only submits tasks to the Temporal queue. To process these tasks, you must run at least one agent worker and one transcoding worker on their respective machines.
> [!NOTE]
> **Network & Access Requirements**:
>
> - Both the transcode worker and the agent worker must have network access to the PostgreSQL database and the S3-compatible storage.
> - Because the transcode worker needs to download and upload large media files for transcoding, it is highly recommended to deploy the transcode worker in the same cloud provider and region as your S3 storage to minimize transfer latency and data egress fees.
Configure a `.env` file on each worker machine. It must contain the following variables:
```env
DATABASE_URL=postgresql://shumai:shumai_password@<host-ip>:5432/shumai_db?schema=public
WORKFLOW_EXECUTOR=temporal
TEMPORAL_ADDRESS=<host-ip>:7233
STORAGE_BACKEND=s3
AWS_ENDPOINT_URL_S3=http://<host-ip>:3000 # Or your public S3/R2 endpoint URL
S3_REGION=us-east-1
S3_BUCKET=shumai
S3_ACCESS_KEY_ID=your-access-key-id
S3_SECRET_ACCESS_KEY=your-secret-access-key
```
Run the workers:
- **Transcoding Worker**:
Install `@shumai-one/shumai-transcode` and run it on a machine with sufficient transcoding resources:
> [!IMPORTANT]
> **FFmpeg Requirement**: The transcoding worker requires `ffmpeg` and `ffprobe` to be installed and available on the machine's system path.
>
> - macOS: `brew install ffmpeg`
> - Ubuntu/Debian: `sudo apt-get install ffmpeg`
```bash
npm install -g @shumai-one/shumai-transcode
# Run worker with the configured .env
shumai-transcode
```
- **AI Agent Worker**:
Install `@shumai-one/shumai-agent` and run it on a machine configured for Agent tasks:
> [!IMPORTANT]
> Because the AI Agent worker runs sandboxed agent scripts, the host machine must have the necessary dependencies installed. Please refer to [Agent Sandbox Platform Support](#agent-sandbox-platform-support) for setup details.
```bash
npm install -g @shumai-one/shumai-agent
# Run worker with the configured .env (must include GEMINI_API_KEY)
shumai-agent
```
---
## Agent Sandbox Platform Support
Shumai uses `anthropic-experimental/sandbox-runtime` to execute AI agent scripts and tasks in a secure, isolated sandbox environment. When installing Shumai or the AI Agent worker from NPM, ensure your host platform meets the following requirements:
### Platform Support
- **macOS**: Uses `sandbox-exec` with custom profiles (no additional OS-level containerization dependencies).
- **Linux**: Uses `bubblewrap` (bwrap) for containerization.
- **Windows**: Not yet supported.
### Platform-Specific Dependencies
#### Linux
The following system packages must be installed on your Linux host:
- `bubblewrap` - Container runtime
- Ubuntu/Debian: `sudo apt-get install bubblewrap`
- Fedora: `sudo dnf install bubblewrap`
- Arch: `sudo pacman -S bubblewrap`
- `socat` - Socket relay for proxy bridging
- Ubuntu/Debian: `sudo apt-get install socat`
- Fedora: `sudo dnf install socat`
- Arch: `sudo pacman -S socat`
- `ripgrep` - Fast search tool for deny path detection
- Ubuntu/Debian: `sudo apt-get install ripgrep`
- Fedora: `sudo dnf install ripgrep`
- Arch: `sudo pacman -S ripgrep`
**Ubuntu 24.04+ Note**: These releases restrict unprivileged user namespaces by default. Disable this restriction so that `bubblewrap` and the seccomp isolation layer can function:
```bash
sudo sysctl -w kernel.apparmor_restrict_unprivileged_userns=0
```
**Optional Linux Dependencies (for seccomp fallback)**:
Pre-generated seccomp filters are provided for x86-64 and arm architectures. If you run on a different architecture, you will need a C compiler and development files:
- `gcc` or `clang`
- `libseccomp` development headers
- Ubuntu/Debian: `sudo apt-get install gcc libseccomp-dev`
- Fedora: `sudo dnf install gcc libseccomp-devel`
- Arch: `sudo pacman -S gcc libseccomp`
#### macOS
The following dependencies are required on macOS:
- `ripgrep` - Fast search tool for deny path detection
- Install via Homebrew: `brew install ripgrep`
- Or download from: https://github.com/BurntSushi/ripgrep/releases
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "@shumai/agent-app",
"version": "0.0.4",
"version": "0.0.7",
"private": true,
"type": "module",
"bin": {
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "@shumai/transcode-app",
"version": "0.0.4",
"version": "0.0.7",
"private": true,
"type": "module",
"bin": {
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "@shumai/web-app",
"version": "0.0.4",
"version": "0.0.7",
"private": true,
"type": "module",
"dependencies": {
+12 -12
View File
@@ -32,7 +32,7 @@
},
"apps/agent": {
"name": "@shumai/agent-app",
"version": "0.1.0",
"version": "0.0.6",
"bin": {
"shumai-agent": "./src/index.ts",
},
@@ -44,7 +44,7 @@
},
"apps/transcode": {
"name": "@shumai/transcode-app",
"version": "0.1.0",
"version": "0.0.6",
"bin": {
"shumai-transcode": "./src/index.ts",
},
@@ -56,7 +56,7 @@
},
"apps/web": {
"name": "@shumai/web-app",
"version": "0.1.0",
"version": "0.0.6",
"dependencies": {
"@shumai/agent": "workspace:*",
"@shumai/api": "workspace:*",
@@ -71,7 +71,7 @@
},
"packages/agent": {
"name": "@shumai/agent",
"version": "0.1.0",
"version": "0.0.6",
"dependencies": {
"@anthropic-ai/sandbox-runtime": "0.0.52",
"@earendil-works/pi-agent-core": "0.78.0",
@@ -95,7 +95,7 @@
},
"packages/api": {
"name": "@shumai/api",
"version": "0.1.0",
"version": "0.0.6",
"dependencies": {
"@hono/zod-validator": "0.7.6",
"@shumai/core": "workspace:*",
@@ -109,7 +109,7 @@
},
"packages/core": {
"name": "@shumai/core",
"version": "0.1.0",
"version": "0.0.6",
"dependencies": {
"@shumai/db": "workspace:*",
"@shumai/dtos": "workspace:*",
@@ -123,6 +123,7 @@
"hono": "4.12.23",
"jittered-fractional-indexing": "1.0.1",
"pino": "10.3.1",
"sharp": "0.34.5",
"tweetnacl": "1.0.3",
"ulid": "3.0.2",
"yaml": "2.9.0",
@@ -135,7 +136,7 @@
},
"packages/db": {
"name": "@shumai/db",
"version": "0.1.0",
"version": "0.0.6",
"dependencies": {
"@earendil-works/pi-agent-core": "0.78.0",
"@prisma/adapter-pg": "7.8.0",
@@ -151,14 +152,14 @@
},
"packages/dtos": {
"name": "@shumai/dtos",
"version": "0.1.0",
"version": "0.0.6",
"dependencies": {
"zod": "4.4.3",
},
},
"packages/transcode": {
"name": "@shumai/transcode",
"version": "0.1.0",
"version": "0.0.6",
"dependencies": {
"@shumai/core": "workspace:*",
"@shumai/db": "workspace:*",
@@ -167,13 +168,12 @@
"@temporalio/activity": "1.17.2",
"@temporalio/worker": "1.17.2",
"@temporalio/workflow": "1.17.2",
"sharp": "0.34.5",
"ulid": "3.0.2",
},
},
"packages/webui": {
"name": "@shumai/webui",
"version": "0.1.0",
"version": "0.0.6",
"dependencies": {
"@base-ui/react": "1.5.0",
"@dnd-kit/abstract": "0.4.0",
@@ -273,7 +273,7 @@
},
"packages/workflow-core": {
"name": "@shumai/workflow-core",
"version": "0.1.0",
"version": "0.0.6",
"dependencies": {
"@shumai/core": "workspace:*",
"@shumai/db": "workspace:*",
-1
View File
@@ -32,7 +32,6 @@ services:
# Better Auth
BETTER_AUTH_SECRET: qSxs9DxzHDZBbeeTNPEwBuspYwipBqz5Gk5XdBjNhWw=
BETTER_AUTH_URL: https://staging.shumai.one/
depends_on:
postgres:
@@ -33,7 +33,6 @@ services:
S3_ACCESS_KEY_ID: ID
S3_SECRET_ACCESS_KEY: KEY
BETTER_AUTH_SECRET: qSxs9DxzHDZBbeeTNPEwBuspYwipBqz5Gk5XdBjNhWw=
BETTER_AUTH_URL: http://localhost:3000
WORKFLOW_EXECUTOR: temporal
TEMPORAL_ADDRESS: temporal:7233
GEMINI_API_KEY: KEY
BIN
View File
Binary file not shown.

After

Width:  |  Height:  |  Size: 39 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 93 KiB

+72
View File
@@ -0,0 +1,72 @@
---
title: Environment Variables
description: Comprehensive configuration reference for Shumai.
---
Shumai is configured via environment variables. You can define these variables in a `.env` file at the root of your application workspace, or pass them directly to your Docker containers.
---
## Database Config
| Variable | Description | Example / Default |
| :------------- | :----------------------------------------------------------------------------------------- | :------------------------------------------------------- |
| `DATABASE_URL` | PostgreSQL connection URL. Must target a database with the `pgvector` extension installed. | `postgresql://user:pass@localhost:5432/db?schema=public` |
---
## Authentication Config
| Variable | Description | Example / Default |
| :------------------- | :--------------------------------------------------------------------- | :-------------------------------------- |
| `BETTER_AUTH_SECRET` | A secure, random 32-byte secret used to sign session cookies and JWTs. | Generate with `openssl rand -base64 32` |
| `BETTER_AUTH_URL` | The public URL of your Hono backend API. Used for redirect flows. | `http://localhost:3000` |
---
## Storage Config
Shumai supports storing files locally or on S3-compatible endpoints.
| Variable | Description | Example / Default |
| :------------------------- | :------------------------------------------------------------------------------------------------ | :-------------------------------- |
| `STORAGE_BACKEND` | Storage type. Use `local` for local file system storage, or `s3` for S3-compatible cloud storage. | `local` (default) or `s3` |
| `AWS_ENDPOINT_URL_S3` | Custom endpoint for S3 storage. Must change to public domain/IP if deploying remotely. | `http://localhost:3000` (default) |
| `S3_BUCKET` | S3 bucket name. | `shumai` (default) |
| `S3_ACCESS_KEY_ID` | Access key credentials for S3. | `minioadmin` (default) |
| `S3_SECRET_ACCESS_KEY` | Secret key credentials for S3. | `minioadmin` (default) |
| `S3_REGION` | S3 storage region. | `auto` (default) |
| `S3_USE_SSL` | Set to `true` to use HTTPS for S3 endpoints. | `false` (default) |
| `PRESIGNED_URL_EXPIRES_IN` | Number of hours for which generated presigned download/upload links are valid. | `5` (default) |
---
## Workflow Config
Configures whether background transcoding and AI agents are executed locally or offloaded to a Temporal cluster.
| Variable | Description | Example / Default |
| :------------------ | :------------------------------------------------------------------------------------------------- | :------------------------------ |
| `WORKFLOW_EXECUTOR` | Engine choice. Use `local` for in-process database polling, or `temporal` for distributed workers. | `local` (default) or `temporal` |
| `TEMPORAL_ADDRESS` | Host and port of the Temporal cluster gRPC service. | `localhost:7233` (default) |
---
## Logging Config
| Variable | Description | Example / Default |
| :----------- | :--------------------------------------------------------------------------------------------------- | :---------------- |
| `LOG_LEVEL` | Pino logging level. Options: `debug`, `info`, `warn`, `error`. | `info` (default) |
| `LOG_FORMAT` | Log format style. Use `json` for production logging, or `pretty` for human-readable terminal output. | `json` (default) |
---
## LLM API Key
API keys to AI providers on startup.
| Variable | Description | Example / Default |
| :------------------ | :---------------------------------- | :---------------- |
| `GEMINI_API_KEY` | API key for Google Gemini provider. | `AIzaSy...` |
| `OPENAI_API_KEY` | API key for OpenAI provider. | `sk-proj-...` |
| `ANTHROPIC_API_KEY` | API key for Anthropic provider. | `sk-ant-...` |
+82
View File
@@ -0,0 +1,82 @@
---
title: Deploy with Temporal
description: Configure a high-scale production deployment using Temporal and S3-compatible storage.
---
For production environments or workloads with high-volume video processing and heavy AI agent usage, running background tasks on a single server can cause bottlenecks. Shumai resolves this by offloading task queue management, retries, and background executions to **Temporal**.
This allows you to decouple workloads and run specialized worker nodes on separate, dedicated machines.
---
## How it Works
When configured for Temporal, the core Shumai web application does not process background jobs itself. Instead, it publishes tasks to a Temporal Cluster queue.
```mermaid
graph TD
UserUpload[User Uploads Video] --> WebApp[Shumai Web UI / API]
WebApp -->|Register Task| Temporal[Temporal Cluster]
Temporal -->|Queue: Transcoding| TranscodeWorker[Transcode Worker Machine]
Temporal -->|Queue: AI Agents| AgentWorker[Agent Worker Machine]
```
- **Transcoding Workers**: Can be run on GPU-accelerated or high-CPU compute instances.
- **AI Agent Workers**: Can be run on isolated, sandboxed hosts to safely execute automation scripts.
> [!IMPORTANT]
> **Storage Requirement**: Because the core application and the background workers run on separate machines in a distributed setup, **you must configure an S3-compatible storage backend** (such as AWS S3, Cloudflare R2, or MinIO). Local storage (`STORAGE_BACKEND=local`) is not supported in this mode because the workers and the web application do not share a common filesystem.
---
## Step 1: Deploy the Core Stack
On your primary host machine, spin up the database, Temporal cluster services, and the main Shumai web application:
1. **Download the Temporal Stack Configuration**:
```bash
curl -o docker-compose.yaml https://raw.githubusercontent.com/shumaiOne/shumai/main/docker-compose/temporal/docker-compose.yaml
```
2. **Configure S3 Settings**:
Open the `docker-compose.yaml` file and set your S3 credentials and endpoint environment variables under the `shumai` service.
3. **Start the Services**:
```bash
docker compose up -d
```
This exposes the web application on port `3000`, the database on `5432`, the Temporal gRPC service on `7233`, and the Temporal management dashboard on `8080`.
---
## Step 2: Configure & Run Workers
On your specialized worker machines, you will run the dedicated background worker services. Each worker requires a `.env` file referencing the database, S3 storage, and the Temporal cluster:
```env
DATABASE_URL=postgresql://shumai:shumai_password@<primary-host-ip>:5432/shumai_db?schema=public
WORKFLOW_EXECUTOR=temporal
TEMPORAL_ADDRESS=<primary-host-ip>:7233
STORAGE_BACKEND=s3
AWS_ENDPOINT_URL_S3=https://your-s3-endpoint.com
S3_BUCKET=shumai
S3_REGION=us-east-1
S3_ACCESS_KEY_ID=your-access-key-id
S3_SECRET_ACCESS_KEY=your-secret-access-key
```
### Media Transcoding Worker
Run this on your media processing nodes (requires system installations of `ffmpeg` and `ffprobe`):
```bash
npm install -g @shumai-one/shumai-transcode
shumai-transcode
```
### AI Agent Worker
Run this on your sandboxed agent execution nodes (requires sandbox dependencies like `bubblewrap` or `sandbox-exec`):
```bash
npm install -g @shumai-one/shumai-agent
shumai-agent
```
+37 -1
View File
@@ -16,7 +16,43 @@
"groups": [
{
"group": "Getting Started",
"pages": ["introduction", "getting-started/docker"]
"pages": ["getting-started/overview", "getting-started/quickstart"]
},
{
"group": "Using Shumai",
"pages": [
"using-shumai/asset-management",
"using-shumai/comments",
"using-shumai/version-stack",
"using-shumai/sort-and-search",
"using-shumai/semantic-search",
"using-shumai/team-project-management",
"using-shumai/notifications",
"using-shumai/metadata",
"using-shumai/collections",
"using-shumai/share-links"
]
},
{
"group": "Shumai Agent Settings",
"pages": [
"using-shumai/agent-providers",
"using-shumai/agents",
"using-shumai/agent-skills",
"using-shumai/agent-sandbox"
]
},
{
"group": "Media Transcoding Settings",
"pages": ["using-shumai/transcode-settings"]
},
{
"group": "Configuration",
"pages": ["configuration/env-variables"]
},
{
"group": "Temporal Deployment",
"pages": ["configuration/temporal"]
}
]
}
Binary file not shown.

After

Width:  |  Height:  |  Size: 87 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 94 KiB

-98
View File
@@ -1,98 +0,0 @@
---
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.
+37
View File
@@ -0,0 +1,37 @@
---
title: Overview
description: Learn about Shumai, a modern collaboration and media review platform.
---
## What is Shumai?
**Shumai** is a self-hosted media collaboration platform designed for creative teams, video editors, designers, and clients. It provides a centralized workspace where you can upload, organize, and review assets (video, audio, images, and documents) in real-time. With built-in AI capabilities and background transcoding, Shumai helps streamline asset organization and feedback workflows.
![Shumai Dashboard](/screenshot.webp)
---
## Core Features
- **Secure Storage**: Host your creative assets locally on your server or connect directly to any S3-compatible cloud storage provider (like AWS S3, Cloudflare R2, or MinIO).
- **Media Commenting & Drawing**: Speed up review cycles with frame-level comments and drawing tools that let you sketch directly onto video frames or images.
- **Version Control**: Stack multiple versions of the same file into a single entry to keep your workspace organized and track revision history.
- **AI-Powered Tags & Search**: Automatically tag your files on upload using Google Gemini, and find assets based on visual or conceptual meaning.
- **Custom Automations**: Build tailored background workflows using custom scripts to automate repetitive team actions.
- **Proxy Transcoding**: Automatically convert heavy camera and design files in the background into web-friendly streaming formats for smooth playback.
---
## Deployment Scales
Depending on your team size and production volume, Shumai can be configured to run in one of two modes:
### 1. Single-Server Deployment (Default)
Ideal for small teams, local development, or low-volume workflows. In this setup, the main web server, database, and background tasks (like transcoding and AI tagging) all run on a single machine.
### 2. High-Scale Distributed Deployment
Recommended for production environments with high-volume video uploads. In this setup, background tasks are managed via a centralized queue (Temporal). This allows you to offload heavy workloads to specialized worker machines (for example, putting video transcoding tasks on high-CPU/GPU machines and AI agents on separate sandboxed environments).
_Note: S3-compatible cloud storage is required for distributed deployments so that all workers can access the uploaded files._
+106
View File
@@ -0,0 +1,106 @@
---
title: Quickstart
description: Get Shumai up and running using Docker, NPM, or from source.
---
We support three installation options. For most administrators, **Docker Compose** is the fastest and easiest way to deploy Shumai.
---
## Option 1: Docker Compose (Recommended)
Docker Compose automatically configures and spins up all required services (the web application, a database, and local storage).
1. **Download the Configuration**:
```bash
curl -o docker-compose.yaml https://raw.githubusercontent.com/shumaiOne/shumai/main/docker-compose/local/docker-compose.yaml
```
2. **Start the Services**:
```bash
docker compose up -d
```
3. **Access the Dashboard**:
Open your browser and navigate to **`http://localhost:3000`** to access the Shumai Web UI.
### Production Deployments (Temporal)
If you are deploying Shumai for a production team with high-volume video uploads, we recommend setting up a distributed deployment using **Temporal** and an S3-compatible storage backend. This offloads resource-heavy video transcoding and AI agents to separate, dedicated worker nodes to keep your main dashboard fast and responsive. For setup instructions, see the [Deploy with Temporal](/configuration/temporal) guide.
---
## Option 2: Install via NPM
You can run Shumai as a global service using the Node Package Manager (NPM).
### System Prerequisites
To handle media processing and security isolation, the host machine must have the following system utilities installed:
- **FFmpeg & FFprobe**: Required for video transcoding and metadata extraction.
- _macOS_: `brew install ffmpeg`
- _Linux (Ubuntu/Debian)_: `sudo apt-get install ffmpeg`
- **Agent Sandbox Utilities**: Used to run custom automation scripts securely.
- _macOS_: `brew install ripgrep`
- _Linux (Ubuntu/Debian)_: `sudo apt-get install bubblewrap socat ripgrep`
### Step-by-Step Setup
1. **Start a Database**:
Shumai requires a PostgreSQL database with the `pgvector` extension. Start a database container:
```bash
docker run --name shumai_postgres \
-e POSTGRES_USER=shumai \
-e POSTGRES_PASSWORD=shumai_password \
-e POSTGRES_DB=shumai_db \
-p 5432:5432 \
-d pgvector/pgvector:pg18
```
2. **Install Shumai**:
```bash
npm install -g @shumai-one/shumai
```
3. **Configure Environment Variables**:
Create a new directory, navigate into it, and create a `.env` file:
```bash
mkdir shumai && cd shumai
```
Create a `.env` file with the following variables:
```env
DATABASE_URL=postgresql://shumai:shumai_password@localhost:5432/shumai_db?schema=public
BETTER_AUTH_SECRET=your-random-32-character-secret-key
STORAGE_BACKEND=local
AWS_ENDPOINT_URL_S3=http://localhost:3000
```
4. **Start Shumai**:
```bash
shumai
```
Open your browser to `http://localhost:3000`.
---
## Option 3: Run from Source (For Developers)
If you wish to run Shumai locally to customize the platform or contribute:
1. **Clone the Repository**:
```bash
git clone https://github.com/shumaiOne/shumai.git
cd shumai
```
2. **Install Dependencies**:
```bash
bun install
```
3. **Start a Database**:
Launch a local database container (as described in the NPM section above).
4. **Run Migrations**:
Set up your `.env` file at the root, then apply database migrations:
```bash
bun run db:migrate
```
5. **Start the Dev Server**:
```bash
bun run dev
```
This spins up the web server on port `3000` with hot-reloading active.
-26
View File
@@ -1,26 +0,0 @@
---
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>
Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

BIN
View File
Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 51 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 40 KiB

BIN
View File
Binary file not shown.

After

Width:  |  Height:  |  Size: 52 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 309 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 65 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 70 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 45 KiB

BIN
View File
Binary file not shown.

After

Width:  |  Height:  |  Size: 39 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 49 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

+49
View File
@@ -0,0 +1,49 @@
---
title: AI Providers
description: Connect Shumai to OpenAI, Anthropic, Gemini, or custom LLM gateways.
---
When creating agents for chat or metadata autofill, you must select an underlying AI model. The available models and providers are configured globally within your team settings.
> 🔒 **Access Control:** Only **Team Owner** can manage AI providers. To update these settings, click your avatar, navigate to **Settings**, and select **Providers** from the left sidebar.
---
## Built-In Providers
Shumai ships with pre-configured configurations for major LLM providers. Because Shumai uses [Pi](https://github.com/earendil-works/pi) as its core agent framework, the supported provider and model configurations are automatically synchronized with Pi's capabilities.
Team Owner can freely edit, delete, or add new providers. All configured provider and model settings are injected directly into the Pi framework at runtime.
---
## Configuration Reference
### Provider Settings
When configuring a provider, you will need to specify the following fields:
| Field | Description | Example / Notes |
| :---------------- | :------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------- |
| **Provider Name** | A unique, human-readable label for the provider. | `Ollama-Local`, `Enterprise-Gateway` |
| **Base URL** | The target API endpoint URL. | `http://localhost:11434/v1` |
| **API Protocol** | The streaming and payload implementation format. | Most OpenAI-compatible gateways use `openai-completions`. |
| **API Key** | The authentication token. Leave blank for unauthenticated or local setups. | Accepts a literal value (`sk-...`) or an environment variable name (`MY_API_KEY`) to load secrets securely from the host system. |
### Model Settings
Each provider can host multiple models. You can configure the following attributes per model:
| Field | Description | Example / Notes |
| :-------------------- | :---------------------------------------------------------- | :------------------------------------------------- |
| **Model ID** | The exact identifier string expected by the upstream API. | `gpt-4o`, `claude-3-5-sonnet-20240620` |
| **Display Name** | An optional, friendly label shown to users in dropdowns. | `GPT-4 Omni`, `Claude 3.5` |
| **Reasoning Support** | Toggle to enable extended thinking protocols. | Use for models with native reasoning capabilities. |
| **Context Window** | The maximum total token capacity (input + output). | |
| **Max Output Tokens** | The hard ceiling for generated response tokens per request. | |
| **Input Cost** | Cost tracking specified per million input tokens. | Optional; used to calculate usage metrics. |
| **Output Cost** | Cost tracking specified per million output tokens. | Optional; used to calculate usage metrics. |
---
![AI Providers List](../providers.webp)
+45
View File
@@ -0,0 +1,45 @@
---
title: Agent Sandbox
description: Secure execution environment and network domain restrictions for AI agent scripts.
---
Running automated scripts poses security risks. Shumai resolves this by executing all agent skills inside a secure, isolated **Sandbox** environment.
---
## Sandbox Security
The sandbox restricts the execution process from accessing the host filesystem, system processes, and internal networks:
- **Isolation**: Scripts run in a virtualized workspace container that prevents them from modifying critical system files or reading other project data.
- **Network Bridging**: External network calls from inside the sandbox are strictly monitored.
### File System Restrictions
To protect your workspace environments and sensitive data, the sandbox enforces strict file-level access controls:
- **Read Access**: The sandbox is allowed to read files within the workspace, with a strict exception for sensitive environment and certificate files. It cannot read: `['.env', '.env.*', '*.pem', '*.key']`.
- **Write Access**: The sandbox is heavily restricted and may only write to the `.pi` folder located in the current working directory (cwd). Even within this allowed directory, the sandbox is explicitly blocked from writing or creating sensitive files matching: `['.env', '.env.*', '*.pem', '*.key']`.
---
## Domain Whitelisting
By default, sandboxed scripts cannot make network requests to the internet. Team Owners must explicitly authorize external APIs by managing domain access:
### Allowed Domains
A list of domains that sandboxed scripts are permitted to access.
- Default whitelisted domains include standard package registries (like npm or python package hosts) and repository hosts (like `github.com`).
- If a script needs to call an external API (e.g. `api.slack.com`), the administrator must add it to the allowed list.
### Pending Domains
When an agent script attempts to reach a domain that is not currently authorized:
1. The network connection is blocked immediately.
2. The target domain is logged and added to the **Pending Domains** list.
3. Admins can review this list and click **Approve** to authorize the domain, or **Reject** to keep it blocked.
![Agent Sandbox Settings](../sandbox.webp)
+54
View File
@@ -0,0 +1,54 @@
---
title: Agent Skills
description: Extend your agents' capabilities with custom automation tools.
---
By default, AI models can only process text and image. In Shumai, you can extend both your **Chat Agents** and **Autofill Agents'** capabilities by registering **Skills**—custom scripts that the agent can run when solving a task.
---
## How Skills Work
Skills are actions that you define and make available to your AI agents.
- **Descriptions for the AI**: When you register a skill, the AI agent reads its metadata to understand exactly when and how it should use the tool to solve a problem.
- **Execution & Local Caching**: When an agent decides it needs to use a skill, Shumai handles the execution. Newly added skill data is synced to the database first. Upon execution, the agent downloads and caches the skill locally from the database for fast, reliable access.
---
## Adding a Skill
To install a new skill into Shumai:
1. Navigate to the **Settings** page and open the **Skills** tab.
2. Click the **Add Skill** button.
3. In the dialog box, choose your installation method:
- **Upload**: Select and upload a `.zip` file containing your skill.
- **GitHub**: Provide a valid GitHub repository path.
> **Important:** Regardless of the installation method, the root folder of the skill must contain a `SKILL.md` file.
### Updating an Existing Skill
To update a skill, simply follow the steps above and install the new version using the exact same skill name. Shumai will automatically replace the older version.
---
## Configuring Environment Variables
If your custom skill requires environment variables (e.g., API keys, external tokens) to function:
1. Click on the installed **Skill Card** in the Skills tab to open the configuration dialog.
2. Add the required environment variables.
3. _(Optional)_ Set a default value for the variable. If no default value is provided, the skill will dynamically load the required value from the system environment at runtime.
---
## Enabling Skills for Agents
**All skills are disabled by default.** Merely installing a skill does not give agents access to it. To allow an agent to use an installed skill:
1. Navigate to your specific **Agent Settings**.
2. Explicitly enable the skills you want to authorize for that particular agent.
![Skills List View](../skills.webp)
+50
View File
@@ -0,0 +1,50 @@
---
title: AI Agents
description: Create and configure specialized AI agents for chat, metadata autofill, and vector embedding.
---
Shumai uses specialized AI Agents to perform background automation, chat workflows, and semantic indexing. **Only Team Owner** can create, manage, and change agent settings.
---
## Agent Types
Shumai supports three types of agents:
### 1. Chat Agent
An interactive, conversational bot that appears in your project workspace.
- You can create as many chat agents as you want.
- You can use "@" to mention chat agents directly in file comments.
- The agent is context-aware: it can read files, search the project folder, inspect metadata, and read comment threads.
- You can add "Skills" to a chat agent, enabling it to write files, run scripts, or interact with external APIs on your behalf.
### 2. Autofill Agent
A background agent that monitors file uploads. You can create **only one** Autofill Agent.
- Once created and enabled, Shumai automatically triggers the agent when a new file is uploaded, provided the file type is supported (image or video).
- It analyzes the file's content (multimodal images, text descriptions) and populates any metadata fields flagged for "AI Autofill".
### 3. Embedding Agent
A specialized utility agent that processes assets to generate search indexes. You can create **only one** Embedding Agent.
- Once created and enabled, Shumai automatically runs embedding generation for new file uploads if the file type is supported (image or video).
- These search indexes are saved to power Shumai's natural language semantic search capabilities.
- **Note:** The Embedding Agent is hardcoded to use `google-embedding-2` as the LLM model. Because of this, you cannot choose a provider or model. Make sure you set the `GEMINI_API_KEY` environment variable to make it work.
---
## Configuring an Agent
To edit or create an agent, navigate to **Team Settings** > **Agents** (Note: Only Team Owners can change these settings):
- **Avatar**: Choose an avatar for the agent by picking from the predefined avatars.
- **Enabled / Disabled Toggle**: Stop or start the agent. If the embedding agent is disabled, semantic search indexing is paused.
- **System Prompt / Soul**: The core instructions that define the agent's behavior, guidelines, formatting requirements, and operational limits.
- **Model Provider**: Select which registered provider and model the agent should use for execution. _(Note: This option is disabled for Embedding Agents)._
- **Assigned Skills**: Select which custom skills this agent is permitted to execute.
![Agent Config Panel](../agents.webp)
+54
View File
@@ -0,0 +1,54 @@
---
title: Asset Management
description: Learn how to upload, organize, delete, and recover assets in your workspace.
---
Shumai makes it easy to bring creative media into your workspace, organize them in folders, and manage their lifecycle from upload to deletion.
---
## Uploading Assets
You can upload files and folders into Shumai using three methods:
1. **Drag and Drop**: Drag files or entire folder directories directly from your computer's file explorer and drop them anywhere on the Shumai dashboard interface.
2. **Upload Buttons**: Click the **Upload File** or **Upload Folder** buttons in the toolbar.
3. **Copy and Paste**: Copy an image or file from another website, application, or your clipboard, and paste it directly (`Ctrl+V` or `Cmd+V`) into the Shumai browser window to upload it instantly.
![Asset Management - Drag and Drop Upload](../dragdrop.webp)
---
## Folder Organization
When you upload an entire folder, Shumai replicates your folder hierarchy exactly inside the project.
- All subfolders are created automatically.
- Nested files remain in their respective subfolders.
- There is no limit to the depth of nested folders you can upload.
---
## Upload and Processing States
Once an upload starts, your assets progress through the following states:
- **Uploading**: The file is transferring to your storage server. The UI displays an active progress percentage.
- **Processing**: The file has successfully uploaded. Shumai is now extracting media parameters (such as resolution, video length, and audio codecs) and creating a web-friendly streaming preview (proxy).
- **Ready**: Processing is complete. The asset is fully visible, playable, and ready for comments, metadata tagging, or search.
---
## Deleting and Restoring Assets
If you no longer need an asset, you can delete it to clean up your workspace:
### The Trash Bin (Recently Deleted)
- When you delete a file or folder, it is moved to the **Recently Deleted** tab in your project settings.
- Deleted assets are kept in the Trash for **30 days**. During this window, you can select any asset and click **Recover** to restore it to its original location.
- If you want to free up space immediately, you can open the Recently Deleted tab and click **Empty Trash** to permanently purge the files.
### Permanent Removal
After **30 days** in the Trash, assets are automatically and permanently purged. Once purged, the records are removed from the database, and the files are deleted from your storage backend (local file system or S3 bucket) and cannot be recovered.
+55
View File
@@ -0,0 +1,55 @@
---
title: Collections
description: Build dynamic virtual folders using metadata filters and search criteria.
---
Instead of copying files into static folders, Shumai uses **Collections**—dynamic, query-based virtual views. A collection automatically groups files that match specific criteria in real-time.
---
## What is a Collection?
A **Collection** does not duplicate files on disk. Instead, it runs a pre-defined filter query against your project assets database. Whenever a new file is uploaded or metadata is updated to match the collection's query, the file automatically appears inside the collection.
---
## Creating a Collection
You can create collections in two ways:
- **From the Sidebar**: Click the `+` icon next to **Collections** in the project sidebar to open the query builder, configure your search rules, and save it.
- **From the Search Dialog**: When searching and filtering files within the Search Dialog, you can save your active search criteria by clicking the **Save as collection** button at the bottom of the dialog. This will create a dynamic collection that mirrors your search filters.
---
## Setting Up Collection Filters
When creating or editing a collection, you specify a name and set up a filter query in the builder interface:
### 1. Source Folder
Specify the starting folder directory. The collection will scan this folder and all its nested subfolders recursively.
### 2. Operators and Conditions
- **Logical Operators**: Combine conditions using **AND** (all conditions must be met) or **OR** (at least one condition must be met).
- **Fields**: Filter on standard fields (name, type, size) or custom metadata fields (such as "Status" or "Approval").
- **Comparison Rules**:
- _Equals / Does Not Equal_: Match exact values.
- _Contains / Does Not Contain_: Match parts of words.
- _Greater Than / Less Than_: Set up numeric or date ranges (e.g., date uploaded is after yesterday).
- _Is Empty / Is Not Empty_: Check if fields have values.
### 3. Collection Default Sorting
Define a custom sorting rule specific to the collection (e.g., sort by the custom field "Publication Date" ascending) to override the default project sort order.
---
## Example Use Cases
- **Review Dashboard**: A collection named "Pending Review" that displays assets where `Status` equals `In Review`.
- **Daily Deliverables**: A collection filtering files uploaded in the last 24 hours.
- **Approved Assets**: A collection filtering assets matching `Tag` contains `marketing` AND `Approved` is `Yes`.
![Collection Creation](../collection.webp)
+51
View File
@@ -0,0 +1,51 @@
---
title: Comments & Annotations
description: Collaborate on media assets using drawings and timestamped comments.
---
Shumai provides a review workspace designed for video, audio, and image feedback. Instead of generic text comments, you can drop timestamped feedback and sketch directly onto the media.
---
## Timestamped Comments
When reviewing video or audio files, comments can be anchored to specific seconds on the timeline:
1. Play or scrub the video player to the exact frame or timestamp you want to review.
2. Type your feedback in the comment box.
3. Click **Submit**. Your comment will be saved with a timestamp marker shown on the video timeline.
4. Collaborators can click your comment card in the sidebar to jump the video player to the exact moment you commented on.
![Timestamped Comments](../timestamp-comment.webp)
---
## Draw Annotations (Canvas)
To give clear visual feedback, you can draw directly onto image or video frames:
1. Pause the video on the frame you wish to annotate.
2. Select a drawing tool (brush, rectangle, circle, arrow) from the annotation toolbar overlaying the player.
3. Draw directly on the video screen.
4. Type your comment and click **Submit**. Your drawing is saved along with your comment.
5. When other users select your comment, your drawings will overlay on the player screen automatically at that frame.
![Draw Annotations](../draw_annotation.webp)
---
## Comment Threads (Replies)
Keep discussions organized by replying directly to feedback:
- Click **Reply** on any comment.
- Replies are nested under the parent comment card, making it easy to track resolution conversations.
---
## Attachments
You can attach reference documents, style guides, or other assets to your comments:
- Click the **Paperclip** icon inside the comment input box.
- Choose a file to upload. It will appear as a downloadable link directly on your comment card.
+68
View File
@@ -0,0 +1,68 @@
---
title: Asset Metadata
description: Customize your assets with dynamic, scoped metadata fields and AI-driven autofill features.
---
Standard file systems limit you to basic attributes like file name and modification date. Shumai lets you create structured metadata fields tailored to your creative pipeline—from tracking review statuses to capturing technical specs automatically.
---
## Metadata Scopes
Fields are grouped and displayed in the sidebar inspector by their scope:
- **Essentials (System Scope)**: Core fields built into Shumai that appear across all teams and projects. Many of these (like resolution, duration, and codec) are automatically extracted during file upload.
- **Team Attributes (Team Scope)**: Custom fields defined at the team level, which are inherited by all projects under that team. Excellent for enforcing company-wide metadata guidelines.
- **Custom Fields (Project Scope)**: Unique metadata fields defined specifically for a single project workspace.
---
## Custom Field Types
When building or editing your metadata schema, you can choose from these custom types:
- **Text**: A single-line input field for simple strings, codes, or labels.
- **Long Text**: A paragraph input area for detailed descriptions, summaries, or notes.
- **Dropdown (Select)**: A single-choice dropdown menu where options can be styled with custom background colors (e.g., Green for Approved, Yellow for In Progress).
- **Tags (Multi-Select)**: A multi-choice tag field allowing you to assign multiple custom colored labels to a single asset.
- **Star Rating**: An interactive star rating scale (supports configurations from 2 to 6 stars) for scoring and ranking.
- **Number**: A numeric field supporting custom decimal precision (from 0 to 3 decimal places) for values like frame rates, counts, or scores.
- **Checkbox (Toggle)**: A simple Yes/No switch for binary indicators (e.g., "VFX Required").
- **Date**: A calendar date selector with support for custom display formats (Local, ISO, USA, Euro, Friendly) and optional time tracking.
![Asset Metadata Fields](../metafields.webp)
---
## Default Built-in Fields
Every project comes pre-configured with several essential fields populated automatically during upload or status changes:
- **Technical Specs**: File Size, Format, File Type (Video, Audio, Image, Document, File), Resolution Width/Height, Video/Audio Codecs, Duration, Frame Rate, and Audio Sample Rates.
- **Collaborative Fields**:
- **Status**: A dropdown select field containing `Needs Review` (Red), `In Progress` (Yellow), and `Approved` (Green).
- **Rating**: A 5-star rating scale for quick review evaluations.
- **Keywords**: A tags (multi-select) field to categorize assets.
---
## Field Settings & Controls
### Read-Only Fields
Marking a custom field as **Read-Only** prevents team members from editing its value directly. This is ideal for fields meant to be populated programmatically or by automated integrations.
### AI Autofill
When you enable **AI Autofill** on a metadata field, Shumai automatically analyzes uploaded assets using your team's default Gemini AI model. The AI will populate the field with extracted insights:
- For text/long text: AI generates summaries, descriptions, or shot logs.
- For select/multi-select: AI automatically categorizes themes or applies matching tags.
- For numbers: AI can output confidence scores or other metrics.
### Visibility & Ordering
In the metadata inspector:
- **Visibility**: Toggle fields on or off to clean up the sidebar and only show what is relevant to your current review process.
- **Ordering**: Drag and drop fields in the builder to arrange their display order within the Custom Fields section.
+46
View File
@@ -0,0 +1,46 @@
---
title: Notifications
description: Stay updated on comment activity, uploads, and project updates.
---
Shumai includes a built-in notification system to keep you informed of team activities, file statuses, and review comments. You can fully customize which events trigger notifications, check updates from your inbox, or toggle notifications for specific projects.
---
## Notification Settings
You can customize your notification preferences for each team to avoid unnecessary noise. To manage your notification events:
1. Click on **Team Settings** in the sidebar.
2. Select the **Notifications** tab.
3. Toggle the switches to enable or disable notifications for specific events:
### Comments & Replies
- **General Comments**: Notify me when someone comments on an asset I collaborate on.
- **Comment Replies**: Notify me when someone replies to my comment threads.
- **@Mentions**: Notify me when someone tags me (using `@username`) in any comment.
### Assets & Statuses
- **Your Uploads**: Notify me when files I upload finish transcoding and are ready for review.
- **Other Uploads**: Notify me when other team members upload new assets.
- **Status Updates**: Notify me when someone changes an asset's status (e.g., from "In Progress" to "Approved").
---
## Project-Level Notifications
If you want to mute a specific project entirely (except for direct `@mentions` which are always delivered):
1. Navigate to the **Project** dashboard.
2. Open **Project Settings**.
3. Toggle **Enable Notifications** on or off.
---
## The Notification Inbox
- The **Bell** icon in the navigation bar displays a red badge when you have unread notifications.
- Click the bell to open your notification feed panel.
- Click any notification card to mark it as read and jump directly to the relevant file and comment thread.
+28
View File
@@ -0,0 +1,28 @@
---
title: Semantic Search
description: Find files based on visual and textual meaning using AI vector similarity.
---
Traditional search relies on matching exact characters (e.g., searching "dog" will not find files named "golden_retriever.jpg"). Shumai resolves this with **Semantic Search**, which indexes the conceptual meaning of your files.
---
## How Semantic Search Works
Semantic search translates text queries and file contents into conceptual profiles. Similar ideas and visuals are mapped near each other.
1. **Index Generation**: When you upload an asset, Shumai's background agent scans the file's visual elements, text contents, or descriptions, translating them into a concept profile.
2. **Concept Matching**: When you search with the "Semantic" toggle enabled, Shumai matches the conceptual meaning of your query against your assets.
3. **Result**: Searching "sunset at the beach" will successfully find a video file of ocean waves at dusk, even if the filename is `IMG_4029.mp4`.
---
## Activating Semantic Search
To use semantic search:
1. Verify that your administrator has enabled the **Embedding Agent** under **Team Settings** > **Agents**.
2. Once active, Shumai will automatically begin indexing new uploads.
3. Toggle the **Semantic** button next to the search input in the file explorer to search by conceptual meaning.
![Semantic Search Toggle](../semantic-search.webp)
+57
View File
@@ -0,0 +1,57 @@
---
title: Share Links
description: Share files and folders securely with external clients and stakeholders.
---
Shumai allows you to collaborate with external stakeholders who do not have accounts in your workspace. Using **Share Links**, you can grant view and comment access to specific folders or assets.
---
## Creating a Share Link
1. Select the files or folders you want to share, then right-click and choose **Create New Share Link**.
2. Click the newly created **Share Link** in the project sidebar to open its settings page.
3. Configure the share link in the right sidebar. You can:
- Add password protection
- Set an expiration date
- Configure which metadata fields are visible to recipients
4. Click **Copy Link** at the bottom of the sidebar, then send the link to your client or stakeholder.
![Share Link Configuration](../sharelink.webp)
---
## Adding Assets to an Existing Share Link
Once a share link is created, you can easily add more files or folders to it without generating a new link:
1. Select the files or folders you want to add from your file browser.
2. Drag and drop them directly onto the share link item in the project sidebar.
3. The share link will immediately update to include the newly added assets.
---
## Security and Settings
### Expiration Date
Set an optional date and time after which the link becomes inactive. Once the date passes, the link returns a `404 Not Found` page to anyone attempting to access it.
### Password Protection
Secure sensitive work by adding a password. External users visiting the link will be prompted to enter the correct password before they can view the assets.
### Default Sort Order
Set a default sorting rule for the shared page (e.g. sorting by name or version) to ensure the client views the files in the intended order.
### Column Visibility
To protect proprietary information, you can configure exactly which metadata columns are visible to external users. For example:
- **Visible**: `Asset Name`, `Resolution`, `Download Link`.
- **Hidden**: `Internal Budget Code`, `Assignee Notes`, `Cost`.
### Disabling a Link
If you need to revoke access immediately, navigate to the **Share Links** tab under Project settings and toggle the **Disabled** switch. You can re-enable the link at any time.
+39
View File
@@ -0,0 +1,39 @@
---
title: Sort & Search
description: Find assets using the search dialog and organize them with custom sort orders.
---
As your projects grow, finding the right media files quickly is critical. Shumai provides a powerful search dialog and flexible sorting controls.
---
## Searching Assets
Searching is performed inside a dedicated **Search Dialog** that you can open by clicking the search icon in the toolbar.
![Search Dialog](../search-dialog.webp)
### Search Dialog Features
- **Keyword Matches**: Type a keyword in the text input to instantly filter file and folder names.
- **Advanced Filtering**: Click to expand the filters panel and build multi-conditional queries (e.g. searching for files where the custom field "Status" equals "In Progress" AND the file type is "Video").
- **Semantic Search Toggle**: If enabled by your team administrator, toggle "Semantic" on to search by conceptual meaning (e.g. searching "sunny beach" to find clips of oceans even if the filenames do not contain those words).
- **Save as Collection**: Easily convert your active search criteria into a dynamic folder. Click **Save as Collection** inside the dialog to create the collection and navigate to it instantly.
- **Infinite Scroll Results**: Search results load dynamically in real-time as you type or adjust filters.
---
## Sorting and Reordering Assets
You can change the sorting order of the asset list using the sort dropdown or by clicking metadata column headers:
- **Custom Sort (Default)**: By default, the project file explorer is set to **Custom** sorting. In this mode, you can manually drag and drop files and folders to reorder them exactly as you wish.
- **Standard Sort Options**: You can also sort files by:
- _Newest Upload_: Displays recently uploaded assets first.
- _Name_: Sorts alphabetically (A-Z or Z-A).
- _Size_: Sorts by file size.
- _Type_: Groups folders together at the top, followed by version stacks and individual files.
- _Custom Columns_: Sorts by dynamic metadata fields (e.g., sorting by "Due Date" or "Priority").
> [!NOTE]
> **Drag and Drop Reordering Limit**: Drag-and-drop manual reordering is **only** available when the sort order is set to **Custom**. If you select any other sort option (such as Name or Size), manual reordering is disabled.
@@ -0,0 +1,58 @@
---
title: Team & Project Management
description: Organize your workspaces, define roles, and manage members.
---
Shumai uses a two-tier organizational hierarchy—**Teams** and **Projects**—to manage file access and collaboration.
---
## Member Visibility & Scopes
Members added to a team belong to one of two permission scopes:
- **Team Scope**: Team-scoped members can view all projects inside the team by default.
- **Project Scope**: Project-scoped members can only see and access the specific projects they have been explicitly granted permission to join.
---
## Member Roles
Shumai uses permission roles to control what actions team and project members can perform:
- **Owner**: Full administrative control. Team Owners can modify team settings, skills, and AI providers. Project Owners can edit project configurations, manage members, and generate invites.
- **Editor**: Can upload files, edit custom metadata, create folders, and add comments or canvas annotations.
- **Reviewer**: Read-only access. Can view media assets, toggle versions, and leave text comments or canvas drawings, but cannot upload/delete files or modify metadata.
---
## Project Role Overrides
Administrators can add existing team members to specific projects to override their permissions:
- Project-level roles take higher priority than team-level roles within that project.
- _Example_: If Peter is a team member with an **Editor** role, an administrator can add Peter to _Project A_ with a **Reviewer** role. Peter will act as a Reviewer inside Project A, but maintain his Editor role across the rest of the team's projects.
---
## Managing Members
Member management is handled using a unified **Members Dialog** popup:
### 1. Managing Team Members
- **Access**: Open your **Team Dashboard** and click the members list or avatar group in the header.
- **Settings**:
- Change member roles between Editor and Reviewer.
- Remove members from the team.
- **Invite New Members**: Select a role (Editor or Reviewer) and click **Generate Link**. Copy the signup URL to invite new users to the team.
### 2. Managing Project Members
- **Access**: Open your project **File Browser** and click the members avatars or button in the top toolbar.
- **Settings**:
- Change project member roles or remove them from the project.
- **Add Team Members**: The dialog displays a list of active team members who are not yet added to this project. Select their project role (which will override their team role inside this project) and click **Add** to add them instantly.
- **Invite External Collaborators**: Select a role (Editor or Reviewer) and click **Generate Link** to invite new users directly into this specific project.
![Members Dialog](../members.webp)
+36
View File
@@ -0,0 +1,36 @@
---
title: Media Transcoding Settings
description: Configure video transcode strategies and preview proxy generation.
---
High-resolution camera formats and raw media files cannot be rendered natively in web browsers. Shumai transcodes these assets into web-friendly streaming formats in the background.
Regardless of the selected transcoding strategy, Shumai's pipeline will **always** generate at least one lightweight `180p` proxy version of the raw file to ensure fast scrubbing, thumbnail generation, and instant previews.
---
## Video Transcode Strategies
Team Owners can select how the transcoding engine handles uploaded files. Shumai evaluates the original file's dimensions against its standard target resolutions (2160p, 1080p, 720p, 540p, and 360p) to determine the output.
### 1. Best Match
- **Behavior**: Shumai checks the longest dimension (width or height) of the uploaded file. It then finds the highest standard resolution that is equal to or smaller than the original file, preventing unnecessary upscaling. If the original video is exceptionally small, it defaults to a minimum target of `360p`.
- **Output**: Generates exactly two web-optimized files: the universal `180p` proxy and the single calculated "best match" resolution.
- **Use Case**: This is the recommended option. It ensures web compatibility without wasting processing time and storage space on redundant lower-resolution versions.
### 2. Transcode All
- **Behavior**: Shumai calculates the "best match" resolution exactly as it does in the previous strategy. However, instead of stopping at one version, it processes the video into the best match _and_ every standard resolution smaller than it.
- **Output**: Generates a full cascade of files. For example, if the best match for an upload is `1080p`, Shumai will generate the `180p` proxy, `1080p`, `720p`, `540p`, and `360p` versions.
- **Use Case**: Ideal for environments requiring adaptive bitrate streaming, ensuring consistent playback performance across all client devices regardless of varying network conditions.
![Transcode Settings](../transcode.webp)
---
## Processing Architecture
Transcoding is resource-intensive. Depending on your scaling needs, your administrator can run the transcode engine on the main server (Single-Server mode) or delegate tasks to specialized transcoding worker machines (Temporal Worker mode).
Note: In all modes, the processing machine must have the standard system media utilities (`ffmpeg` and `ffprobe`) installed.
+44
View File
@@ -0,0 +1,44 @@
---
title: File Version Stack
description: Group multiple revisions of an asset under a single version-controlled stack.
---
When collaborating on creative assets, files naturally go through multiple iterations (e.g. `draft_v1.mp4`, `draft_v2.mp4`, `draft_final.mp4`). To prevent workspace clutter, Shumai allows you to bundle these revisions into a **Version Stack**.
---
## What is a Version Stack?
A **Version Stack** groups multiple revisions of the same file into a single entry. Instead of cluttering your folder with several similar files, Shumai collapses them into one item with a version badge (e.g., "V3") and a dropdown list of older versions.
![Version Stack Selector](../versionstack.webp)
---
## Creating & Adding to a Version Stack
You can create a version stack or add new versions to an existing stack using two interactive methods:
- **Drag and Drop**:
- _To create a stack_: Drag one standalone file directly over another standalone file in your file explorer.
- _To add a version_: Drag a standalone file directly onto an existing version stack.
- **Context Menu (Right-Click)**:
- Right-click any standalone file or existing version stack.
- Choose **Create New Version** from the menu.
- Select the revision file from your computer to upload it directly into the stack.
---
## Managing Versions
### Active Version
The file at the top of the stack is the **Active Version**. This is the version displayed on your project dashboard, search results, and metadata panels.
### Reordering and Reverting Versions
You can promote a past version or reorder your stack:
- Open the version stack details sidebar.
- Drag and drop the versions in the list to change their order. The version you drag to the top automatically becomes the active version.
- To remove a file from the stack, drag it out or select **Unstack**. This moves the file back to the parent folder as a standalone file.
Binary file not shown.

After

Width:  |  Height:  |  Size: 83 KiB

+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "shumai",
"version": "0.0.4",
"version": "0.0.7",
"private": true,
"type": "module",
"repository": {
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "@shumai/agent",
"version": "0.0.4",
"version": "0.0.7",
"private": true,
"type": "module",
"main": "./src/index.ts",
+1 -1
View File
@@ -306,7 +306,7 @@ describe('Agent Database Activities Integration', () => {
teamId: team.id,
name: 'openai',
config: {
api: 'openai',
api: 'openai-completions',
apiKey: 'mock-key',
},
},
+1
View File
@@ -98,6 +98,7 @@ If you need to create files in the local filesystem (for example, a temporary fi
}
const { session, harness } = await createAgentSession({
teamId: params.teamId,
agentId: params.agentId,
providerName,
modelId,
+2 -2
View File
@@ -7,7 +7,7 @@ import {
saveAssetEmbeddingsActivity,
} from './ai'
import { s3Service } from '@shumai/core/src/s3/s3'
import { transcodeService } from '@shumai/transcode'
import { transcodeService } from '@shumai/core'
import { prisma, AssetType, AssetStatus } from '@shumai/db'
import { setupTestDbHooks } from '@shumai/db/test'
import * as fs from 'fs'
@@ -38,7 +38,7 @@ vi.mock('@shumai/core/src/s3/s3', () => ({
},
}))
vi.mock('@shumai/transcode', () => ({
vi.mock('@shumai/core/src/transcode/transcode', () => ({
transcodeService: {
extractVideoFrames: vi.fn(),
},
+1 -1
View File
@@ -1,6 +1,6 @@
import { GoogleGenAI } from '@google/genai'
import { s3Service } from '@shumai/core/src/s3/s3'
import { transcodeService } from '@shumai/transcode'
import { transcodeService } from '@shumai/core'
import { execFile } from 'child_process'
import * as fs from 'fs'
import * as os from 'os'
@@ -316,6 +316,7 @@ describe('DatabaseSessionStorage', () => {
// 6. Resume the session via createAgentSession
await createAgentSession({
teamId: 't1',
agentId: agent.id,
providerName: 'test-provider',
modelId: 'test-model',
@@ -334,6 +335,7 @@ describe('DatabaseSessionStorage', () => {
expect.objectContaining({
MOCK_ENV_VAR: 'mocked-value',
}),
expect.any(Object),
)
})
@@ -424,6 +426,7 @@ describe('DatabaseSessionStorage', () => {
// 3. Resume the session via createAgentSession with a NEW comment ID
await createAgentSession({
teamId: 't1',
agentId: agent.id,
providerName: 'test-provider',
modelId: 'test-model',
+229 -2
View File
@@ -1,6 +1,27 @@
import { describe, it, expect } from 'vitest'
import { formatSkillsForPrompt } from './index'
import { describe, it, expect, vi } from 'vitest'
import { formatSkillsForPrompt, createAgentSession } from './index'
import { createSandboxedBashTool } from './tools/sandboxed-bash'
import { SandboxManager, type SandboxAskCallback } from '@anthropic-ai/sandbox-runtime'
import { prisma } from '@shumai/db'
import { setupTestDbHooks } from '@shumai/db/test'
import * as path from 'path'
import * as childProcess from 'node:child_process'
// eslint-disable-next-line @typescript-eslint/no-explicit-any
let mockSpawn: any = null
vi.mock('node:child_process', async () => {
const actual = (await vi.importActual('node:child_process')) as typeof childProcess
return {
...actual,
spawn: (...args: Parameters<typeof childProcess.spawn>) => {
if (mockSpawn) {
return mockSpawn(...args)
}
return actual.spawn(...args)
},
}
})
describe('formatSkillsForPrompt', () => {
it('should return empty string if skills array is empty', () => {
@@ -31,3 +52,209 @@ describe('formatSkillsForPrompt', () => {
expect(result).toContain('</available_skills>')
})
})
describe('Sandbox Network isolation integration', () => {
setupTestDbHooks()
it('should register callback that pushes blocked hosts to database and propagates to bash tool', async () => {
// 1. Create a team
const team = await prisma.team.create({
data: { name: 'Test Sandbox Team' },
})
// Ensure agent user and agent exist in database to avoid foreign key violation
await prisma.user.create({
data: {
id: 'test-agent',
name: 'Ai Agent',
email: 'test-agent@shumai.ai',
type: 'agent',
},
})
await prisma.agent.create({
data: {
id: 'test-agent',
teamId: team.id,
type: 'chat',
config: {
provider: 'openai',
model: 'gpt-4',
},
},
})
// 2. Mock / spy SandboxManager
const initializeSpy = vi.spyOn(SandboxManager, 'initialize').mockResolvedValue()
const wrapSpy = vi
.spyOn(SandboxManager, 'wrapWithSandbox')
.mockImplementation(async (cmd) => cmd)
// 3. Call createAgentSession
await createAgentSession({
teamId: team.id,
agentId: 'test-agent',
providerName: 'google',
modelId: 'gemini',
systemPrompt: 'prompt',
teamSkills: [],
allowedDomains: [],
providers: [],
})
// 4. Verify SandboxManager.initialize was called and extract the callback
expect(initializeSpy).toHaveBeenCalled()
const callback = initializeSpy.mock.calls[0][1]
expect(callback).toBeDefined()
// 5. Trigger the callback with a blocked host
const result = await callback!({ host: 'blocked-api.com', port: 443 })
expect(result).toBe(false) // should always return false to block
// 6. Verify it was pushed to database
const sandbox = await prisma.sandbox.findUnique({
where: { teamId: team.id },
})
expect(sandbox?.pendingDomains).toContain('blocked-api.com')
// 7. Verify that if the bash tool is run while a domain is blocked, it rejects with correct error
const sandboxState = { blockedHost: '' }
const bashTool = createSandboxedBashTool(
process.cwd(),
{},
{
getBlockedHost: () => sandboxState.blockedHost,
clearBlockedHost: () => {
sandboxState.blockedHost = ''
},
},
)
// Mock spawn to simulate process exit and trigger network block
mockSpawn = () => {
sandboxState.blockedHost = 'blocked-api.com'
const mockChild = {
pid: 123,
stdout: { on: vi.fn() },
stderr: { on: vi.fn() },
on: vi.fn((event: string, cb: (code: number) => void) => {
if (event === 'close') {
setTimeout(() => cb(1), 10)
}
}),
} as unknown as childProcess.ChildProcess
return mockChild
}
const bashPromise = bashTool.execute('1', { command: 'curl blocked-api.com' })
try {
await expect(bashPromise).rejects.toThrow(
'Network request to blocked-api.com is blocked, please ask admin to allow it in sandbox settings.',
)
} finally {
mockSpawn = null
initializeSpy.mockRestore()
wrapSpy.mockRestore()
}
})
it('should correctly route sandbox callback to the active session when multiple sessions are created sequentially', async () => {
// 1. Create two teams
const team1 = await prisma.team.create({
data: { name: 'Team 1' },
})
const team2 = await prisma.team.create({
data: { name: 'Team 2' },
})
// Ensure agent user and agents exist in database
await prisma.user.create({
data: {
id: 'agent-1',
name: 'Ai Agent 1',
email: 'agent1@shumai.ai',
type: 'agent',
},
})
await prisma.user.create({
data: {
id: 'agent-2',
name: 'Ai Agent 2',
email: 'agent2@shumai.ai',
type: 'agent',
},
})
await prisma.agent.create({
data: {
id: 'agent-1',
teamId: team1.id,
type: 'chat',
config: { provider: 'openai', model: 'gpt-4' },
},
})
await prisma.agent.create({
data: {
id: 'agent-2',
teamId: team2.id,
type: 'chat',
config: { provider: 'openai', model: 'gpt-4' },
},
})
// Mock SandboxManager.initialize to behave like a process-global singleton
let registeredCallback: SandboxAskCallback | null = null
const initializeSpy = vi
.spyOn(SandboxManager, 'initialize')
.mockImplementation(async (config, cb) => {
if (!registeredCallback) {
registeredCallback = cb || null
}
})
const resetSpy = vi.spyOn(SandboxManager, 'reset').mockImplementation(async () => {
// In the real SandboxManager, reset clears the global initialization promise and servers,
// which allows subsequent initialize calls to register a new callback.
registeredCallback = null
})
try {
// 2. Call createAgentSession for Session 1
await createAgentSession({
teamId: team1.id,
agentId: 'agent-1',
providerName: 'google',
modelId: 'gemini',
systemPrompt: 'prompt',
teamSkills: [],
allowedDomains: [],
providers: [],
})
// 3. Call createAgentSession for Session 2
await createAgentSession({
teamId: team2.id,
agentId: 'agent-2',
providerName: 'google',
modelId: 'gemini',
systemPrompt: 'prompt',
teamSkills: [],
allowedDomains: [],
providers: [],
})
expect(registeredCallback).toBeDefined()
// 4. Trigger the globally registered callback (which is from Session 1)
const result = await registeredCallback!({ host: 'blocked-for-session-2.com', port: 443 })
expect(result).toBe(false)
// 5. Verify that the pending domain was pushed to the DB record of Team 2
const sandbox2 = await prisma.sandbox.findUnique({
where: { teamId: team2.id },
})
expect(sandbox2?.pendingDomains).toContain('blocked-for-session-2.com')
} finally {
initializeSpy.mockRestore()
resetSpy.mockRestore()
}
})
})
+58 -11
View File
@@ -5,6 +5,7 @@ import { getModel } from '@earendil-works/pi-ai'
import { Type, type TSchema } from '@sinclair/typebox'
import * as fs from 'fs'
import * as path from 'path'
import { prisma } from '@shumai/db'
import { agentService } from '@shumai/core/src/agent/agent'
import { DatabaseSessionStorage } from './database-session-storage'
import { createAnalyzeImageTool } from './tools/analyze-image'
@@ -17,6 +18,7 @@ import { createReadSkillTool } from './tools/read-skill'
import { createSandboxedBashTool } from './tools/sandboxed-bash'
export interface CreateAgentSessionParams {
teamId: string
agentId: string
providerName: string
modelId: string
@@ -40,6 +42,7 @@ export interface CreateAgentSessionParams {
export async function createAgentSession(params: CreateAgentSessionParams) {
const {
teamId,
agentId,
providerName,
modelId,
@@ -115,18 +118,57 @@ export async function createAgentSession(params: CreateAgentSessionParams) {
const allowWrite = [piDir]
const sandboxState = {
blockedHost: '',
}
const sandboxAskCallback = async ({ host }: { host: string; port?: number }) => {
try {
const sandbox = await prisma.sandbox.findUnique({
where: { teamId },
})
const pendingDomains = sandbox?.pendingDomains || []
if (!pendingDomains.includes(host)) {
await prisma.sandbox.upsert({
where: { teamId },
create: {
teamId,
pendingDomains: [host],
},
update: {
pendingDomains: {
push: host,
},
},
})
}
} catch (err) {
console.error('Failed to update sandbox pending domains:', err)
}
sandboxState.blockedHost = host
return false
}
// SandboxManager.initialize is a global operation that applies to the entire process.
await SandboxManager.initialize({
network: {
allowedDomains,
deniedDomains: [],
// We reset it first to ensure any previous process-global SOCKS/HTTP proxy servers
// and callbacks are cleaned up, allowing the new callback and allowedDomains to take effect.
await SandboxManager.reset()
await SandboxManager.initialize(
{
network: {
allowedDomains,
deniedDomains: [],
},
filesystem: {
denyRead: ['.env', '.env.*', '*.pem', '*.key'],
allowWrite,
denyWrite: ['.env', '.env.*', '*.pem', '*.key'],
},
},
filesystem: {
denyRead: ['.env', '.env.*', '*.pem', '*.key'],
allowWrite,
denyWrite: ['.env', '.env.*', '*.pem', '*.key'],
},
})
sandboxAskCallback,
)
const skillEnvs: Record<string, string> = {}
const onEnvsAdded = (envs: Record<string, string>) => {
@@ -169,7 +211,12 @@ export async function createAgentSession(params: CreateAgentSessionParams) {
)
}
const sandboxedBash = createSandboxedBashTool(process.cwd(), skillEnvs)
const sandboxedBash = createSandboxedBashTool(process.cwd(), skillEnvs, {
getBlockedHost: () => sandboxState.blockedHost,
clearBlockedHost: () => {
sandboxState.blockedHost = ''
},
})
const readSkill = createReadSkillTool(onEnvsAdded)
const systemTools: AgentTool[] = []
@@ -15,9 +15,15 @@ type BashDetails = {
stderr: string
}
export interface SandboxedBashOptions {
getBlockedHost?: () => string
clearBlockedHost?: () => void
}
export const createSandboxedBashTool = (
cwd: string,
skillEnvs: Record<string, string> = {},
options?: SandboxedBashOptions,
): AgentTool<typeof BashParameters, BashDetails> => {
return {
name: 'bash',
@@ -29,6 +35,7 @@ export const createSandboxedBashTool = (
{ command, timeout },
signal,
): Promise<AgentToolResult<BashDetails>> => {
options?.clearBlockedHost?.()
const wrappedCommand = await SandboxManager.wrapWithSandbox(command)
return new Promise((resolve, reject) => {
@@ -94,12 +101,20 @@ export const createSandboxedBashTool = (
if (timeoutHandle) clearTimeout(timeoutHandle)
signal?.removeEventListener('abort', onAbort)
const blocked = options?.getBlockedHost?.()
if (signal?.aborted) {
logger.error({ command, stdout, stderr }, 'Sandboxed bash command aborted')
reject(new Error('aborted'))
} else if (timedOut) {
logger.error({ timeout, command, stdout, stderr }, 'Sandboxed bash command timed out')
reject(new Error(`bash command timed out after ${timeout} seconds`))
} else if (blocked) {
reject(
new Error(
`Network request to ${blocked} is blocked, please ask admin to allow it in sandbox settings.`,
),
)
} else if (code !== 0 && code !== null) {
logger.error(
{ exitCode: code, command, stdout, stderr },
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "@shumai/api",
"version": "0.0.4",
"version": "0.0.7",
"private": true,
"type": "module",
"main": "./src/index.ts",
@@ -6,7 +6,7 @@ import { assetService } from '@shumai/core/src/asset/asset'
import { metadataService } from '@shumai/core/src/metadata/metadata'
import { notificationService } from '@shumai/core/src/notification/notification'
import { s3Service } from '@shumai/core/src/s3/s3'
import { transcodeService } from '@shumai/transcode/src/transcode'
import { transcodeService } from '@shumai/core'
import { authMiddleware } from './middleware/auth'
import { authzService, ResourceType, Permission } from '@shumai/core/src/authz/authz'
@@ -17,7 +17,7 @@ import {
uploadFileRequestSchema,
getDownloadLinksRequestSchema,
} from '@shumai/dtos'
import { transcodeService } from '@shumai/transcode/src/transcode'
import { transcodeService } from '@shumai/core'
import fs from 'fs'
import { Hono } from 'hono'
import os from 'os'
+20 -20
View File
@@ -1,25 +1,25 @@
import type { Prisma } from '@shumai/db'
import { Hono } from 'hono'
import agentRoute from './api/agent'
import attachmentRoute from './api/attachment'
import authnRoute from './api/authn'
import collectionRoute from './api/collection'
import fileRoute from './api/file'
import folderRoute from './api/folder'
import inviteRoute from './api/invite'
import metadataRoute from './api/metadata'
import { authMiddleware } from './api/middleware/auth'
import notificationRoute from './api/notification'
import projectRoute from './api/project'
import providerRoute from './api/provider'
import publicInviteRoute from './api/public-invite'
import publicShareRoute from './api/public-share'
import s3Route from './api/s3'
import shareRoute from './api/share'
import skillRoute from './api/skill'
import teamRoute from './api/team'
import uploadRoute from './api/upload'
import versionStackRoute from './api/versionStack'
import agentRoute from './agent'
import attachmentRoute from './attachment'
import authnRoute from './authn'
import collectionRoute from './collection'
import fileRoute from './file'
import folderRoute from './folder'
import inviteRoute from './invite'
import metadataRoute from './metadata'
import { authMiddleware } from './middleware/auth'
import notificationRoute from './notification'
import projectRoute from './project'
import providerRoute from './provider'
import publicInviteRoute from './public-invite'
import publicShareRoute from './public-share'
import s3Route from './s3'
import shareRoute from './share'
import skillRoute from './skill'
import teamRoute from './team'
import uploadRoute from './upload'
import versionStackRoute from './versionStack'
type User = Prisma.UserGetPayload<Record<string, never>>
@@ -268,13 +268,17 @@ describe('team api', () => {
})
it('GET /teams/:teamId/sandbox returns sandbox settings', async () => {
mockGetSandboxSettings.mockResolvedValue({ allowedDomains: ['example.com'] })
mockGetSandboxSettings.mockResolvedValue({
allowedDomains: ['example.com'],
pendingDomains: ['pending.com'],
})
const res = await app.request('/teams/t1/sandbox')
expect(res.status).toBe(200)
const data = await res.json()
expect(data.allowedDomains).toEqual(['example.com'])
expect(data.pendingDomains).toEqual(['pending.com'])
expect(authzService.hasPermission).toHaveBeenCalledWith(
expect.objectContaining({
type: ResourceType.Team,
@@ -286,17 +290,21 @@ describe('team api', () => {
})
it('PUT /teams/:teamId/sandbox updates sandbox settings', async () => {
mockUpdateSandboxSettings.mockResolvedValue({ allowedDomains: ['new.com'] })
mockUpdateSandboxSettings.mockResolvedValue({
allowedDomains: ['new.com'],
pendingDomains: ['new-pending.com'],
})
const res = await app.request('/teams/t1/sandbox', {
method: 'PUT',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({ allowedDomains: ['new.com'] }),
body: JSON.stringify({ allowedDomains: ['new.com'], pendingDomains: ['new-pending.com'] }),
})
expect(res.status).toBe(200)
const data = await res.json()
expect(data.allowedDomains).toEqual(['new.com'])
expect(data.pendingDomains).toEqual(['new-pending.com'])
expect(authzService.hasPermission).toHaveBeenCalledWith(
expect.objectContaining({
type: ResourceType.Team,
@@ -304,6 +312,9 @@ describe('team api', () => {
permission: Permission.Admin,
}),
)
expect(mockUpdateSandboxSettings).toHaveBeenCalledWith('t1', { allowedDomains: ['new.com'] })
expect(mockUpdateSandboxSettings).toHaveBeenCalledWith('t1', {
allowedDomains: ['new.com'],
pendingDomains: ['new-pending.com'],
})
})
})
+2 -1
View File
@@ -1,6 +1,6 @@
{
"name": "@shumai/core",
"version": "0.0.4",
"version": "0.0.7",
"private": true,
"type": "module",
"main": "./src/index.ts",
@@ -18,6 +18,7 @@
"hono": "4.12.23",
"jittered-fractional-indexing": "1.0.1",
"pino": "10.3.1",
"sharp": "0.34.5",
"tweetnacl": "1.0.3",
"ulid": "3.0.2",
"yaml": "2.9.0",
+130
View File
@@ -1152,6 +1152,134 @@ describe('AssetService', () => {
expect(updatedA?.sortIndex && updatedA.sortIndex > 'a1').toBe(true)
})
it('verifies that sortIndex uses C collation to prevent fractional indexing mismatch', async () => {
const { user, project } = await setupBasicAssets()
// Create a parent folder to contain our assets
const folder = await prisma.asset.create({
data: {
name: 'Parent Folder',
type: AssetType.folder,
projectId: project.id,
creatorId: user.id,
status: 'uploaded',
},
})
// Create Asset A: In ASCII, "YjnsD0vZ" > "YjNuyGpV" because "n" (110) > "N" (78).
// In default Postgres locale collation, "YjnsD0vZ" < "YjNuyGpV".
const assetA = await prisma.asset.create({
data: {
name: 'Asset A',
type: AssetType.file,
parentId: folder.id,
projectId: project.id,
creatorId: user.id,
sortIndex: 'YjnsD0vZ',
status: 'uploaded',
},
})
// Create Asset B
const assetB = await prisma.asset.create({
data: {
name: 'Asset B',
type: AssetType.file,
parentId: folder.id,
projectId: project.id,
creatorId: user.id,
sortIndex: 'YjNuyGpV',
status: 'uploaded',
},
})
// Create Asset C
const assetC = await prisma.asset.create({
data: {
name: 'Asset C',
type: AssetType.file,
parentId: folder.id,
projectId: project.id,
creatorId: user.id,
sortIndex: 'Yjzaaa',
status: 'uploaded',
},
})
// Verify ASCII ordering in JavaScript: assetA.sortIndex > assetB.sortIndex
expect(assetA.sortIndex! > assetB.sortIndex!).toBe(true)
// Verify Postgres sorting behavior:
// With C collation, it must follow ASCII ordering. Therefore, searching for
// sortIndex < assetB.sortIndex must NOT find assetA.
const prevAsset = await prisma.asset.findFirst({
where: {
parentId: folder.id,
sortIndex: { lt: assetB.sortIndex! },
id: { not: assetC.id },
},
orderBy: { sortIndex: 'desc' },
})
// Assert that the database collation is correctly "C" (returns null for prevAsset)
expect(prevAsset).toBeNull()
// Assert that updateAssetOrder succeeds without throwing a collation error
const updatedC = await assetService.updateAssetOrder(assetC.id, {
beforeIndex: assetB.sortIndex!,
})
expect(updatedC.sortIndex).toBeDefined()
expect(updatedC.sortIndex! < assetB.sortIndex!).toBe(true)
})
it('correctly bounds the new sortIndex when moving an asset after another asset in the middle of the list', async () => {
const { user, project } = await setupBasicAssets()
// Create three assets: A, B, C with specific sort indexes
const assetA = await prisma.asset.create({
data: {
name: 'Asset A',
type: AssetType.file,
projectId: project.id,
creatorId: user.id,
sortIndex: 'a0',
status: 'uploaded',
},
})
const assetB = await prisma.asset.create({
data: {
name: 'Asset B',
type: AssetType.file,
projectId: project.id,
creatorId: user.id,
sortIndex: 'a1',
status: 'uploaded',
},
})
const assetC = await prisma.asset.create({
data: {
name: 'Asset C',
type: AssetType.file,
projectId: project.id,
creatorId: user.id,
sortIndex: 'a11',
status: 'uploaded',
},
})
// Move Asset A to be after Asset B (it should be placed between B ("a1") and C ("a11"))
const updatedA = await assetService.updateAssetOrder(assetA.id, {
afterIndex: assetB.sortIndex!,
})
// Verify it is placed after B
expect(updatedA.sortIndex! > assetB.sortIndex!).toBe(true)
// Verify it is placed before C (this fails under the buggy code because C's bound is ignored, generating a key greater than "a11")
expect(updatedA.sortIndex! < assetC.sortIndex!).toBe(true)
})
describe('Symlinks', () => {
it('toAssetInfo resolves symlink target metadata', async () => {
const { project, user } = await setupBasicAssets()
@@ -1266,6 +1394,7 @@ describe('AssetService', () => {
creatorId: user.id,
status: 'uploaded',
sizeByte: 100,
sortIndex: 'abc',
},
})
@@ -1297,6 +1426,7 @@ describe('AssetService', () => {
expect(res.data).toHaveLength(1)
const stackAsset = res.data[0]
expect(stackAsset.type).toBe(AssetType.version_stack)
expect(stackAsset.sortIndex).toBe('abc')
expect(stackAsset.versionStack).toBeDefined()
expect(stackAsset.versionStack?.versions).toHaveLength(2)
const versions = stackAsset.versionStack!.versions
+10 -1
View File
@@ -533,6 +533,7 @@ export class AssetService {
parentId: stackParentId,
creatorId: creatorId,
name: '',
sortIndex: destFile.sortIndex,
},
})
@@ -973,7 +974,15 @@ export class AssetService {
afterSortIndex = prevAsset?.sortIndex || null
} else if (req.afterIndex) {
afterSortIndex = req.afterIndex
beforeSortIndex = null
const nextAsset = await this.prismaClient.asset.findFirst({
where: {
parentId: asset.parentId,
sortIndex: { gt: req.afterIndex },
id: { not: id },
},
orderBy: { sortIndex: 'asc' },
})
beforeSortIndex = nextAsset?.sortIndex || null
}
const newSortIndex = generateKeyBetween(afterSortIndex, beforeSortIndex)

Some files were not shown because too many files have changed in this diff Show More