Repository navigation
docs(deployment): document the Agent browser sidecar image - #1172
Open
linus-liu-web wants to merge 1 commit into
Open
linus-liu-web wants to merge 1 commit into
linus-liu-web wants to merge 1 commit into
Conversation
The Agent browser needs a separate agentflow-browser-<hash> image (about 1 GB) that the platform builds from assets embedded in the platform image on first use. Nothing on the default installation path prebuilds it and the deployment guide never mentions it, so operators on slow networks meet a first-use build with no documented way to prepare for it or to supply a prebuilt image. Document the sidecar and its reuse rules, the -browser-image prebuild command, the AGENTFLOW_BROWSER_NPM_REGISTRY and AGENTFLOW_BROWSER_IMAGE settings, image size and cleanup, and cross-reference it from the slow-network guidance.
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.
Companion: #1173 fixes the failure reporting and keeps the first sidecar image build alive when the request times out; this PR documents how to prebuild and supply that image.
What changed
The Agent browser needs a separate sidecar image (
agentflow-browser-<hash>, about 1 GB) that the platform builds from assets embedded in the platform image on first use. The deployment guide documents the sandbox image and the general Docker/git build limits, but never mentions this sidecar, its prebuild command, or the environment settings that control how it is produced.Add a paragraph to Docker sandboxes that covers:
docker compose exec platform /app/bin/agentflow -browser-image(prints the image name, no-op while the image is present);deb.debian.orgfor Chromium and fonts, npm registry defaulting toregistry.npmmirror.com, overridable withAGENTFLOW_BROWSER_NPM_REGISTRY);AGENTFLOW_BROWSER_IMAGEon the platform service;docker rmicleanup.Cross-reference the paragraph from Slow networks: clone and image build limits, since the browser build is not governed by those settings.
Related to #1160: the first UI use of the browser waits on this build under the request's own 4-minute limit, so on a slow network the build can be cancelled and reported as Chromium being unavailable. This PR documents how to prebuild and supply the image; it does not change that behavior.
Scope
Compatibility
No behavior or schema change.
Validation
python3 scripts/check-public.pypasses on the patched worktree.docker compose exec -T platform /app/bin/agentflow -browser-imageprintedagentflow-browser-<hash>in about 0.3 s without rebuilding;docker imagesshows the image at 1.06 GB, matching the documented size.-browser-imageincmd/agentflow/main.go,AGENTFLOW_BROWSER_IMAGE/AGENTFLOW_BROWSER_NPM_REGISTRYininternal/runtime/browser.go, npm registry default ininternal/runtime/browser_assets/Dockerfile.go test -p=2 ./...); documentation only.Safety