docs: document the docker workflow - #590
Merged
Merged
Conversation
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 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Docker support landed in #268, but nothing in
SETUP.mdorREADME.mdmentions it — the only way to discover it was to noticedocker-compose.ymlin 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
/scenesreturns 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.mdnow 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 thepascal-datavolume acrossdocker compose down. It also warns not to remap the container port:/scenesbuilds its API base fromNEXT_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.