Add Unraid deployment template

2026-06-17 04:22:38 +02:00
parent 47103ed1a9
commit 3a8b82f59a
14 changed files with 363 additions and 14 deletions
@@ -67,6 +67,35 @@ This is a documentation-driven engineering repo. The documentation is not decora
 make readiness
 ```

+## Unraid / Tower deployment
+
+GeoIntel runs on Unraid as a Docker Compose stack with PostGIS, backend and frontend services. The frontend is the browser entrypoint and proxies `/api` and `/health` to the backend.
+
+Unraid template assets live in:
+
+- `deploy/unraid/geointel.env.example`
+- `deploy/unraid/geointel-unraid-template.xml`
+- `deploy/unraid/geointel-icon.svg`
+
+Copy the Unraid env template to `.env` in the checkout and edit ports there:
+
+```bash
+cd /mnt/user/appdata/geointel
+cp deploy/unraid/geointel.env.example .env
+nano .env
+docker compose up -d --build
+```
+
+Common editable values:
+
+```env
+GEOINTEL_FRONTEND_PORT=1202
+GEOINTEL_BACKEND_PORT=8000
+GEOINTEL_STORAGE_PATH=/mnt/user/appdata/geointel/storage
+```
+
+The database port is intentionally not exposed to the LAN. See `deploy/unraid/README.md` for full setup, port-change and cleanup notes.
+
 ## Sprint 2 quick start

 - Update dependencies: