Skip to content

Commit 9124f51

Browse files
committed
docs: document storage backend and migration
1 parent e51026e commit 9124f51

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,8 +163,20 @@ Settings are initialized by `openkb init`, and stored in `.openkb/config.yaml`:
163163
model: gpt-5.4 # LLM model (any LiteLLM-supported provider)
164164
language: en # Wiki output language
165165
pageindex_threshold: 20 # PDF pages threshold for PageIndex
166+
storage_backend: sqlite # Storage backend: sqlite (default) or json
166167
```
167168
169+
### Storage Backend
170+
171+
OpenKB supports two storage backends for the file hash registry:
172+
173+
| Backend | Description | Use Case |
174+
|---------|-------------|----------|
175+
| `sqlite` | SQLite database (default) | Better concurrency, scalability, recommended for production |
176+
| `json` | JSON file | Simple, human-readable, for small installations |
177+
178+
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.
179+
168180
Model names use `provider/model` LiteLLM [format](https://docs.litellm.ai/docs/providers) (OpenAI models can omit the prefix):
169181

170182
| Provider | Model example |

0 commit comments

Comments
 (0)