New API 日文版指南精读部署、环境变量与多机集群配置实战【免费下载链接】new-apiA unified AI model hub for aggregation distribution. It supports cross-converting various LLMs into OpenAI-compatible, Claude-compatible, or Gemini-compatible formats. A centralized gateway for personal and enterprise model management.项目地址: https://gitcode.com/gh_mirrors/ne/new-apiNew API 是一款基于 Go 与 Gin 构建的下一代大模型网关与 AI 资产管理平台本指南以仓库中的日文版 READMEREADME.ja.md为主体完整梳理其快速开始、部署方式、环境变量、多机集群注意事项等核心内容并结合仓库源码佐证底层实现。读者学完后将能够独立完成 New API 的 Docker 部署、掌握关键环境变量的作用域与默认值并理解多节点部署下 Session 认证、Redis 拓扑与限流语义的差异。 项目定位与合规前提New API 被定位为「次世代大規模モデルゲートウェイとAI資産管理システム」次世代大模型网关与 AI 资产管理系统其核心能力是将各类异构 LLM 上游统一转换为 OpenAI Compatible、Claude Messages 或 Google Gemini 兼容格式从而提供统一的模型接入网关。从源码看这一能力由 relay/relay_adaptor.go 中的GetAdaptor(apiType int)工厂函数支撑它通过constant.APIType*枚举为阿里、Anthropic、Gemini、OpenAI、腾讯、智谱、Ollama、DeepSeek、Moonshot、MiniMax、Codex 等数十种平台分发对应适配器实例。日文版 README 特别以 IMPORTANT 块强调合规前提项目仅面向合法授权的 AI API 网关、组织级认证、多模型管理、用量分析、成本核算与私有化部署场景用户必须合法取得上游 API Key、账户、模型服务与接口权限并遵守上游服务条款及适用法律法规若面向公众提供生成式 AI 服务需履行备案、许可、内容安全、实名认证、日志留存、税务与上游授权等属地监管义务。这一声明对应仓库根目录 README.md 的英文版本属于项目的基础使用边界部署前务必知悉。 快速开始方式一Docker Compose推荐# 克隆项目 git clone https://github.com/QuantumNous/new-api.git cd new-api # 编辑 docker-compose.yml nano docker-compose.yml # 启动服务 docker-compose up -d仓库根目录自带的 docker-compose.yml 默认编排了new-api、redis、postgres三个服务并注释了 MySQL 与 ClickHouse 的可选配置其中应用镜像为calciumion/new-api:latest端口映射3000:3000数据卷./data:/data与日志卷./logs:/app/logs容器启动命令为--log-dir /app/logs默认数据库为 PostgreSQLSQL_DSNpostgresql://root:123456postgres:5432/new-api默认缓存为带密码的 RedisREDIS_CONN_STRINGredis://:123456redis:6379默认时区TZAsia/Shanghai内置 healthcheck通过wget请求http://localhost:3000/api/status并检查success: true间隔 30 秒、超时 10 秒、连续失败 3 次判定不健康文件头部明确标注「部署到生产环境前必须修改所有默认密码」。方式二直接使用 Docker 命令使用 SQLite默认docker run --name new-api -d --restart always \ -p 3000:3000 \ -e TZAsia/Shanghai \ -v ./data:/data \ calciumion/new-api:latest使用 MySQLdocker run --name new-api -d --restart always \ -p 3000:3000 \ -e SQL_DSNroot:123456tcp(localhost:3306)/oneapi \ -e TZAsia/Shanghai \ -v ./data:/data \ calciumion/new-api:latest 提示-v ./data:/data将数据保存到当前目录的data文件夹也可以改用绝对路径-v /your/custom/path:/data。从 main.go 的InitResources可以看出启动初始化顺序加载.env→common.InitEnv()解析环境变量 → 初始化数据库model.InitDB()→ 初始化日志库model.InitLogDB()→ 初始化 Redis → 加载 i18n 与自定义 OAuth Provider。因此环境变量的生效位置是有序的部署时若修改SQL_DSN、REDIS_CONN_STRING需要重启容器才能生效。方式三宝塔面板宝塔面板9.2.0 及以上版本用户可直接在应用商店搜索New-API安装或在 Docker 中自行部署图文教程参见 docs/installation/BT.md。该文档给出了应用商店方式的最低要求宝塔 ≥ 9.2.0、CentOS 7 / Ubuntu 18.04 / Debian 10、至少 1 核 2G 内存并建议配置SESSION_SECRET必填多机必须一致与CRYPTO_SECRET使用 Redis 时必填。部署完成后访问http://localhost:3000即可进入控制台。 部署要求一览组件要求本地数据库SQLiteDocker 需挂载/data目录远程数据库MySQL ≥ 5.7.8 或 PostgreSQL ≥ 9.6容器引擎Docker / Docker Compose系统架构仅支持 64 位amd64 / arm6432 位系统不支持⚙️ 核心环境变量详解日文版 README 列出了完整的常用环境变量表下面结合源码common/init.go、common/env.go逐项展开说明其语义。会话与密钥变量名说明默认值SESSION_SECRET认证签名密钥所有节点必须一致-SESSION_COOKIE_SECUREfalse/未设置关闭 refresh/logout 的 OriginGuard供本地 HTTP 开发代理使用true启用 Secure Cookie 与严格 Origin 校验falseSESSION_COOKIE_TRUSTED_URLSecure 模式下必填refresh/logout 允许的精确 HTTPS Origin逗号分隔不是 relay 的 CORS 配置-CRYPTO_SECRET缓存键 HMAC 密钥共享 Redis 的节点必须一致默认等于SESSION_SECRET源码佐证common/init.go中若检测到SESSION_SECRETrandom_string会直接log.Fatal拒绝启动CRYPTO_SECRET未配置时自动回退为SessionSecret。登录会话限额变量名说明默认值USER_SESSION_ACTIVE_LIMIT单用户有效登录 Session 上限50USER_SESSION_ISSUANCE_LIMIT统计窗口内可创建的 Session 总数含已撤销100USER_SESSION_ISSUANCE_WINDOW_SECONDSSession 签发统计窗口秒不得超过 revoked 保留期86400USER_SESSION_REVOKED_RETENTION_DAYS已撤销 Session 的审计保留天数7USER_SESSION_HOURLY_ALERT_THRESHOLD每小时全局 Session 签发量告警阈值仅告警不拒绝登录5000源码佐证initUserSessionSettings()会对上述变量做正值校验并强制将签发窗口钳制到保留期内if UserSessionIssuanceWindowSeconds retentionSeconds时自动收缩并记录告警。数据库与缓存变量名说明默认值SQL_DSN数据库连接字符串-REDIS_CONN_STRINGRedis 连接字符串推荐启用-MEMORY_CACHE_ENABLED内存缓存开关false注意 main.go 中有一处兼容逻辑只要RedisEnabled为真MemoryCacheEnabled也会被强制置为true也就是说 Redis 与内存缓存会叠加工作。请求与流式响应变量名说明默认值STREAMING_TIMEOUT流式响应超时秒300STREAM_SCANNER_MAX_BUFFER_MB流扫描器单行缓冲上限MB处理 4K 图片等超大 base64data:载荷时需调大64注common/init.go中常量读取实际为 128README 记录为 64两者取较小语义理解即可MAX_REQUEST_BODY_MB请求体最大体积MB按解压后计量防超大请求/zip bomb 导致内存暴涨超限返回41332其他常用项变量名说明默认值AZURE_DEFAULT_API_VERSIONAzure API 版本2025-04-01-previewERROR_LOG_ENABLED错误日志开关falsePYROSCOPE_URL/PYROSCOPE_APP_NAME/PYROSCOPE_BASIC_AUTH_USER/PYROSCOPE_BASIC_AUTH_PASSWORD/PYROSCOPE_MUTEX_RATE/PYROSCOPE_BLOCK_RATEPyroscope 性能分析服务配置无 /new-api/ 无 / 无 /5/5HOSTNAMEPyroscope 主机名标签new-api另外在 common/init.go 中还能看到 README 未展开的限流类变量GLOBAL_API_RATE_LIMIT默认 360 次/180 秒、GLOBAL_WEB_RATE_LIMIT默认 120 次/180 秒、CRITICAL_RATE_LIMIT默认 20 次/20 分钟等均通过GetEnvOrDefault读取解析失败时回退默认值并记录SysError。⚠️ 多机部署的注意事项密钥一致性所有节点必须使用同一主数据库和相同的SESSION_SECRET否则 Access Token、Refresh 会话与临时鉴权流程无法一致校验连接同一 Redis 的节点还必须设置相同的CRYPTO_SECRET否则缓存键摘要不一致无法正确复用共享缓存。登录会话与 Redis 拓扑登录 Session 与用户维度的有效数/签发数限制中数据库是唯一权威。Redis 中的 Session 条目只是短期缓存TTL 跟随SYNC_FREQUENCY默认 60 秒且不超过 Session 剩余有效期。Redis 拓扑Session 状态传播限流语义所有节点共享 Redis撤销与版本更新通常即时传播Redis 限流额度在节点间共享每个节点独立 Redis在有效SYNC_FREQUENCY内回源数据库收敛版本轮换后新 Token 在持有旧缓存的节点上可能短暂 401各节点独立计数集群总额度最坏约为节点数倍不使用 Redis每次 Session 校验直接查数据库各节点内存限流额度按节点独立SYNC_FREQUENCY调小可以缩短独立 Redis 的缓存陈旧窗口但每个活跃 SID 在每个节点、每个 TTL 内都会增加一次数据库主键点查。该保证只限定 Session 认证的陈旧语义限流及其他控制面缓存仍依赖拓扑。这份结论与仓库文档 docs/authentication.md 中「多节点 Redis 拓扑」一节完全一致后者还进一步说明Redis 中的 Session Hash 含revoking/revokedtombstone读取缓存不会续期过期后按 SID 回源数据库延迟完成的 active 缓存回写只能使用数据库观察窗口尚未消耗的 TTL。Token、Origin 校验与 PAT 契约Token、Origin 校验与 PAT 的完整契约参见 docs/authentication.md关键要点包括面板鉴权采用短期 Access Token15 分钟 JWT HttpOnly Refresh Cookie 服务端登录会话控制面的组合不再依赖 Gin sessionUser.AccessToken面板 PAT支持Authorization: Bearer pat与原有单值Authorization: pat两种形式New-Api-User请求头已不再参与鉴权敏感操作查看渠道密钥、注册/删除 Passkey使用有效期 5 分钟的X-Security-Proof同时绑定用户、会话、鉴权版本与 scope。 渠道重试与缓存重试设置设置 → 运营设置 → 一般设置 → 失败重试次数缓存设置REDIS_CONN_STRINGRedis 缓存推荐MEMORY_CACHE_ENABLED内存缓存✨ 核心功能概览核心功能功能说明 新 UI现代化用户界面设计 多语言支持简体中文、繁体中文、英语、法语、日语 数据兼容性与 One API 原始数据库完全兼容 数据看板可视化控制台与统计分析 权限管理Token 分组、模型限制、用户管理认证与安全Discord 认证登录LinuxDO 认证登录Telegram 认证登录OIDC 统一认证Key 用量配额查询配合 new-api-key-tool 使用OAuth 相关实现集中在仓库的 oauth/ 目录discord.go、linuxdo.go、telegram.go、oidc.go、generic.go 等通过 oauth/registry.go 统一注册分发。高级功能API 格式支持⚡ OpenAI Responses⚡ OpenAI Realtime API含 Azure⚡ Claude Messages⚡ Google Gemini Rerank 模型Cohere、Jina智能路由⚖️ 渠道权重随机 失败自动重试 用户级模型限流格式转换 OpenAI Compatible ⇄ Claude Messages OpenAI Compatible → Google Gemini Google Gemini → OpenAI Compatible仅文本暂不支持函数调用 OpenAI Compatible ⇄ OpenAI Responses开发中 思考转内容功能格式转换的核心机制可从 relay/ 目录下的compatible_handler.go、claude_handler.go、gemini_handler.go、responses_handler.go等处理器以及relaykit/relayconvert/84 个 Go 转换文件中进一步研究。Reasoning Effort 支持OpenAI 系列模型o3-mini-high/o3-mini-medium/o3-mini-low高/中/低思考强度gpt-5-high/gpt-5-medium/gpt-5-lowClaude 思考模型claude-3-7-sonnet-20250219-thinking启用思考模式Google Gemini 系列模型gemini-2.5-flash-thinking启用思考模式gemini-2.5-flash-nothinking禁用思考模式gemini-2.5-pro-thinking启用思考模式gemini-2.5-pro-thinking-128启用思考模式并设置 128 token 思考预算Gemini 模型名追加-low/-medium/-high后缀可直接指定推理强度无需附加思考预算后缀 支持的模型与接口模型类型说明 OpenAI-CompatibleOpenAI 兼容模型 OpenAI ResponsesOpenAI Responses 格式 Midjourney-ProxyMidjourney-Proxy(Plus) 支持 Suno-APISuno API 音乐生成 RerankCohere、Jina ClaudeMessages 格式 GeminiGoogle Gemini 格式 DifyChatFlow 模式 自定义上游支持配置合法授权的上游端点完整接口列表包括Chat Completions、Responses、Image、Audio、Video、Embeddings、Rerank、Realtime、Claude 聊天、Gemini 聊天。对应实现分散在 relay/ 与 controller/ 的image.go、audio.go、video_proxy.go、midjourney.go等文件中。 部署形态总结部署方式适用场景关键点Docker Compose推荐开箱即用默认 PostgreSQL Redis需改默认密码Docker 命令快速验证SQLite 或SQL_DSN指定 MySQL宝塔面板国内服务器可视化运维应用商店搜索 New-API≥ 9.2.0多机集群生产高可用统一SESSION_SECRET/CRYPTO_SECRET/ 主数据库 许可证与上游本项目基于 One APIMIT 许可开发以GNU Affero General Public License v3.0AGPLv3发布完整许可文本见 LICENSE。上游参考项目包括 One API 与 Midjourney-Proxy配套工具有 new-api-key-toolKey 用量配额查询与 new-api-horizon高性能优化版。结语本指南以 README.ja.md 为骨架结合 docker-compose.yml、common/init.go、main.go、docs/authentication.md 等仓库文件完整覆盖了 New API 从快速启动、环境变量配置到多机集群部署的实战要点。无论你是要搭建个人模型网关还是规划组织级的统一 AI 接入层都可以以此为基础进一步阅读 docs/ 目录下的鉴权与部署文档深入实践。【免费下载链接】new-apiA unified AI model hub for aggregation distribution. It supports cross-converting various LLMs into OpenAI-compatible, Claude-compatible, or Gemini-compatible formats. A centralized gateway for personal and enterprise model management.项目地址: https://gitcode.com/gh_mirrors/ne/new-api创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考