docs: add tl;dr section

This commit is contained in:
2026-05-31 14:54:38 +00:00
parent 6e3d18ce94
commit acce5ed05c
+24
View File
@@ -7,6 +7,30 @@ No auth to keep things simple - you either run in a private network or put it be
> GPT 5.5 generated > GPT 5.5 generated
## Tl;dr
When building the image yourself
```
docker run --rm \
-p 127.0.0.1:3000:80 \
-e PUBLIC_BASE_URL=http://localhost:3000 \
-v "$PWD/excali-box-data:/data" \
-v "$PWD/STYLES_GUIDE.md:/config/styles-guide.md:ro" \
excali
```
When pulling from GHCR ( you would want to change the `PUBLIC_BASE_URL` )
```
docker run --rm \
-p 127.0.0.1:3000:80 \
-e PUBLIC_BASE_URL=http://localhost:3000 \
-v "$PWD/excali-box-data:/data" \
-v "$PWD/STYLES_GUIDE.md:/config/styles-guide.md:ro" \
ghcr.io/ruinivist/excalidraw-box:latest
```
## Pull from GHCR and run ## Pull from GHCR and run
Images are published to: Images are published to: