Files
docker-docs/data/sbx_cli/sbx_settings_set.yaml
David Karlsson a1e520f672 docs: vendor Sandboxes v0.49 CLI reference
Copy docs/yml/*.yaml from docker/sandboxes release/v0.49 at c5b19951af121b439800029695f88bf1139a0b0b into data/sbx_cli without local edits.
2026-10-21 11:09:53 +00:00

35 lines
1.3 KiB
YAML

name: sbx settings set
synopsis: Set a setting override
description: |-
Set a user override for a setting. Values are parsed according to the
setting's type: bool (true or false), int, float, string, or raw JSON.
Administrator constraints apply; conflicting values are rejected.
Environment variables take precedence over user overrides.
Most changes take effect within about five seconds. This command reports
when a daemon restart is required.
usage: sbx settings set KEY VALUE [flags]
options:
- name: help
shorthand: h
default_value: "false"
usage: help for set
inherited_options:
- name: cloud
default_value: "false"
usage: |
Dispatch to Docker Cloud Sandboxes API instead of local sandboxd (supported by a growing set of verbs — run 'sbx --cloud --help' for the current list)
- name: debug
shorthand: D
default_value: "false"
usage: Enable debug logging
example: |4-
# Route sandbox, daemon, and CLI egress through an upstream proxy
sbx settings set proxy http://proxy.example.com:3128
# Pull template and kit images through a registry mirror
sbx settings set platform.images.registryMirror artifactory.corp/docker-remote
see_also:
- sbx settings - Manage Docker Sandboxes settings