pagepiper/docs/reference/environment-variables.md

42 lines
1.7 KiB
Markdown

# Environment Variables
Copy `.env.example` to `.env` and configure as needed.
## Core
| Variable | Default | Description |
|----------|---------|-------------|
| `PAGEPIPER_DATA_DIR` | `data` | Directory for SQLite databases and uploads |
| `PAGEPIPER_WATCH_DIR` | _(unset)_ | Directory scanned for PDFs/EPUBs on demand |
| `SECRET_KEY` | _(required)_ | Random secret for internal signing |
## Ollama / BYOK
| Variable | Default | Description |
|----------|---------|-------------|
| `PAGEPIPER_OLLAMA_URL` | _(unset)_ | Ollama base URL, e.g. `http://localhost:11434`. Enables hybrid search and chat. |
| `PAGEPIPER_EMBED_MODEL` | `nomic-embed-text` | Ollama embedding model |
| `PAGEPIPER_EMBED_DIMS` | `1024` | Embedding dimensions (must match the model) |
| `PAGEPIPER_CHAT_MODEL` | `mistral:7b` | Ollama chat/completion model |
## cf-orch (managed deployments)
| Variable | Default | Description |
|----------|---------|-------------|
| `CF_ORCH_URL` | _(unset)_ | cf-orch coordinator URL for GPU allocation |
| `CF_LICENSE_KEY` | _(unset)_ | License key for cf-orch authentication |
| `CF_APP_NAME` | `pagepiper` | Application identifier sent to cf-orch |
## License (cloud tier)
| Variable | Default | Description |
|----------|---------|-------------|
| `PAGEPIPER_HEIMDALL_URL` | _(unset)_ | Heimdall license server URL |
| `PAGEPIPER_HEIMDALL_TOKEN` | _(unset)_ | Admin token for license validation |
## Feature flags
| Variable | Default | Description |
|----------|---------|-------------|
| `PAGEPIPER_CHAT_FEEDBACK` | `false` | Enable thumbs up/down feedback UI on chat answers |
| `CLOUD_MODE` | `false` | Enable cloud-specific middleware (rate limiting, license checks) |