You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit a85a721
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: README.md
+47Lines changed: 47 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -58,6 +58,53 @@ Interactive terminal user interface built with [Ratatui](https://github.com/rata
58
58
- Vector operations (insert, search, delete)
59
59
- Modal dialogs for user input
60
60
61
+
### Unified Server Startup
62
+
63
+
VortexDB offers a Dockerfile and a docker-compose for starting up the gRPC and HTTP servers
64
+
Steps to get the unified server running:
65
+
```
66
+
cp .env.example .env
67
+
```
68
+
69
+
The following env vars are important, and are required to be set by the user:
70
+
`GRPC_ROOT_PASSWORD`
71
+
`DIMENSION`
72
+
`DATA_PATH`
73
+
74
+
**NOTE**: `DATA_PATH` is the directory within the container where persistent data is stored
75
+
76
+
77
+
Setting of the following env vars is optional, as they fallback to safe defaults, but recommended:
78
+
| .env Var | Function | Safe Default |
79
+
| :--- | :--- | :--- |
80
+
|`HTTP_HOST`| Host IP for the HTTP Server |`0.0.0.0`|
81
+
|`HTTP_PORT`| Port for the HTTP Server |`3000`|
82
+
|`GRPC_HOST`| Host IP for the gRPC Server |`0.0.0.0`|
83
+
|`GRPC_PORT`| Port for the gRPC Server |`50051`|
84
+
|`STORAGE_TYPE`| Store `inmemory`\|`rocksdb`|`inmemory`|
85
+
|`INDEX_TYPE`| Type of Indexer: `flat`\|`kdtree`\|`hnsw`|`flat`|
86
+
|`LOGGING`| Enable logs |`true`|
87
+
|`DISABLE_HTTP`| Bool flag to run the HTTP Server |`false`|
88
+
89
+
90
+
**NOTE**: CLI flags (e.g. `docker compose run --env` ) take precedence over docker-compose environment values, which in turn override `.env` file variables.
91
+
92
+
Now you're all set up.
93
+
94
+
To run the unified server:
95
+
```
96
+
docker compose up
97
+
```
98
+
To build the image again and run the unified server (recommended after code changes):
99
+
```
100
+
docker compose up --build
101
+
```
102
+
To run only the gRPC server (HTTP server disabled):
0 commit comments