Skip to content

Commit 84ee1fb

Browse files
committed
update readme for new docker
1 parent 88aad1e commit 84ee1fb

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,30 @@ start.bat # Windows CMD
2525

2626
This starts both FastAPI services under uv, runs the Electron client, and cleans up the servers when you close the UI. Re-run the bootstrap script any time you need to refresh dependencies.
2727

28+
## Containerized Backend (Docker)
29+
30+
Prefer to keep everything in a container? The provided image uses uv inside the container so the backend is ready in one build step. This target runs the FastAPI API (`:4242`), the PyTC worker service (`:4243`), the Neuroglancer bridge (`:4244`), and TensorBoard (`:6006`). Electron is not included—use your local client or Electron build to talk to the containerised backend.
31+
32+
**Prerequisites**
33+
- Docker with Compose V2 (`docker compose`)
34+
35+
**Build the image**
36+
```bash
37+
docker compose build backend
38+
```
39+
40+
**Run the backend services**
41+
```bash
42+
docker compose up backend
43+
```
44+
45+
When you are done:
46+
```bash
47+
docker compose down
48+
```
49+
50+
You can now point the desktop client at `http://localhost:4242`.
51+
2852
## Legacy Manual Setup (without uv)
2953

3054
If you prefer to manage Python environments yourself, follow the steps below. Expect a slower install and more moving pieces.

0 commit comments

Comments
 (0)