docs: clarify FreeRide security integration for main branch

This commit is contained in:
stevef 2026-04-19 22:17:34 +02:00
parent 574ca8a8ea
commit 9d9b075ea7
2 changed files with 14 additions and 1 deletions

View file

@ -12,7 +12,7 @@ FreeRide is a dynamic model rotation and failover system for PicoClaw that lever
## Configuration ## Configuration
FreeRide is implemented as a native PicoClaw tool. FreeRide is implemented as a native PicoClaw tool. For production environments (especially in the **main branch**), ensure you follow the [Security Configuration](../security/security_configuration.md) to manage your API keys safely.
### 1. Enable the Tool ### 1. Enable the Tool
Ensure the `skills` tool is enabled in your `config.json` (FreeRide is bundled with the skills system): Ensure the `skills` tool is enabled in your `config.json` (FreeRide is bundled with the skills system):

View file

@ -541,6 +541,19 @@ go test ./pkg/config -run TestSecurityConfig
- Remember: Models, Brave, Tavily, Perplexity MUST use `api_keys` (array format) - Remember: Models, Brave, Tavily, Perplexity MUST use `api_keys` (array format)
- GLMSearch and BaiduSearch MUST use `api_key` (single string format) - GLMSearch and BaiduSearch MUST use `api_key` (single string format)
## FreeRide & Dynamic Failover Security
When using the **FreeRide** dynamic model failover system, PicoClaw dynamically adds models to your `model_list`. To ensure these models stay secure:
1. **Protocol-Level Security**: You can define a single entry in `.security.yml` that matches a specific provider/protocol. For example, to provide an identity for ALL OpenRouter models added by FreeRide:
```yaml
model_list:
openrouter:
api_keys: ["sk-or-v1-your-global-key"]
```
2. **Environment Variable Fallback**: FreeRide is configured to look for `OPENROUTER_API_KEY` in the environment. In production (`main` branch), it is recommended to use K3s Secrets or `SecureString` to inject this.
3. **Sensitive Filtering**: All models added by FreeRide are subject to the same `sensitive_data_filtering.md` rules as your primary models.
### Load Balancing/Failover Issues ### Load Balancing/Failover Issues
- Verify all API keys in the `api_keys` array are valid - Verify all API keys in the `api_keys` array are valid