Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions .env.example
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,8 @@ HTTP_PORT=3000
# gRPC Server
GRPC_HOST=127.0.0.1
GRPC_PORT=50051

# API keys used by both the HTTP and gRPC servers (required)
# See keys.example.json for the file format
VORTEXDB_KEYS_FILE=./keys.json
# required
GRPC_ROOT_PASSWORD=your-secure-password

# Database Configuration
# Storage: inmemory, rocksdb
Expand Down
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
.TODO
/databases
.env
/keys.json
__pycache__/
build/
.venv/
Expand Down
13 changes: 1 addition & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,23 +67,12 @@ cp .env.example .env
```

The following env vars are important, and are required to be set by the user:
`VORTEXDB_KEYS_FILE`
`GRPC_ROOT_PASSWORD`
`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 |
Expand Down
2 changes: 1 addition & 1 deletion client/python/USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ pip install -e .
The client communicates with VortexDB over gRPC and requires:

- gRPC endpoint (host:port)
- API key (must match a `key` entry in the server's `VORTEXDB_KEYS_FILE`)
- API key (maps to `GRPC_ROOT_PASSWORD` on the server)

These can be provided either:

Expand Down
Loading
Loading