Merge branch 'refactor' into documet-rag-refactor

Author: ishnbl

.env.example

@@ -5,8 +5,10 @@ HTTP_PORT=3000
 # gRPC Server
 GRPC_HOST=127.0.0.1
 GRPC_PORT=50051
-# required
-GRPC_ROOT_PASSWORD=your-secure-password
+
+# API keys used by both the HTTP and gRPC servers (required)
+# See keys.example.json for the file format
+VORTEXDB_KEYS_FILE=./keys.json
 
 # Database Configuration
 # Storage: inmemory, rocksdb

.gitignore

@@ -7,6 +7,7 @@
 .TODO
 /databases
 .env
+/keys.json
 __pycache__/
 build/
 .venv/

README.md

@@ -67,12 +67,23 @@ cp .env.example .env
 ```
 
 The following env vars are important, and are required to be set by the user:  
-`GRPC_ROOT_PASSWORD`  
+`VORTEXDB_KEYS_FILE`  
 `DIMENSION`  
 `DATA_PATH`  
 
 **NOTE**: `DATA_PATH` is the directory within the container where persistent data is stored
 
+**NOTE**: `VORTEXDB_KEYS_FILE` points to a JSON file of API keys shared by both the HTTP and gRPC servers, e.g.:
+```json
+{
+  "keys": [
+    { "name": "admin", "role": "readwrite", "key": "some-random-secret" },
+    { "name": "search-service", "role": "readonly", "key": "another-random-secret" }
+  ]
+}
+```
+Requests authenticate with an `api-key: <key>` header over HTTP, or an `authorization: Bearer <key>` header over gRPC. `readonly` keys can read/search but not insert, batch-insert, or delete; `readwrite` keys can do all of the above. See `keys.example.json`.
+
 
 Setting of the following env vars is optional, as they fallback to safe defaults, but recommended:  
 | .env Var | Function | Safe Default |

client/python/USAGE.md

@@ -18,7 +18,7 @@ pip install -e .
 The client communicates with VortexDB over gRPC and requires:
 
 - gRPC endpoint (host:port)
-- API key (maps to `GRPC_ROOT_PASSWORD` on the server)
+- API key (must match a `key` entry in the server's `VORTEXDB_KEYS_FILE`)
 
 These can be provided either: