Skip to content

docs(sandboxes): document kit install-source allowlist (v0.34)#25454

Merged
dvdksn merged 2 commits into
docker:mainfrom
dvdksn:sbx-kit-source-allowlist
Jun 29, 2026
Merged

docs(sandboxes): document kit install-source allowlist (v0.34)#25454
dvdksn merged 2 commits into
docker:mainfrom
dvdksn:sbx-kit-source-allowlist

Conversation

@dvdksn

@dvdksn dvdksn commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

Summary

Document the kit install-source allowlist that shipped in sbx v0.34
(docker/sandboxes#3566) and is currently undocumented on the docs site.

The allowlist is secure by default and a breaking change for anyone
installing kits from non-Docker Hub sources (for example
git+https://github.com/docker/sbx-kits-contrib.git). Two new settings:

Setting Default Env var
kit.allowedSources ["docker.io/"] DOCKER_SANDBOXES_KIT_ALLOWED_SOURCES
kit.allowLocalKits true DOCKER_SANDBOXES_KIT_ALLOW_LOCAL

Changes

  • customize/kits.md — new "Restrict kit sources" section under Using
    kits
    : default allowlist, how to add a publisher, path-segment prefix
    matching, the ["*"] escape hatch, kit.allowLocalKits, and env vars.
  • troubleshooting.md — new entry for the "source is not in your
    allowlist" failure with the fix command.
  • security/_index.md — short note framing the allowlist as a
    supply-chain control (kit install commands run as root in the VM), linking
    to the kits section.

Scope

  • Independent of docs(sandboxes): credential bindings, kit spec v2 #25369 (credential bindings / kit schema v2) — that's a
    different axis (what a kit does vs. where a kit installs from) and is
    held on a separate gate. This PR can land on its own.
  • admin/MDM org enforcement is deferred

Follow-up (not in this PR)

The v0.34.0 GitHub release notes omit this allowlist from the Kits section,
so the auto-generated release-notes.md won't pick it up when regenerated.
The upstream release note should be amended at the source.

🤖 Generated with Claude Code

sbx v0.34 (docker/sandboxes#3566) restricts which sources a kit can be
installed from via two new settings, secure by default:

- kit.allowedSources (default ["docker.io/"]) — host/path prefixes for
  remote refs; ["*"] is the escape hatch.
- kit.allowLocalKits (default true) — toggle for local dir/ZIP installs.

This is a breaking change for installs from non-Docker Hub sources (for
example git+https://github.com/docker/...), and it is undocumented on the
docs site. Document it in the kits page, add a troubleshooting entry for
the "source is not in your allowlist" failure, and note the supply-chain
control in the security model.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@netlify

netlify Bot commented Jun 29, 2026

Copy link
Copy Markdown

Deploy Preview for docsdocker ready!

Name Link
🔨 Latest commit 81a6acc
🔍 Latest deploy log https://app.netlify.com/projects/docsdocker/deploys/6a4228ce7e1a5800085ea7a7
😎 Deploy Preview https://deploy-preview-25454--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.

@dvdksn dvdksn requested review from a team and mdelapenya June 29, 2026 08:11
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

@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: 🟡 NEEDS ATTENTION

One style issue found in the new content.

Comment thread content/manuals/ai/sandboxes/customize/kits.md
@dvdksn dvdksn added this to the sbx/v0.34.0 milestone Jun 29, 2026
@dvdksn dvdksn merged commit f9224e5 into docker:main Jun 29, 2026
24 of 25 checks passed
@dvdksn dvdksn deleted the sbx-kit-source-allowlist branch June 29, 2026 13:18
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.

4 participants