From acce5ed05c684e0a5bac65ed1fa729a88558e69c Mon Sep 17 00:00:00 2001 From: ruinivist Date: Sun, 31 May 2026 14:54:38 +0000 Subject: [PATCH] docs: add tl;dr section --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index 09892ec..be7a637 100644 --- a/README.md +++ b/README.md @@ -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 +## 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 Images are published to: