docs: 为 docker-compose.prod.env.example 添加中英文注释

- 为所有配置项添加中英文对照注释
- 添加使用说明的中英文版本
- 为安全配置项添加详细说明和生成方式提示
This commit is contained in:
WrBug
2025-12-07 19:11:43 +08:00
parent 0a11cff0a2
commit ac4e1dde2b
+30 -9
View File
@@ -1,45 +1,66 @@
# PolyHermes 生产环境配置文件示例
# PolyHermes Production Environment Configuration File Example
#
# 使用方法
# 使用方法 / Usage:
# 1. 复制此文件为 .env: cp docker-compose.prod.env.example .env
# Copy this file to .env: cp docker-compose.prod.env.example .env
# 2. 修改以下配置项(特别是安全相关的密钥)
# Modify the following configuration items (especially security-related keys)
# 3. 运行: docker-compose -f docker-compose.prod.yml up -d
# Run: docker-compose -f docker-compose.prod.yml up -d
# ============================================
# 数据库配置
# 数据库配置 / Database Configuration
# ============================================
# 数据库连接 URL / Database connection URL
DB_URL=jdbc:mysql://mysql:3306/polyhermes?useSSL=false&serverTimezone=UTC&characterEncoding=utf8&allowPublicKeyRetrieval=true
# 数据库用户名 / Database username
DB_USERNAME=root
# 数据库密码 / Database password
DB_PASSWORD=your_database_password_here
# ============================================
# Spring Profile
# ============================================
# Spring 环境配置(dev/prod/ Spring environment configuration (dev/prod)
SPRING_PROFILES_ACTIVE=prod
# ============================================
# 服务器端口(对外暴露的端口)
# 服务器端口 / Server Port
# ============================================
# 对外暴露的端口(默认 80/ External port (default 80)
SERVER_PORT=80
# ============================================
# MySQL 端口(可选,用于外部连接,默认 3307 避免与本地 MySQL 冲突)
# MySQL 端口 / MySQL Port
# ============================================
# 可选,用于外部连接,默认 3307 避免与本地 MySQL 冲突
# Optional, for external connections, default 3307 to avoid conflicts with local MySQL
MYSQL_PORT=3307
# ============================================
# Polygon RPC
# ============================================
# Polygon 网络 RPC 地址 / Polygon network RPC address
POLYGON_RPC_URL=https://polygon-rpc.com
# ============================================
# 安全配置(⚠️ 必须修改,不能使用默认值)
# 安全配置 / Security Configuration
# ============================================
# ⚠️ 必须修改,不能使用默认值 / ⚠️ Must be modified, cannot use default values
#
# JWT 密钥,用于生成和验证 JWT Token
# JWT secret key, used for generating and validating JWT tokens
# 生成方式 / Generate: openssl rand -hex 64
JWT_SECRET=change-me-in-production
#
# 管理员密码重置密钥
# Admin password reset key
# 生成方式 / Generate: openssl rand -hex 32
ADMIN_RESET_PASSWORD_KEY=change-me-in-production
# ============================================
# 加密密钥(用于加密存储私钥和 API Key
# ============================================
#
# 加密密钥,用于加密存储私钥和 API Key
# Encryption key, used for encrypting stored private keys and API keys
# 生成方式 / Generate: openssl rand -hex 32
CRYPTO_SECRET_KEY=change-me-in-production