@contrast/config

发现并解析 Contrast 节点.js 代理配置 contrast_security.yaml, (中文(简体) ), CONTRAST__* 环境变量和设置 对比的UI.

使用量

@contrast/agentify 将配置成核心 core.config。 。 。 .

// resolved values, as a nested object
if (core.config.protect.enable) { /* ... */ }

// a single option by its canonical name, and where its value came from
core.config.getEffectiveValue('assess.enable');
core.config.getEffectiveSource('assess.enable'); // e.g. 'ENVIRONMENT_VARIABLE'

// the effective options grouped by source, credentials redacted
core.config.getReport({ redact: true });

每个选项及其默认和描述在 lib/options.js。 。 。 .

优先发言

对于每个选项,一个环境变量会击败 YAML 文件, 文件击败 默认。 来自对比度 UI 的设置只覆盖尚存的选项 默认值( 或已经由 UI 设置) , 因此本地值总是获胜 .

环境变量名称为 CONTRAST__ 加上大写中的选项名称, 与 . 改为 __。例如, agent.node.app_root 变成 CONTRAST__AGENT__NODE__APP_ROOT。 。 。 .

配置文件

contrast_security.yaml 上三层,第一层 包含文件的级别 :

1. 当前的工作目录
2. /etc/contrast/node/,则 /etc/contrast/ (关于视窗, %ProgramData%\contrast\node\,则 %ProgramData%\contrast\(中文(简体) )
3. ~/.config/contrast/node/,则 ~/.config/contrast/

在该等级中找到的所有文件都合并 node/ 文件在其中获胜 重叠。 文件包含 root: true 用于自行使用并结束搜索.

CONTRAST_CONFIG_PATH 以单一文件取代搜索。 设为 无效设备( e)/dev/null,或 \\.\nul 在Windows上)跳过文件配置 完全没有.

要查看应用程序的有效配置, 请运行 npx -p @contrast/cli config-diagnostics <entrypoint> 从它的目录.