added documentation for development

OpenMined · Feb 24, 2024 · b4235eb · b4235eb
1 parent f820db1
commit b4235eb
Showing 1 changed file with 23 additions and 0 deletions.
diff --git a/packages/grid/veilid/development.md b/packages/grid/veilid/development.md
@@ -0,0 +1,23 @@
+## Veilid - Development Instructions
+
+### 1. Building Veilid Container
+
+```sh
+cd packages/grid/veilid && docker build -f veilid.dockerfile -t veilid:0.1 .
+```
+
+### Running veilid Container
+
+#### 1. Development Mode
+
+```sh
+cd packages/grid/veilid && \
+docker run --rm -e DEV_MODE=True -p 4000:4000 -p 5959:5959 -p 5959:5959/udp  -v $(pwd)/server:/app/server veilid:0.1
+```
+
+#### 2. Production Mode
+
+```sh
+cd packages/grid/veilid && \
+docker run --rm  -p 4000:4000 -p 5959:5959 -p 5959:5959/udp veilid:0.1
+```