Getting started

Demo: https://bokebox.aiuo.net/ · Docs: https://bkb-docs.aiuo.net/

Full product copy: README.md.
Repo: https://github.com/vastsa/BokeBox · License: LGPL-3.0

First launch walks you through account init and model setup.

Requirements

• Node.js >= 22.5
• pnpm 9.x (pinned via packageManager)
• Optional: Docker / Docker Compose

Local dev

git clone https://github.com/vastsa/BokeBox.git
cd BokeBox
cp .env.example .env   # fill in API keys
./start.sh             # open http://localhost:5173

Or:

pnpm install
pnpm dev

• Web: address printed in the terminal (usually http://localhost:5173)
• API: default http://localhost:8787

Keys and models: Configuration.

Docker (quick)

cp .env.example .env
docker pull ghcr.io/vastsa/bokebox:latest
./start.sh docker
# http://localhost:8787

More options (local build, CN mirrors, reverse proxy): Deployment.

First episode

1. Open the site and finish onboarding
2. Confirm AI services under Settings
3. Drop a link / upload a draft or video
4. When the pipeline finishes, play from the library

Step-by-step: First episode.
Pipeline stages: Pipeline.
AI clients: MCP.

This docs site

pnpm docs:dev
pnpm docs:build
pnpm docs:preview

Next

• Settings — settings map
• Introduction — product positioning
• Features — capability list
• Architecture — data flow
• Plugins — extend sources & voices
• Docker CI/CD — image publishing