docs: update configuration documentation
- Add missing config options: STRIX_LLM_MAX_RETRIES, STRIX_MEMORY_COMPRESSOR_TIMEOUT, STRIX_TELEMETRY - Remove non-existent options: LLM_RATE_LIMIT_DELAY, LLM_RATE_LIMIT_CONCURRENT - Fix defaults: STRIX_SANDBOX_EXECUTION_TIMEOUT (500 -> 120), STRIX_IMAGE (0.1.10 -> 0.1.11) - Add config file documentation section - Add --config CLI option to cli.mdx
This commit is contained in:
@@ -3,7 +3,7 @@ title: "Configuration"
|
|||||||
description: "Environment variables for Strix"
|
description: "Environment variables for Strix"
|
||||||
---
|
---
|
||||||
|
|
||||||
Configure Strix using environment variables.
|
Configure Strix using environment variables or a config file.
|
||||||
|
|
||||||
## LLM Configuration
|
## LLM Configuration
|
||||||
|
|
||||||
@@ -23,27 +23,35 @@ Configure Strix using environment variables.
|
|||||||
Request timeout in seconds for LLM calls.
|
Request timeout in seconds for LLM calls.
|
||||||
</ParamField>
|
</ParamField>
|
||||||
|
|
||||||
<ParamField path="LLM_RATE_LIMIT_DELAY" type="float">
|
<ParamField path="STRIX_LLM_MAX_RETRIES" default="5" type="integer">
|
||||||
Delay in seconds between LLM requests for rate limiting.
|
Maximum number of retries for LLM API calls on transient failures.
|
||||||
</ParamField>
|
|
||||||
|
|
||||||
<ParamField path="LLM_RATE_LIMIT_CONCURRENT" type="integer">
|
|
||||||
Maximum concurrent LLM requests.
|
|
||||||
</ParamField>
|
</ParamField>
|
||||||
|
|
||||||
<ParamField path="STRIX_REASONING_EFFORT" default="high" type="string">
|
<ParamField path="STRIX_REASONING_EFFORT" default="high" type="string">
|
||||||
Control thinking effort for reasoning models. Valid values: `none`, `minimal`, `low`, `medium`, `high`, `xhigh`. Defaults to `medium` for quick scan mode.
|
Control thinking effort for reasoning models. Valid values: `none`, `minimal`, `low`, `medium`, `high`, `xhigh`. Defaults to `medium` for quick scan mode.
|
||||||
</ParamField>
|
</ParamField>
|
||||||
|
|
||||||
|
<ParamField path="STRIX_MEMORY_COMPRESSOR_TIMEOUT" default="30" type="integer">
|
||||||
|
Timeout in seconds for memory compression operations (context summarization).
|
||||||
|
</ParamField>
|
||||||
|
|
||||||
## Optional Features
|
## Optional Features
|
||||||
|
|
||||||
<ParamField path="PERPLEXITY_API_KEY" type="string">
|
<ParamField path="PERPLEXITY_API_KEY" type="string">
|
||||||
API key for Perplexity AI. Enables real-time web search during scans for OSINT and vulnerability research.
|
API key for Perplexity AI. Enables real-time web search during scans for OSINT and vulnerability research.
|
||||||
</ParamField>
|
</ParamField>
|
||||||
|
|
||||||
|
<ParamField path="STRIX_DISABLE_BROWSER" default="false" type="boolean">
|
||||||
|
Disable browser automation tools.
|
||||||
|
</ParamField>
|
||||||
|
|
||||||
|
<ParamField path="STRIX_TELEMETRY" default="1" type="string">
|
||||||
|
Enable/disable anonymous telemetry. Set to `0`, `false`, `no`, or `off` to disable.
|
||||||
|
</ParamField>
|
||||||
|
|
||||||
## Docker Configuration
|
## Docker Configuration
|
||||||
|
|
||||||
<ParamField path="STRIX_IMAGE" default="ghcr.io/usestrix/strix-sandbox:0.1.10" type="string">
|
<ParamField path="STRIX_IMAGE" default="ghcr.io/usestrix/strix-sandbox:0.1.11" type="string">
|
||||||
Docker image to use for the sandbox container.
|
Docker image to use for the sandbox container.
|
||||||
</ParamField>
|
</ParamField>
|
||||||
|
|
||||||
@@ -57,17 +65,33 @@ Configure Strix using environment variables.
|
|||||||
|
|
||||||
## Sandbox Configuration
|
## Sandbox Configuration
|
||||||
|
|
||||||
<ParamField path="STRIX_SANDBOX_EXECUTION_TIMEOUT" default="500" type="float">
|
<ParamField path="STRIX_SANDBOX_EXECUTION_TIMEOUT" default="120" type="integer">
|
||||||
Maximum execution time in seconds for sandbox operations.
|
Maximum execution time in seconds for sandbox operations.
|
||||||
</ParamField>
|
</ParamField>
|
||||||
|
|
||||||
<ParamField path="STRIX_SANDBOX_CONNECT_TIMEOUT" default="10" type="float">
|
<ParamField path="STRIX_SANDBOX_CONNECT_TIMEOUT" default="10" type="integer">
|
||||||
Timeout in seconds for connecting to the sandbox container.
|
Timeout in seconds for connecting to the sandbox container.
|
||||||
</ParamField>
|
</ParamField>
|
||||||
|
|
||||||
<ParamField path="STRIX_DISABLE_BROWSER" default="false" type="boolean">
|
## Config File
|
||||||
Disable browser tool.
|
|
||||||
</ParamField>
|
Strix stores configuration in `~/.strix/cli-config.json`. You can also specify a custom config file:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
strix --target ./app --config /path/to/config.json
|
||||||
|
```
|
||||||
|
|
||||||
|
**Config file format:**
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"env": {
|
||||||
|
"STRIX_LLM": "openai/gpt-5",
|
||||||
|
"LLM_API_KEY": "sk-...",
|
||||||
|
"STRIX_REASONING_EFFORT": "high"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
## Example Setup
|
## Example Setup
|
||||||
|
|
||||||
@@ -81,7 +105,7 @@ export PERPLEXITY_API_KEY="pplx-..."
|
|||||||
|
|
||||||
# Optional: Custom timeouts
|
# Optional: Custom timeouts
|
||||||
export LLM_TIMEOUT="600"
|
export LLM_TIMEOUT="600"
|
||||||
export STRIX_SANDBOX_EXECUTION_TIMEOUT="1000"
|
export STRIX_SANDBOX_EXECUTION_TIMEOUT="300"
|
||||||
|
|
||||||
# Optional: Use custom Docker image
|
# Optional: Use custom Docker image
|
||||||
export STRIX_IMAGE="ghcr.io/usestrix/strix-sandbox:latest"
|
export STRIX_IMAGE="ghcr.io/usestrix/strix-sandbox:latest"
|
||||||
|
|||||||
@@ -31,6 +31,10 @@ strix --target <target> [options]
|
|||||||
Run in headless mode without TUI. Ideal for CI/CD.
|
Run in headless mode without TUI. Ideal for CI/CD.
|
||||||
</ParamField>
|
</ParamField>
|
||||||
|
|
||||||
|
<ParamField path="--config" type="string">
|
||||||
|
Path to a custom config file (JSON) to use instead of `~/.strix/cli-config.json`.
|
||||||
|
</ParamField>
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|||||||
Reference in New Issue
Block a user