docs: clarify persisted env vars reach the agent process - #25816
Conversation
…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>
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
docker-agent
left a comment
There was a problem hiding this comment.
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
left a comment
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
[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."
Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
Summary
/etc/sandbox-persistent.share visible to the agent process itself (not just an interactive shell), including API keys.Why
Prompted by confusion in docker/sbx-releases#252, where users assumed variables set this way wouldn't reach
sbx runagent sessions, or weren't sure how a new value propagates to an already-running agent.Test plan