f1aa1c3e3b
Introduce support for external compute worker mode (`COMPUTE_MODE=worker`) using a new `WorkerComputeBackend`. This enables offloading heavy ONNX Whisper alignment and PDF layout parsing to a standalone worker service (Redis + BullMQ), improving scalability and compatibility with serverless/limited environments. - Add `@openreader/compute-core` as a shared package for ONNX inference and PDF parsing logic. - Implement `WorkerComputeBackend` and worker contract/types for remote job execution. - Update compute backend selection logic and remove previous worker mode guards. - Extend `WhisperAlignInput` and `PdfLayoutInput` types to support object keys for remote data access. - Refactor local compute backend to use `@openreader/compute-core` and support both buffer and object key inputs. - Update job runner, TTS segment alignment, and PDF layout parsing flows to use new compute backend APIs. - Add scripts, Docker workflow, and documentation for deploying and running the compute worker. - Update environment variable docs and examples for worker mode, including storage requirements and configuration. - Document published images and stack changes to reflect the new compute worker architecture. BREAKING CHANGE: `COMPUTE_MODE=worker` now requires an external compute worker service and S3-compatible object storage. Embedded SeaweedFS (`weed mini`) is not supported in worker mode. See the new documentation for deployment and configuration details.
70 lines
4.1 KiB
Markdown
70 lines
4.1 KiB
Markdown
---
|
|
title: Stack
|
|
---
|
|
|
|
## Framework
|
|
|
|
- [Next.js](https://nextjs.org/) 15 (App Router, Turbopack in dev)
|
|
- [React](https://react.dev/) 19
|
|
- [TypeScript](https://www.typescriptlang.org/)
|
|
- [pnpm](https://pnpm.io/) workspaces monorepo
|
|
|
|
## Containerization and runtime
|
|
|
|
- [Docker](https://www.docker.com/) (linux/amd64 and linux/arm64)
|
|
- Shared entrypoint that runs DB migrations by default and can bootstrap embedded SeaweedFS before app startup
|
|
|
|
## Next.js client
|
|
|
|
- UI: [Tailwind CSS](https://tailwindcss.com), [Headless UI](https://headlessui.com), [@tailwindcss/typography](https://tailwindcss.com/docs/typography-plugin)
|
|
- Interactions: `react-dnd`, `react-dropzone`
|
|
- Server state: [TanStack Query](https://tanstack.com/query) (React Query v5)
|
|
- Authentication: [Better Auth](https://www.better-auth.com/) client SDK
|
|
- Local storage/cache: [Dexie.js](https://dexie.org/) (IndexedDB)
|
|
- Audio playback: [Howler.js](https://howlerjs.com/)
|
|
- Notifications: `react-hot-toast`
|
|
- Document rendering:
|
|
- PDF: [react-pdf](https://github.com/wojtekmaj/react-pdf), [pdf.js](https://mozilla.github.io/pdf.js/)
|
|
- EPUB: [react-reader](https://github.com/gerhardsletten/react-reader), [epubjs](https://github.com/futurepress/epub.js/)
|
|
- Markdown/Text: [react-markdown](https://github.com/remarkjs/react-markdown), [remark-gfm](https://github.com/remarkjs/remark-gfm)
|
|
- Text preprocessing/matching: [compromise](https://github.com/spencermountain/compromise), [cmpstr](https://github.com/remsky/cmpstr)
|
|
- Analytics: [Vercel Analytics](https://vercel.com/analytics)
|
|
|
|
## Next.js server
|
|
|
|
- APIs: Route Handlers for sync, blob/content access, migrations, audiobook export, TTS/Whisper proxying
|
|
- State sync: request-based today (not realtime push updates)
|
|
- Authentication: [Better Auth](https://www.better-auth.com/) server handlers/adapters with anonymous session support
|
|
- Metadata DB: [Drizzle ORM](https://orm.drizzle.team/) with SQLite (`better-sqlite3`) by default and optional Postgres (`pg`)
|
|
- App tables are manually maintained in Drizzle schema files
|
|
- Auth tables are auto-generated by the [Better Auth](https://www.better-auth.com/) CLI and migrated alongside app tables via Drizzle
|
|
- Blob storage: embedded [SeaweedFS](https://github.com/seaweedfs/seaweedfs) (`weed mini`) by default, or external S3-compatible storage via AWS SDK v3
|
|
- TTS providers: OpenAI-compatible API (`openai` SDK), [Replicate](https://replicate.com/) (`replicate` client), DeepInfra, and custom OpenAI-compatible endpoints — credentials are encrypted at rest
|
|
- Audio pipeline: [ffmpeg](https://ffmpeg.org/) (`ffmpeg-static`) for audiobook assembly, `archiver` for export packaging
|
|
- Utilities: `lru-cache` for in-process caching, `fast-xml-parser` for EPUB/XML parsing, `uuid` for identifier generation, `zod` for schema validation
|
|
|
|
## External compute worker (optional)
|
|
|
|
Monorepo packages under `compute/`:
|
|
|
|
- **`@openreader/compute-core`** — ONNX runtime lifecycle, model management, and inference logic shared between local and worker modes
|
|
- ONNX runtime: `onnxruntime-node` with `@huggingface/tokenizers`
|
|
- Whisper alignment: `onnx-community/whisper-base_timestamped` (int8) for word-level timestamps
|
|
- PDF layout: `Bei0001/PP-DocLayoutV3-ONNX` for document block detection and layout parsing
|
|
- PDF rendering: `pdfjs-dist`, `@napi-rs/canvas` for server-side page rasterization
|
|
- Utilities: `jszip`, `ffmpeg-static`
|
|
- **`@openreader/compute-worker`** — standalone Node.js worker service
|
|
- HTTP server: [Fastify](https://fastify.dev/) v5
|
|
- Job queue: [BullMQ](https://bullmq.io/) + [ioredis](https://github.com/redis/ioredis) (queues: `whisper-align`, `pdf-layout`)
|
|
- Storage: AWS SDK v3 S3 client for reading/writing blobs
|
|
- Logging: [Pino](https://getpino.io/)
|
|
- Validation: [Zod](https://zod.dev/)
|
|
- Compute mode is controlled by `COMPUTE_MODE` env var: `local` (in-process), `worker` (remote queue via HTTP + Redis), or disabled
|
|
|
|
## Tooling and testing
|
|
|
|
- ESLint
|
|
- TypeScript
|
|
- [Playwright](https://playwright.dev/) end-to-end tests
|
|
- Drizzle migration/generation scripts
|
|
- [Docusaurus](https://docusaurus.io/) documentation site (`docs-site/`)
|