Skip to content

docs: clarify persisted env vars reach the agent process - #25816

Merged
dvdksn merged 2 commits into
docker:mainfrom
mdelapenya:docs/clarify-sandbox-persistent-env-faq
Aug 13, 2026
Merged

docs: clarify persisted env vars reach the agent process#25816
dvdksn merged 2 commits into
docker:mainfrom
mdelapenya:docs/clarify-sandbox-persistent-env-faq

Conversation

@mdelapenya

Copy link
Copy Markdown
Member

Summary

  • Clarifies that variables set in /etc/sandbox-persistent.sh are visible to the agent process itself (not just an interactive shell), including API keys.
  • Notes that a variable only takes effect for sessions/agents started after it's added — a running agent needs a restart to pick it up.

Why

Prompted by confusion in docker/sbx-releases#252, where users assumed variables set this way wouldn't reach sbx run agent sessions, or weren't sure how a new value propagates to an already-running agent.

Test plan

  • Docs site build/preview renders the FAQ section correctly

…st shells

Users setting API keys via /etc/sandbox-persistent.sh weren't sure the
variables were visible to the agent process itself when launched with
sbx run, versus only in an interactive shell. Also note that a running
agent/sandbox needs a restart to pick up newly added variables.

Signed-off-by: Manuel de la Peña <manuel.delapena@docker.com>
@mdelapenya
mdelapenya requested a review from dvdksn as a code owner August 13, 2026 07:12
@netlify

netlify Bot commented Aug 13, 2026

Copy link
Copy Markdown

Deploy Preview for docsdocker ready!

Name Link
🔨 Latest commit 5ef0903
🔍 Latest deploy log https://app.netlify.com/projects/docsdocker/deploys/6a7d70572ae5450008fcd872
😎 Deploy Preview https://deploy-preview-25816--docsdocker.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@docker-agent docker-agent left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Assessment: 🟢 APPROVE

The changes accurately clarify that variables in /etc/sandbox-persistent.sh are visible to the agent process itself (not just interactive shells), and that a running agent needs a restart to pick up new values. The added content is concise, technically accurate, and consistent with the existing document's tone and scope. No issues found.

@docker-agent docker-agent left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Assessment: 🟢 APPROVE

The change is well-scoped, factually accurate, and matches the existing FAQ's tone. One minor style note below.

agent-specific variables such as API keys. The agent process itself sees
these variables, not just an interactive shell you open separately.

A variable only takes effect for sessions and agents started *after* it's

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[LOW] Italics used for mid-sentence emphasis

The style guide says to use italics sparingly — notable exceptions are titles of articles, blog posts, or specification documents, not in-sentence emphasis. Consider rewording to avoid the need for emphasis: "A variable only takes effect for sessions and agents that start after you add it."

Comment thread content/manuals/ai/sandboxes/faq.md Outdated
Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
@dvdksn
dvdksn merged commit 7a59b52 into docker:main Aug 13, 2026
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants