Skip to content

docs: document the docker workflow - #590

Merged
Aymericr merged 1 commit into
mainfrom
docs/document-docker
Aug 4, 2026
Merged

docs: document the docker workflow#590
Aymericr merged 1 commit into
mainfrom
docs/document-docker

Conversation

@Aymericr

@Aymericr Aymericr commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Docker support landed in #268, but nothing in SETUP.md or README.md mentions it — the only way to discover it was to notice docker-compose.yml in the file listing.

Adds a short section with the one command, where saved scenes live, and the port constraint. That last one is worth writing down because the failure is non-obvious: remap the host port and /scenes returns 500, since the page derives its own API base URL from a value Next inlines at build time.

Docs only.

🤖 Generated with Claude Code


Note

Low Risk
Documentation-only change with no runtime or application code impact.

Overview
SETUP.md now documents how to run the editor with Docker after support landed elsewhere without setup instructions.

The new section covers docker compose up -d, http://localhost:3000, and persistence via the pascal-data volume across docker compose down. It also warns not to remap the container port: /scenes builds its API base from NEXT_PUBLIC_APP_URL, which Next inlines at build time, so a different host port can surface as a non-obvious 500 on that page.

Reviewed by Cursor Bugbot for commit d8be743. Bugbot is set up for automated code reviews on this repo. Configure here.

Docker support landed in #268 with no mention in SETUP.md, so the only way
to find it was to notice the compose file. Records the port constraint too,
since remapping it 500s the /scenes page for a non-obvious reason.

Co-Authored-By: Claude Opus 5 <[email protected]>
@Aymericr
Aymericr merged commit 4f4ec10 into main Aug 4, 2026
2 checks passed
@Aymericr
Aymericr deleted the docs/document-docker branch August 4, 2026 22:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant