openreader/docs-site/docs/deploy/docker-compose.md

title	description
Docker Compose	Run OpenReader with the slim, full, or local-build Docker Compose examples.

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

Use these examples to run OpenReader with Kokoro-FastAPI and persistent storage. Choose the slim stack for the simplest deployment, or the full stack when you want PostgreSQL, SeaweedFS, NATS, and the compute worker as separate containers.

Prerequisites

• A recent Docker version with Docker Compose
• A clone of the OpenReader repository

git clone https://github.com/richardr1126/openreader.git
cd openreader

Choose a stack

The default slim example runs:

• OpenReader with embedded SeaweedFS, NATS, compute worker, and SQLite
• Kokoro-FastAPI as a companion container

docker compose -f docker/examples/compose.yml up
# Repository convenience command: pnpm compose

Compose file: docker/examples/compose.yml

The full example runs OpenReader, Kokoro-FastAPI, PostgreSQL, SeaweedFS, NATS, and the compute worker as separate containers using published images.

docker compose -f docker/examples/compose.full.yml up
# Repository convenience command: pnpm compose:full

Compose file: docker/examples/compose.full.yml

For details about running the worker separately, see Compute Worker.

The local-build example uses the full multi-container layout, but builds the OpenReader app and compute-worker images from the current checkout.

docker compose -f docker/examples/compose.local.yml up --build
# Repository convenience command: pnpm compose:local

Compose file: docker/examples/compose.local.yml

Included services

Service	Slim	Full	Local Build
OpenReader	Published image	Published image	Local build
Kokoro-FastAPI	Container	Container	Container
Database	Embedded SQLite	PostgreSQL container	PostgreSQL container
SeaweedFS	Embedded	Container	Container
NATS	Embedded	Container	Container
Compute worker	Embedded	Published image	Local build

On first boot, RUNTIME_SEED_JSON creates an enabled Kokoro shared provider and selects it as the default TTS provider.

Endpoints

• OpenReader: http://localhost:3003
• SeaweedFS S3: http://localhost:8333
• Kokoro-FastAPI: http://localhost:8880

In the full examples, PostgreSQL, the compute worker, and NATS remain internal to the Compose network.

LAN access

Set BASE_URL and S3_ENDPOINT to the Docker host's LAN IP so browser-facing app and presigned S3 URLs are reachable from other devices:

BASE_URL=http://192.168.0.XXX:3003 \
S3_ENDPOINT=http://192.168.0.XXX:8333 \
docker compose -f docker/examples/compose.yml up
# Repository convenience command: pnpm compose

BASE_URL=http://192.168.0.XXX:3003 \
S3_ENDPOINT=http://192.168.0.XXX:8333 \
docker compose -f docker/examples/compose.full.yml up
# Repository convenience command: pnpm compose:full

BASE_URL=http://192.168.0.XXX:3003 \
S3_ENDPOINT=http://192.168.0.XXX:8333 \
docker compose -f docker/examples/compose.local.yml up --build
# Repository convenience command: pnpm compose:local

Replace 192.168.0.XXX with your Docker host's LAN IP and allow inbound TCP ports 3003 and 8333 through its firewall.

:::info Internal full-stack endpoint The full and local-build compute workers continue using http://seaweedfs:8333 internally. S3_ENDPOINT configures the app endpoint and browser-facing presigned URLs. :::

Configuration

The examples use local-only default credentials. Override existing ${VARIABLE} values through your shell environment before using them beyond local development.

:::warning Protect public deployments Replace the default AUTH_SECRET, PostgreSQL credentials, S3 credentials, and compute-worker token before exposing a stack outside your trusted local network. :::

For the complete configuration reference, see Environment Variables. See Database for PostgreSQL and SQLite behavior.