9b9206f50d
This commit restructures the audiobook generation and serving layer to rely exclusively on S3-compatible blob storage, removing the dependency on local filesystem paths. - Bundle `ffmpeg` and `ffprobe` binaries via npm to ensure portability across environments. - Update API routes to stream audio directly from blob storage instead of local disk. - Remove legacy migration endpoints and filesystem-based indexing logic. - Add startup scripts to facilitate the transition from local to remote storage. BREAKING CHANGE: Audiobook functionality is now strictly dependent on S3 configuration. The previous filesystem-based storage method has been removed.
64 lines
1.6 KiB
Markdown
64 lines
1.6 KiB
Markdown
---
|
|
title: Database and Migrations
|
|
---
|
|
|
|
This page covers database mode selection and migration behavior for OpenReader WebUI.
|
|
|
|
## Database mode
|
|
|
|
- Default mode: embedded SQLite at `docstore/sqlite3.db`
|
|
- External mode: Postgres when `POSTGRES_URL` is set
|
|
|
|
## Startup migration behavior
|
|
|
|
By default, the shared entrypoint runs migrations automatically before app startup in:
|
|
|
|
- Docker container startup
|
|
- `pnpm dev`
|
|
- `pnpm start`
|
|
|
|
Startup migration phases:
|
|
|
|
- DB schema migrations (`pnpm migrate`)
|
|
- Storage/data migration (`pnpm migrate-fs`) for legacy filesystem content into S3 + DB rows
|
|
|
|
To skip automatic startup migrations:
|
|
|
|
- Set `RUN_DRIZZLE_MIGRATIONS=false`
|
|
- Set `RUN_FS_MIGRATIONS=false`
|
|
|
|
Database variables are documented in [Environment Variables](../reference/environment-variables).
|
|
|
|
## Common project commands
|
|
|
|
In most cases, you do not need manual migration commands because startup runs migrations automatically.
|
|
|
|
```bash
|
|
# Run pending migrations (uses Postgres config when POSTGRES_URL is set, otherwise SQLite)
|
|
pnpm migrate
|
|
|
|
# Run storage migration (filesystem -> S3 + DB)
|
|
pnpm migrate-fs
|
|
|
|
# Dry-run storage migration without uploading/deleting
|
|
pnpm migrate-fs:dry-run
|
|
|
|
# Generate new migration files for both SQLite and Postgres outputs
|
|
pnpm generate
|
|
```
|
|
|
|
## Manual Drizzle commands (advanced)
|
|
|
|
```bash
|
|
# Migrate SQLite
|
|
pnpm exec drizzle-kit migrate --config drizzle.config.sqlite.ts
|
|
|
|
# Migrate Postgres
|
|
pnpm exec drizzle-kit migrate --config drizzle.config.pg.ts
|
|
|
|
# Generate SQLite migrations
|
|
pnpm exec drizzle-kit generate --config drizzle.config.sqlite.ts
|
|
|
|
# Generate Postgres migrations
|
|
pnpm exec drizzle-kit generate --config drizzle.config.pg.ts
|
|
```
|