Skip to content

Commit a56ee15

Browse files
committed
docs(readme): document storage backend and migration
1 parent 748fdb1 commit a56ee15

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -147,8 +147,20 @@ Settings are initialized by `openkb init`, and stored in `.openkb/config.yaml`:
147147
model: gpt-5.4 # LLM model (any LiteLLM-supported provider)
148148
language: en # Wiki output language
149149
pageindex_threshold: 20 # PDF pages threshold for PageIndex
150+
storage_backend: sqlite # Storage backend: sqlite (default) or json
150151
```
151152
153+
### Storage Backend
154+
155+
OpenKB supports two storage backends for the file hash registry:
156+
157+
| Backend | Description | Use Case |
158+
|---------|-------------|----------|
159+
| `sqlite` | SQLite database (default) | Better concurrency, scalability, recommended for production |
160+
| `json` | JSON file | Simple, human-readable, for small installations |
161+
162+
Migration from JSON to SQLite happens automatically when you switch to `sqlite` backend and a `hashes.json` file exists. The JSON file is preserved but no longer used.
163+
152164
Model names use `provider/model` LiteLLM [format](https://docs.litellm.ai/docs/providers) (OpenAI models can omit the prefix):
153165

154166
| Provider | Model example |

0 commit comments

Comments
 (0)