Skip to content

Commit 77fc56a

Browse files
committed
Add local development section to Helix Enterprise documentation, detailing the use of the enterprise-dev image for running a gateway and database in a single container. Include warnings about data persistence and instructions for configuring dynamic queries with docker-compose.
1 parent 8a29970 commit 77fc56a

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

enterprise/working-with-enterprise.mdx

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,3 +114,34 @@ Important details:
114114
| Data storage | -- | Object storage |
115115
| Caching | -- | SSD + in-memory per process |
116116
| Scaling | -- | Auto-scaling readers |
117+
118+
## Local Development
119+
120+
For local development, Helix also ships a combined `enterprise-dev` image that runs a gateway and
121+
database together in a single container.
122+
123+
<Warning>
124+
The local image is development-only and uses in-memory storage.
125+
Stopping or restarting the container wipes all data.
126+
</Warning>
127+
128+
- If `PATH_TO_QUERIES` is unset, you can still use dynamic `POST /v1/query` requests.
129+
- If `PATH_TO_QUERIES` is set, the container loads stored queries from the mounted
130+
`queries.json` file during startup.
131+
132+
You can add this service to a local staging `docker-compose.yml`:
133+
134+
```yaml
135+
services:
136+
helix:
137+
image: ghcr.io/helixdb/enterprise-dev
138+
restart: unless-stopped
139+
ports:
140+
- "8080:8080"
141+
environment:
142+
PATH_TO_QUERIES: /workspace/queries.json
143+
volumes:
144+
- ./queries.json:/workspace/queries.json:ro
145+
```
146+
147+
If you only want dynamic queries, omit `PATH_TO_QUERIES` and the mounted `queries.json` volume.

0 commit comments

Comments
 (0)