硬编码 API 密钥和超时适用于原型。生产需要特定于环境的配置、机密管理以及无需重新部署即可更改设置的能力。
配置层次结构
Priority (highest → lowest):
1. Environment variables ← deployment-specific overrides
2. Config file (YAML/JSON) ← version-controlled defaults
3. Application defaults ← fallback values in code
完整的配置参考
| 范围 | 环境变量 | 默认 | 描述 |
|---|---|---|---|
| API密钥 | CAPTCHAAI_API_KEY |
— | 必需的。您的 CaptchaAI API 密钥 |
| 提交网址 | CAPTCHAAI_SUBMIT_URL |
https://ocr.captchaai.com/in.php |
任务提交端点 |
| 投票网址 | CAPTCHAAI_POLL_URL |
https://ocr.captchaai.com/res.php |
结果轮询端点 |
| 轮询间隔 | CAPTCHAAI_POLL_INTERVAL |
5 |
轮询尝试之间的秒数 |
| 最大轮询尝试次数 | CAPTCHAAI_MAX_POLLS |
60 |
超时前的最大轮询尝试次数 |
| 并发性 | CAPTCHAAI_CONCURRENCY |
10 |
最大并行验证码任务数 |
| 暂停 | CAPTCHAAI_TIMEOUT |
300 |
总超时时间(以秒为单位) |
| 代理人 | CAPTCHAAI_PROXY |
— | 用于验证码解决的代理 URL |
| 回调地址 | CAPTCHAAI_CALLBACK_URL |
— | 异步结果的 Webhook URL |
| 重试尝试 | CAPTCHAAI_RETRIES |
3 |
暂时失败时重试 |
| 日志级别 | CAPTCHAAI_LOG_LEVEL |
info |
记录详细程度 |
配置加载器
Python
import os
import yaml
from dataclasses import dataclass, field
from pathlib import Path
@dataclass
class CaptchaAIConfig:
api_key: str = ""
submit_url: str = "https://ocr.captchaai.com/in.php"
poll_url: str = "https://ocr.captchaai.com/res.php"
poll_interval: int = 5
max_polls: int = 60
concurrency: int = 10
timeout: int = 300
proxy: str = ""
callback_url: str = ""
retries: int = 3
log_level: str = "info"
@classmethod
def load(cls, config_path=None):
"""Load config: env vars override file, which overrides defaults."""
config = cls()
# Layer 2: Config file
if config_path and Path(config_path).exists():
with open(config_path) as f:
file_config = yaml.safe_load(f) or {}
for key, value in file_config.items():
if hasattr(config, key):
setattr(config, key, value)
# Layer 1: Environment variables (highest priority)
env_map = {
"CAPTCHAAI_API_KEY": "api_key",
"CAPTCHAAI_SUBMIT_URL": "submit_url",
"CAPTCHAAI_POLL_URL": "poll_url",
"CAPTCHAAI_POLL_INTERVAL": "poll_interval",
"CAPTCHAAI_MAX_POLLS": "max_polls",
"CAPTCHAAI_CONCURRENCY": "concurrency",
"CAPTCHAAI_TIMEOUT": "timeout",
"CAPTCHAAI_PROXY": "proxy",
"CAPTCHAAI_CALLBACK_URL": "callback_url",
"CAPTCHAAI_RETRIES": "retries",
"CAPTCHAAI_LOG_LEVEL": "log_level",
}
for env_key, attr_name in env_map.items():
value = os.environ.get(env_key)
if value is not None:
# Cast to correct type
current = getattr(config, attr_name)
if isinstance(current, int):
value = int(value)
setattr(config, attr_name, value)
config.validate()
return config
def validate(self):
if not self.api_key:
raise ValueError("CAPTCHAAI_API_KEY is required")
if self.poll_interval < 1:
raise ValueError("poll_interval must be >= 1")
if self.concurrency < 1:
raise ValueError("concurrency must be >= 1")
# Usage
config = CaptchaAIConfig.load("config/captchaai.yaml")
print(f"Concurrency: {config.concurrency}, Timeout: {config.timeout}s")
JavaScript
const fs = require("fs");
const yaml = require("js-yaml");
const path = require("path");
class CaptchaAIConfig {
static defaults = {
apiKey: "",
submitUrl: "https://ocr.captchaai.com/in.php",
pollUrl: "https://ocr.captchaai.com/res.php",
pollInterval: 5,
maxPolls: 60,
concurrency: 10,
timeout: 300,
proxy: "",
callbackUrl: "",
retries: 3,
logLevel: "info",
};
static envMap = {
CAPTCHAAI_API_KEY: "apiKey",
CAPTCHAAI_SUBMIT_URL: "submitUrl",
CAPTCHAAI_POLL_URL: "pollUrl",
CAPTCHAAI_POLL_INTERVAL: { key: "pollInterval", type: "int" },
CAPTCHAAI_MAX_POLLS: { key: "maxPolls", type: "int" },
CAPTCHAAI_CONCURRENCY: { key: "concurrency", type: "int" },
CAPTCHAAI_TIMEOUT: { key: "timeout", type: "int" },
CAPTCHAAI_PROXY: "proxy",
CAPTCHAAI_CALLBACK_URL: "callbackUrl",
CAPTCHAAI_RETRIES: { key: "retries", type: "int" },
CAPTCHAAI_LOG_LEVEL: "logLevel",
};
static load(configPath = null) {
let config = { ...CaptchaAIConfig.defaults };
// Layer 2: Config file
if (configPath && fs.existsSync(configPath)) {
const ext = path.extname(configPath);
const raw = fs.readFileSync(configPath, "utf8");
const fileConfig = ext === ".json" ? JSON.parse(raw) : yaml.load(raw);
config = { ...config, ...fileConfig };
}
// Layer 1: Environment variables
for (const [envKey, mapping] of Object.entries(CaptchaAIConfig.envMap)) {
const value = process.env[envKey];
if (value !== undefined) {
const attrKey = typeof mapping === "string" ? mapping : mapping.key;
const type = typeof mapping === "string" ? "string" : mapping.type;
config[attrKey] = type === "int" ? parseInt(value, 10) : value;
}
}
CaptchaAIConfig.validate(config);
return config;
}
static validate(config) {
if (!config.apiKey) throw new Error("CAPTCHAAI_API_KEY is required");
if (config.pollInterval < 1) throw new Error("pollInterval must be >= 1");
if (config.concurrency < 1) throw new Error("concurrency must be >= 1");
}
}
// Usage
const config = CaptchaAIConfig.load("config/captchaai.yaml");
console.log(`Concurrency: ${config.concurrency}, Timeout: ${config.timeout}s`);
每个环境的配置文件
# config/captchaai.yaml — base
api_key: "" # Always set via env var
concurrency: 5
poll_interval: 5
retries: 3
log_level: info
# config/captchaai.production.yaml
concurrency: 20
poll_interval: 3
timeout: 180
log_level: warning
# config/captchaai.staging.yaml
concurrency: 3
poll_interval: 5
timeout: 300
log_level: debug
保密管理
切勿将 API 密钥存储在配置文件或源代码管理中。
| 方法 | 最适合 | 例子 |
|---|---|---|
| 环境变量 | 容器,CI/CD | export CAPTCHAAI_API_KEY=abc123 |
| AWS 秘密管理器 | AWS基础设施 | 启动时获取;自动旋转 |
| HashiCorp 金库 | 多云、本地 | 使用 TTL 的动态机密 |
| Docker 的秘密 | Docker Swarm / 组合 | 安装在 /run/secrets/ |
.env 文件(仅限开发) |
当地发展 | dotenv 库; .gitignore 它 |
Docker 撰写示例
services:
captcha-worker:
image: captcha-worker:latest
environment:
- CAPTCHAAI_API_KEY=${CAPTCHAAI_API_KEY}
- CAPTCHAAI_CONCURRENCY=15
- CAPTCHAAI_LOG_LEVEL=warning
env_file:
- .env.production
功能标志
无需重新部署即可切换功能:
class FeatureFlags:
def __init__(self):
self.flags = {
"use_callback": os.environ.get("FF_USE_CALLBACK", "false") == "true",
"enable_proxy": os.environ.get("FF_ENABLE_PROXY", "true") == "true",
"max_concurrent": int(os.environ.get("FF_MAX_CONCURRENT", "10")),
}
def is_enabled(self, flag):
return self.flags.get(flag, False)
def get(self, flag, default=None):
return self.flags.get(flag, default)
故障排除
| 问题 | 原因 | 处理方式 |
|---|---|---|
| API 密钥未加载 | 缺少环境变量;变量名错误 | 检查echo $CAPTCHAAI_API_KEY;验证拼写 |
| 配置文件被忽略 | 路径错误或缺少 YAML 库 | 验证文件是否存在;安装 pyyaml / js-yaml |
| 使用开发设置进行生产 | 未应用特定于环境的覆盖 | 检查环境变量优先级;验证 NODE_ENV / APP_ENV |
| 日志中可见的秘密 | 配置转储包含 API 密钥 | 屏蔽日志输出中的敏感字段 |
常问问题
我应该使用 YAML 还是 JSON 作为配置文件?
用于人工编辑文件的 YAML(支持注释)。 JSON 用于机器生成的配置或当您需要严格解析时。
我应该多久轮换一次 API 密钥?
如果受到威胁,请立即轮换。每 90 天安排一次轮换以确保合规性。使用支持自动轮换的机密管理器。
我可以在不重新启动的情况下更改并发吗?
是的 - 从每个任务批次的环境变量或配置服务中读取设置,而不仅仅是在启动时。这允许您通过更新环境变量并发送重新加载信号来调整并发性。
相关文章
- Socks5 代理验证码设置配置
- Captchaai Teams 多用户 Api 密钥管理
- 验证码代理配置指南
下一步
让您的配置投入生产 —以 CaptchaAI API 密钥开始并从上面的配置模板构建。
相关指南:
- API 密钥安全和 IP 白名单
- Docker容器化解决方案
- 多区域架构