mirror of
https://github.com/QuantumNous/new-api.git
synced 2026-10-28 16:46:57 +08:00
Calcium-Ion
128089fa7d
* feat(i18n): translate web console messages in the frontend and AI-client errors in the backend
Chinese text was hard-coded in API messages, stored log content, emails and
server logs, so it reached users of every interface language.
Text is now translated where its reader is:
- Web console APIs return the English source text as message_key with
message_params, and the web console translates it in all seven languages.
message keeps the English text for other API callers.
- Errors returned to AI clients, emails and notifications are translated by
the backend (en, zh-CN, zh-TW) in the language saved on the account, then
the language of the request's Accept-Language header.
- A reader who states no language still gets the original Chinese text of the
messages that were Chinese before, word for word. Gateways that use another
new-api as their upstream match that text, for example to disable a channel
whose account ran out of quota.
- Usage, top-up and system log content is stored as content_parts (key and
params) and rendered in the viewer's language. Task fail reasons and refund
reasons written by the gateway are English keys. Rows written earlier are
shown as before.
- Server logs are English.
Also:
- The saved interface language zhTW, and zh-HK, zh-MO and zh-Hant, now select
Traditional Chinese in the backend instead of Simplified Chinese.
- The built-in group descriptions are translated; descriptions an
administrator saved are shown as written.
- .agents/rules/i18n.md records the conventions. Tests in i18n/ fail on a
non-English string literal, on a web console message without translations
and on a locale key without a constant.
* feat(i18n): print server logs in Chinese when LOG_LANGUAGE asks for it
Server log lines are English by default. With LOG_LANGUAGE=zh-CN, the lines
that were Chinese before print their original Chinese text.
common.LogText formats a log line from its English format, which is also the
key of its Chinese text in common/log_text.zh-CN.json. A line without an entry
prints in English. go vet checks the arguments of every call, and
TestServerLogTexts checks that each entry still matches a call and has the
same verbs as its key.
* docs: list LOG_LANGUAGE in the docker compose example
* feat(i18n): translate every server log line and add DEFAULT_LANGUAGE
Every line the gateway prints goes through common.LogText. With
DEFAULT_LANGUAGE=zh-CN, the lines that have a Chinese text in
common/log_text.zh-CN.json print it and the others print English.
DEFAULT_LANGUAGE replaces LOG_LANGUAGE. It also sets the language of
backend messages, emails and notifications for a reader who states no
language: en, zh-CN or zh-TW, English when unset. The list of messages
that stayed Chinese for such readers is removed.
Review fixes:
- Channel test logs store the token name "Model test"; the console shows
it in the interface language.
- Task fail reasons written by the gateway are fixed sentences the console
translates. The HTTP status and the upstream detail go to the server log
when a polled task is failed.
- The auto-disable reason of a slow channel is written in DEFAULT_LANGUAGE.
Also:
- Drop the repository-scanning lint tests, the i18n rules file and its
read gate. AGENTS.md keeps the conventions in four lines.
- Payment error toasts keep their previous text and only add the
translated message key.
- Remove guards and helpers that no caller needs.
* fix(i18n): address review on language lookup, notices and error responses
- Relay requests no longer load the user a second time to find the
language: the settings TokenAuth put into the request are used as they
are, also when they hold no language.
- Upstream model update notices are rendered in each recipient's saved
language, DEFAULT_LANGUAGE when none.
- /api/usage/token and /api/log/token answer with backend-translated
messages again, with the keys and status codes used before this PR.
Their callers are scripts, not the web console.
- Webhook notifications fill {{value}} placeholders like the other
senders. Running the rendered text through Sprintf appended
%!(EXTRA ...) and broke %2F in links.
- RootUserLanguage reads the setting of the root user it already loaded.
- zh_TW and zh_HK are read as Traditional Chinese.
- Add common.ApiErrorStatus for error responses under another HTTP status
and use it where those responses were built by hand.
- Remove middleware.GetLanguage, which had no callers.
131 lines
6.7 KiB
YAML
131 lines
6.7 KiB
YAML
# New-API Docker Compose Configuration
|
||
#
|
||
# Quick Start:
|
||
# 1. docker-compose up -d
|
||
# 2. Access at http://localhost:3000
|
||
#
|
||
# Using MySQL instead of PostgreSQL:
|
||
# 1. Comment out the postgres service and SQL_DSN line 15
|
||
# 2. Uncomment the mysql service and SQL_DSN line 16
|
||
# 3. Uncomment mysql in depends_on (line 28)
|
||
# 4. Uncomment mysql_data in volumes section (line 64)
|
||
#
|
||
# ⚠️ IMPORTANT: Change all default passwords before deploying to production!
|
||
|
||
version: '3.4' # For compatibility with older Docker versions
|
||
|
||
services:
|
||
new-api:
|
||
image: calciumion/new-api:latest
|
||
container_name: new-api
|
||
restart: always
|
||
command: --log-dir /app/logs
|
||
ports:
|
||
- "3000:3000"
|
||
volumes:
|
||
- ./data:/data
|
||
- ./logs:/app/logs
|
||
environment:
|
||
- SQL_DSN=postgresql://root:123456@postgres:5432/new-api # ⚠️ IMPORTANT: Change the password in production!
|
||
# - SQL_DSN=root:123456@tcp(mysql:3306)/new-api # Point to the mysql service, uncomment if using MySQL
|
||
# - LOG_SQL_DSN=postgresql://root:123456@postgres:5432/new-api-log # OPTIONAL: If you want a separate database for logging, uncomment and set this
|
||
# - LOG_SQL_DSN=clickhouse://default:123456@clickhouse:9000/new_api_logs # OPTIONAL: Use ClickHouse for logs only; also uncomment clickhouse in depends_on and the clickhouse service below
|
||
# - LOG_SQL_CLICKHOUSE_TTL_DAYS=0 # OPTIONAL: ClickHouse log retention days. Unset or 0 disables automatic deletion; set to e.g. 30 to keep 30 days
|
||
- REDIS_CONN_STRING=redis://:123456@redis:6379 # ⚠️ IMPORTANT: Change the password in production!
|
||
- TZ=Asia/Shanghai
|
||
- ERROR_LOG_ENABLED=true # 是否启用错误日志记录 (Whether to enable error log recording)
|
||
- BATCH_UPDATE_ENABLED=true # 是否启用批量更新 (Whether to enable batch update)
|
||
- NODE_NAME=new-api-node-1 # 节点名称，用于审计日志中标识节点身份；多节点/容器部署时建议设置 (Node name used in audit logs; recommended when running multiple instances or in containers)
|
||
# - DEFAULT_LANGUAGE=zh-CN # 默认语言：日志输出，以及对方没有指定语言时返回的提示、邮件和通知；可选 en、zh-CN、zh-TW，不设置为 en (Default language of logs and of messages, emails and notifications when the reader states none: en, zh-CN or zh-TW; en if unset)
|
||
# - STREAMING_TIMEOUT=300 # 流模式无响应超时时间，单位秒，默认120秒，如果出现空补全可以尝试改为更大值 （Streaming timeout in seconds, default is 120s. Increase if experiencing empty completions）
|
||
# - RELAY_IDLE_CONN_TIMEOUT=90 # Relay HTTP 客户端空闲连接超时时间，单位秒，默认跟随 Go 标准库，设置为0表示不限制 (Relay HTTP client idle keep-alive timeout in seconds, defaults to Go standard library; set 0 to disable)
|
||
# - SESSION_SECRET=random_string # 多机部署时设置，必须修改这个随机字符串！！ （multi-node deployment, set this to a random string!!!!!!!）
|
||
# - SESSION_COOKIE_SECURE=true # true：启用 Secure Refresh Cookie 和严格 refresh/logout OriginGuard；false/未配置：关闭 OriginGuard，仅用于本地 HTTP (true: Secure cookie + strict refresh/logout OriginGuard; false/unset: guard disabled for local HTTP only)
|
||
# - SESSION_COOKIE_TRUSTED_URL=https://example.com,https://admin.example.com # Secure=true 时必填的精确 HTTPS Origin；不是 relay CORS 白名单，不支持通配符/路径 (Required exact HTTPS origins when Secure=true; not a relay CORS allowlist, no wildcard/path)
|
||
# - TRUSTED_PROXIES=172.20.0.0/16 # 未配置时信任回环/RFC1918/fc00::/7 并告警，none 为严格模式，显式列表替代默认值 (Unset trusts loopback/RFC 1918/fc00::/7 with a warning; none trusts no proxies; an explicit list replaces defaults)
|
||
# - USER_SESSION_ACTIVE_LIMIT=50
|
||
# - USER_SESSION_ISSUANCE_LIMIT=100
|
||
# - USER_SESSION_ISSUANCE_WINDOW_SECONDS=86400 # 不得大于 revoked 保留期 (must not exceed revoked retention)
|
||
# - USER_SESSION_REVOKED_RETENTION_DAYS=7
|
||
# - USER_SESSION_HOURLY_ALERT_THRESHOLD=5000 # 仅告警，不做全局拒绝 (alert only; never globally rejects login)
|
||
# - SYNC_FREQUENCY=60 # Uncomment if regular database syncing is needed
|
||
# - GOOGLE_ANALYTICS_ID=G-XXXXXXXXXX # Google Analytics 的测量 ID (Google Analytics Measurement ID)
|
||
# - UMAMI_WEBSITE_ID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx # Umami 网站 ID (Umami Website ID)
|
||
# - UMAMI_SCRIPT_URL=https://analytics.umami.is/script.js # Umami 脚本 URL，默认为官方地址 (Umami Script URL, defaults to official URL)
|
||
|
||
depends_on:
|
||
- redis
|
||
- postgres
|
||
# - mysql # Uncomment if using MySQL
|
||
# - clickhouse # Uncomment if using ClickHouse for LOG_SQL_DSN
|
||
networks:
|
||
- new-api-network
|
||
healthcheck:
|
||
test: ["CMD-SHELL", "wget -q -O - http://localhost:3000/api/status | grep -o '\"success\":\\s*true' || exit 1"]
|
||
interval: 30s
|
||
timeout: 10s
|
||
retries: 3
|
||
|
||
redis:
|
||
image: redis:latest
|
||
container_name: redis
|
||
restart: always
|
||
command: ["redis-server", "--requirepass", "123456"] # ⚠️ IMPORTANT: Change this password in production!
|
||
networks:
|
||
- new-api-network
|
||
|
||
postgres:
|
||
image: postgres:15
|
||
container_name: postgres
|
||
restart: always
|
||
environment:
|
||
POSTGRES_USER: root
|
||
POSTGRES_PASSWORD: 123456 # ⚠️ IMPORTANT: Change this password in production!
|
||
POSTGRES_DB: new-api
|
||
volumes:
|
||
- pg_data:/var/lib/postgresql/data
|
||
networks:
|
||
- new-api-network
|
||
# ports:
|
||
# - "5432:5432" # Uncomment if you need to access PostgreSQL from outside Docker
|
||
|
||
# mysql:
|
||
# image: mysql:8.2
|
||
# container_name: mysql
|
||
# restart: always
|
||
# environment:
|
||
# MYSQL_ROOT_PASSWORD: 123456 # ⚠️ IMPORTANT: Change this password in production!
|
||
# MYSQL_DATABASE: new-api
|
||
# volumes:
|
||
# - mysql_data:/var/lib/mysql
|
||
# networks:
|
||
# - new-api-network
|
||
# ports:
|
||
# - "3306:3306" # Uncomment if you need to access MySQL from outside Docker
|
||
|
||
# clickhouse:
|
||
# image: clickhouse/clickhouse-server:24.8
|
||
# container_name: clickhouse
|
||
# restart: always
|
||
# environment:
|
||
# CLICKHOUSE_DB: new_api_logs
|
||
# CLICKHOUSE_USER: default
|
||
# CLICKHOUSE_PASSWORD: 123456 # ⚠️ IMPORTANT: Change this password in production!
|
||
# CLICKHOUSE_DEFAULT_ACCESS_MANAGEMENT: 1
|
||
# volumes:
|
||
# - clickhouse_data:/var/lib/clickhouse
|
||
# networks:
|
||
# - new-api-network
|
||
# ports:
|
||
# - "8123:8123" # HTTP interface, uncomment if you need external access
|
||
# - "9000:9000" # Native interface used by the LOG_SQL_DSN example above
|
||
|
||
volumes:
|
||
pg_data:
|
||
# mysql_data:
|
||
# clickhouse_data:
|
||
|
||
networks:
|
||
new-api-network:
|
||
driver: bridge
|