summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorChristian Cleberg <[email protected]>2026-04-18 22:40:21 -0500
committerChristian Cleberg <[email protected]>2026-04-18 22:40:21 -0500
commita859138a50a7b7a53fd0b918c94cd7174689ff95 (patch)
tree2132fa7394403331a47809c46ad7e30a99d31c2a /README.md
parentaf6ac085443bf28a2229e8fc502a1cb290f03505 (diff)
downloadbrand-bench-a859138a50a7b7a53fd0b918c94cd7174689ff95.tar.gz
brand-bench-a859138a50a7b7a53fd0b918c94cd7174689ff95.tar.bz2
brand-bench-a859138a50a7b7a53fd0b918c94cd7174689ff95.zip
add docker deployment option
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md
index 82ba080..6312725 100644
--- a/README.md
+++ b/README.md
@@ -74,6 +74,32 @@ Larger models produce better-structured output. If generation fails with a JSON
error, try a bigger model. Generation typically takes 15–60 seconds depending on
hardware.
+## Self-hosting with Docker
+
+A `Dockerfile` and `compose.yml` are included for deploying the app alongside
+Ollama on a server.
+
+```bash
+docker compose up -d --build
+```
+
+The app is served on port 8000. Ollama's API is proxied through nginx at `/api/`
+so the browser never makes a cross-origin request — no CORS configuration
+needed.
+
+**After first boot, pull at least one model:**
+
+```bash
+docker compose exec ollama ollama pull llama3.2
+```
+
+Then open the app, go to Settings (⚙), enable AI, and set the Ollama base URL
+to `http://your-server:8000` (no path suffix).
+
+**GPU support:** If your server has an NVIDIA GPU, uncomment the `deploy` block
+in `compose.yml` (requires the
+[NVIDIA Container Toolkit](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html)).
+
## Project structure
```