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.
74 lines
1.9 KiB
TypeScript
74 lines
1.9 KiB
TypeScript
import type { SidebarsConfig } from '@docusaurus/plugin-content-docs';
|
|
|
|
const sidebars: SidebarsConfig = {
|
|
tutorialSidebar: [
|
|
'intro',
|
|
{
|
|
type: 'doc',
|
|
id: 'docker-quick-start',
|
|
label: '🐳 Docker Quick Start',
|
|
},
|
|
{
|
|
type: 'category',
|
|
label: '⚙️ Configure',
|
|
items: [
|
|
{
|
|
type: 'category',
|
|
label: '🔊 TTS Providers',
|
|
link: {
|
|
type: 'doc',
|
|
id: 'configure/tts-providers',
|
|
},
|
|
items: [
|
|
'configure/tts-provider-guides/kokoro-fastapi',
|
|
'configure/tts-provider-guides/kitten-tts-fastapi',
|
|
'configure/tts-provider-guides/orpheus-fastapi',
|
|
'configure/tts-provider-guides/replicate',
|
|
'configure/tts-provider-guides/deepinfra',
|
|
'configure/tts-provider-guides/openai',
|
|
'configure/tts-provider-guides/other',
|
|
],
|
|
},
|
|
{
|
|
type: 'doc',
|
|
id: 'configure/auth',
|
|
label: '🔐 Auth',
|
|
},
|
|
{
|
|
type: 'doc',
|
|
id: 'configure/admin-panel',
|
|
label: '🛡️ Admin Panel',
|
|
},
|
|
{
|
|
type: 'doc',
|
|
id: 'configure/server-library-import',
|
|
label: '📥 Server Library Import',
|
|
},
|
|
'configure/tts-rate-limiting',
|
|
'configure/database',
|
|
'configure/object-blob-storage',
|
|
'configure/migrations',
|
|
],
|
|
},
|
|
{
|
|
type: 'category',
|
|
label: '🚀 Deploy',
|
|
items: ['deploy/local-development', 'deploy/compute-worker', 'deploy/vercel-deployment'],
|
|
},
|
|
{
|
|
type: 'category',
|
|
label: 'Reference',
|
|
items: [
|
|
'reference/environment-variables',
|
|
'reference/stack',
|
|
],
|
|
},
|
|
{
|
|
type: 'category',
|
|
label: 'About',
|
|
items: ['about/support-and-contributing', 'about/acknowledgements', 'about/license'],
|
|
},
|
|
],
|
|
};
|
|
|
|
export default sidebars;
|