6d5fb65a72
Add environment variables for fine-grained control over TTS rate limiting and Better Auth behavior. Move documentation to external Docusaurus site with automated deployment workflows. - TTS rate limiting can now be enabled/disabled via TTS_ENABLE_RATE_LIMIT - Customizable daily limits for anonymous/authenticated users and IP backstops - Better Auth rate limiting can be disabled via DISABLE_AUTH_RATE_LIMIT - Rename library import env vars to IMPORT_LIBRARY_DIRS/DIR - Add docs-site with Docusaurus and GitHub Actions workflows - Update README to reference external documentation
52 lines
1.3 KiB
Markdown
52 lines
1.3 KiB
Markdown
---
|
|
title: SQL Database
|
|
---
|
|
|
|
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 DB migrations automatically before app startup in:
|
|
|
|
- Docker container startup
|
|
- `pnpm dev`
|
|
- `pnpm start`
|
|
|
|
To skip automatic startup migrations:
|
|
|
|
- Set `RUN_DB_MIGRATIONS=false`
|
|
|
|
Database variables are documented in [Environment Variables](../guides/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
|
|
|
|
# Generate new migration files for both SQLite and Postgres outputs
|
|
pnpm generate
|
|
```
|
|
|
|
## Manual Drizzle commands (advanced)
|
|
|
|
```bash
|
|
# Migrate SQLite
|
|
npx drizzle-kit migrate --config drizzle.config.sqlite.ts
|
|
|
|
# Migrate Postgres
|
|
npx drizzle-kit migrate --config drizzle.config.pg.ts
|
|
|
|
# Generate SQLite migrations
|
|
npx drizzle-kit generate --config drizzle.config.sqlite.ts
|
|
|
|
# Generate Postgres migrations
|
|
npx drizzle-kit generate --config drizzle.config.pg.ts
|
|
```
|