Tool Settings

Also settable in a profile configuration to override the base configuration.

Some built-in tools support configurable settings, which can be specified using tool settings in the configuration YAML — for example shell_command’s allowed/approved commands, the Web tools’ host policies, and (since 0.9.14) per-command network access inside the cordon.

Updated in 0.9.15 Behavior change: the Web tools’ setting keys are unchanged, but hosts that appear in neither allowed_hosts nor denied_hosts are no longer allowed by default — they now require interactive approval each time (allow/deny once, or always). See Web toolset.

• tool_settings: Contains settings for tools by name
  • <tool_name>:
    • <setting_name>: <setting_value> where a value can be
      • a simple string, integer, or boolean, or
      • an array with only one of the simple types (i.e. array of strings)

Example

Look up the various system tools and built-in toolsets — like shell command execution and the Web toolset — for specific settings for tools.

tool_settings:
  shell_command:
    allowed_commands: ["ops", "ruby"]
    # New in 0.9.14: of these, only "ops test" runs with network access in the cordon
    network_allowed_commands: ["ops test"]
  http_get_web_page_as_markdown:
    denied_hosts: ["google.com"]
  http_get_web_page:
    allowed_hosts: ["google.com"]