mirror of
https://github.com/router-for-me/CLIProxyAPI.git
synced 2026-02-03 13:00:52 +08:00
3e4858a624
This commit introduces a new configuration option `logs-max-total-size-mb` that allows users to set a maximum total size (in MB) for log files in the logs directory. When this limit is exceeded, the oldest log files will be automatically deleted to stay within the specified size. Setting this value to 0 (the default) disables this feature. This change enhances log management by preventing excessive disk space usage.
206 lines
9.1 KiB
YAML
206 lines
9.1 KiB
YAML
# Server host/interface to bind to. Default is empty ("") to bind all interfaces (IPv4 + IPv6).
|
|
# Use "127.0.0.1" or "localhost" to restrict access to local machine only.
|
|
host: ""
|
|
|
|
# Server port
|
|
port: 8317
|
|
|
|
# TLS settings for HTTPS. When enabled, the server listens with the provided certificate and key.
|
|
tls:
|
|
enable: false
|
|
cert: ""
|
|
key: ""
|
|
|
|
# Management API settings
|
|
remote-management:
|
|
# Whether to allow remote (non-localhost) management access.
|
|
# When false, only localhost can access management endpoints (a key is still required).
|
|
allow-remote: false
|
|
|
|
# Management key. If a plaintext value is provided here, it will be hashed on startup.
|
|
# All management requests (even from localhost) require this key.
|
|
# Leave empty to disable the Management API entirely (404 for all /v0/management routes).
|
|
secret-key: ""
|
|
|
|
# Disable the bundled management control panel asset download and HTTP route when true.
|
|
disable-control-panel: false
|
|
|
|
# GitHub repository for the management control panel. Accepts a repository URL or releases API URL.
|
|
panel-github-repository: "https://github.com/router-for-me/Cli-Proxy-API-Management-Center"
|
|
|
|
# Authentication directory (supports ~ for home directory)
|
|
auth-dir: "~/.cli-proxy-api"
|
|
|
|
# API keys for authentication
|
|
api-keys:
|
|
- "your-api-key-1"
|
|
- "your-api-key-2"
|
|
|
|
# Enable debug logging
|
|
debug: false
|
|
|
|
# When true, write application logs to rotating files instead of stdout
|
|
logging-to-file: false
|
|
|
|
# Maximum total size (MB) of log files under the logs directory. When exceeded, the oldest log
|
|
# files are deleted until within the limit. Set to 0 to disable.
|
|
logs-max-total-size-mb: 0
|
|
|
|
# When false, disable in-memory usage statistics aggregation
|
|
usage-statistics-enabled: false
|
|
|
|
# Proxy URL. Supports socks5/http/https protocols. Example: socks5://user:pass@192.168.1.1:1080/
|
|
proxy-url: ""
|
|
|
|
# When true, unprefixed model requests only use credentials without a prefix (except when prefix == model name).
|
|
force-model-prefix: false
|
|
|
|
# Number of times to retry a request. Retries will occur if the HTTP response code is 403, 408, 500, 502, 503, or 504.
|
|
request-retry: 3
|
|
|
|
# Maximum wait time in seconds for a cooled-down credential before triggering a retry.
|
|
max-retry-interval: 30
|
|
|
|
# Quota exceeded behavior
|
|
quota-exceeded:
|
|
switch-project: true # Whether to automatically switch to another project when a quota is exceeded
|
|
switch-preview-model: true # Whether to automatically switch to a preview model when a quota is exceeded
|
|
|
|
# When true, enable authentication for the WebSocket API (/v1/ws).
|
|
ws-auth: false
|
|
|
|
# Gemini API keys
|
|
# gemini-api-key:
|
|
# - api-key: "AIzaSy...01"
|
|
# prefix: "test" # optional: require calls like "test/gemini-3-pro-preview" to target this credential
|
|
# base-url: "https://generativelanguage.googleapis.com"
|
|
# headers:
|
|
# X-Custom-Header: "custom-value"
|
|
# proxy-url: "socks5://proxy.example.com:1080"
|
|
# excluded-models:
|
|
# - "gemini-2.5-pro" # exclude specific models from this provider (exact match)
|
|
# - "gemini-2.5-*" # wildcard matching prefix (e.g. gemini-2.5-flash, gemini-2.5-pro)
|
|
# - "*-preview" # wildcard matching suffix (e.g. gemini-3-pro-preview)
|
|
# - "*flash*" # wildcard matching substring (e.g. gemini-2.5-flash-lite)
|
|
# - api-key: "AIzaSy...02"
|
|
|
|
# Codex API keys
|
|
# codex-api-key:
|
|
# - api-key: "sk-atSM..."
|
|
# prefix: "test" # optional: require calls like "test/gpt-5-codex" to target this credential
|
|
# base-url: "https://www.example.com" # use the custom codex API endpoint
|
|
# headers:
|
|
# X-Custom-Header: "custom-value"
|
|
# proxy-url: "socks5://proxy.example.com:1080" # optional: per-key proxy override
|
|
# excluded-models:
|
|
# - "gpt-5.1" # exclude specific models (exact match)
|
|
# - "gpt-5-*" # wildcard matching prefix (e.g. gpt-5-medium, gpt-5-codex)
|
|
# - "*-mini" # wildcard matching suffix (e.g. gpt-5-codex-mini)
|
|
# - "*codex*" # wildcard matching substring (e.g. gpt-5-codex-low)
|
|
|
|
# Claude API keys
|
|
# claude-api-key:
|
|
# - api-key: "sk-atSM..." # use the official claude API key, no need to set the base url
|
|
# - api-key: "sk-atSM..."
|
|
# prefix: "test" # optional: require calls like "test/claude-sonnet-latest" to target this credential
|
|
# base-url: "https://www.example.com" # use the custom claude API endpoint
|
|
# headers:
|
|
# X-Custom-Header: "custom-value"
|
|
# proxy-url: "socks5://proxy.example.com:1080" # optional: per-key proxy override
|
|
# models:
|
|
# - name: "claude-3-5-sonnet-20241022" # upstream model name
|
|
# alias: "claude-sonnet-latest" # client alias mapped to the upstream model
|
|
# excluded-models:
|
|
# - "claude-opus-4-5-20251101" # exclude specific models (exact match)
|
|
# - "claude-3-*" # wildcard matching prefix (e.g. claude-3-7-sonnet-20250219)
|
|
# - "*-thinking" # wildcard matching suffix (e.g. claude-opus-4-5-thinking)
|
|
# - "*haiku*" # wildcard matching substring (e.g. claude-3-5-haiku-20241022)
|
|
|
|
# OpenAI compatibility providers
|
|
# openai-compatibility:
|
|
# - name: "openrouter" # The name of the provider; it will be used in the user agent and other places.
|
|
# prefix: "test" # optional: require calls like "test/kimi-k2" to target this provider's credentials
|
|
# base-url: "https://openrouter.ai/api/v1" # The base URL of the provider.
|
|
# headers:
|
|
# X-Custom-Header: "custom-value"
|
|
# api-key-entries:
|
|
# - api-key: "sk-or-v1-...b780"
|
|
# proxy-url: "socks5://proxy.example.com:1080" # optional: per-key proxy override
|
|
# - api-key: "sk-or-v1-...b781" # without proxy-url
|
|
# models: # The models supported by the provider.
|
|
# - name: "moonshotai/kimi-k2:free" # The actual model name.
|
|
# alias: "kimi-k2" # The alias used in the API.
|
|
|
|
# Vertex API keys (Vertex-compatible endpoints, use API key + base URL)
|
|
# vertex-api-key:
|
|
# - api-key: "vk-123..." # x-goog-api-key header
|
|
# prefix: "test" # optional: require calls like "test/vertex-pro" to target this credential
|
|
# base-url: "https://example.com/api" # e.g. https://zenmux.ai/api
|
|
# proxy-url: "socks5://proxy.example.com:1080" # optional per-key proxy override
|
|
# headers:
|
|
# X-Custom-Header: "custom-value"
|
|
# models: # optional: map aliases to upstream model names
|
|
# - name: "gemini-2.0-flash" # upstream model name
|
|
# alias: "vertex-flash" # client-visible alias
|
|
# - name: "gemini-1.5-pro"
|
|
# alias: "vertex-pro"
|
|
|
|
# Amp Integration
|
|
# ampcode:
|
|
# # Configure upstream URL for Amp CLI OAuth and management features
|
|
# upstream-url: "https://ampcode.com"
|
|
# # Optional: Override API key for Amp upstream (otherwise uses env or file)
|
|
# upstream-api-key: ""
|
|
# # Restrict Amp management routes (/api/auth, /api/user, etc.) to localhost only (default: false)
|
|
# restrict-management-to-localhost: false
|
|
# # Force model mappings to run before checking local API keys (default: false)
|
|
# force-model-mappings: false
|
|
# # Amp Model Mappings
|
|
# # Route unavailable Amp models to alternative models available in your local proxy.
|
|
# # Useful when Amp CLI requests models you don't have access to (e.g., Claude Opus 4.5)
|
|
# # but you have a similar model available (e.g., Claude Sonnet 4).
|
|
# model-mappings:
|
|
# - from: "claude-opus-4.5" # Model requested by Amp CLI
|
|
# to: "claude-sonnet-4" # Route to this available model instead
|
|
# - from: "gpt-5"
|
|
# to: "gemini-2.5-pro"
|
|
# - from: "claude-3-opus-20240229"
|
|
# to: "claude-3-5-sonnet-20241022"
|
|
|
|
# OAuth provider excluded models
|
|
# oauth-excluded-models:
|
|
# gemini-cli:
|
|
# - "gemini-2.5-pro" # exclude specific models (exact match)
|
|
# - "gemini-2.5-*" # wildcard matching prefix (e.g. gemini-2.5-flash, gemini-2.5-pro)
|
|
# - "*-preview" # wildcard matching suffix (e.g. gemini-3-pro-preview)
|
|
# - "*flash*" # wildcard matching substring (e.g. gemini-2.5-flash-lite)
|
|
# vertex:
|
|
# - "gemini-3-pro-preview"
|
|
# aistudio:
|
|
# - "gemini-3-pro-preview"
|
|
# antigravity:
|
|
# - "gemini-3-pro-preview"
|
|
# claude:
|
|
# - "claude-3-5-haiku-20241022"
|
|
# codex:
|
|
# - "gpt-5-codex-mini"
|
|
# qwen:
|
|
# - "vision-model"
|
|
# iflow:
|
|
# - "tstars2.0"
|
|
|
|
# Optional payload configuration
|
|
# payload:
|
|
# default: # Default rules only set parameters when they are missing in the payload.
|
|
# - models:
|
|
# - name: "gemini-2.5-pro" # Supports wildcards (e.g., "gemini-*")
|
|
# protocol: "gemini" # restricts the rule to a specific protocol, options: openai, gemini, claude, codex
|
|
# params: # JSON path (gjson/sjson syntax) -> value
|
|
# "generationConfig.thinkingConfig.thinkingBudget": 32768
|
|
# override: # Override rules always set parameters, overwriting any existing values.
|
|
# - models:
|
|
# - name: "gpt-*" # Supports wildcards (e.g., "gpt-*")
|
|
# protocol: "codex" # restricts the rule to a specific protocol, options: openai, gemini, claude, codex
|
|
# params: # JSON path (gjson/sjson syntax) -> value
|
|
# "reasoning.effort": "high"
|