Files
ClassHelper/deploy/docker-compose.yml
T
LoveChengke 70250151d0 feat(deploy,docs): Linux 原生部署(systemd 一键脚本 + unit 模板)+ 生产文档扩写
- deploy/install-linux.sh:Linux 一键部署(Node 版本检查 → 铺 /opt/classhelper → 生成 .env 与随机
  JWT_SECRET → 安装 systemd 服务 → 就绪探针;支持 --check/--port/--dir/--no-service/--uninstall)
- deploy/classhelper.service:systemd 单元模板(__NODE__/__DIR__/__USER__ 由脚本替换后安装)
- deploy/{.env.example,docker-compose.yml}:补充 DEFAULT_STUDENT/CLASS/TEACHER_PASSWORD 默认密码环境变量
- docs/production.md:新增形态 C(Linux systemd + SQLite)、Nginx + HTTPS、升级/备份/排障、探针与安全清单
- README.md:生产部署四形态对照表、目录树与验证表更新
2026-09-26 19:32:37 +08:00

97 lines
3.4 KiB
YAML

# 班级小助手 · 生产部署(MySQL + 服务端 + 可选 HTTPS 反代)
#
# 使用:
# 1) 复制环境变量模板并填写密钥:cp deploy/.env.example deploy/.env
# 2) 构建并启动:docker compose -f deploy/docker-compose.yml --env-file deploy/.env up -d --build
# 3) 访问:http://<服务器IP>:4000/
#
# 说明:数据库迁移由一次性的 migrate 服务执行(prisma migrate deploy),
# 服务端容器因此无需内置 Prisma CLI。
name: classhelper
services:
# ---------------------------------------------------------------- 数据库
db:
image: mysql:8.4
restart: unless-stopped
command:
- --character-set-server=utf8mb4
- --collation-server=utf8mb4_unicode_ci
- --default-time-zone=+08:00
environment:
MYSQL_ROOT_PASSWORD: ${MYSQL_ROOT_PASSWORD:?请在 deploy/.env 中设置}
MYSQL_DATABASE: ${MYSQL_DATABASE:-classhelper}
MYSQL_USER: ${MYSQL_USER:-classhelper}
MYSQL_PASSWORD: ${MYSQL_PASSWORD:?请在 deploy/.env 中设置}
volumes:
- db-data:/var/lib/mysql
healthcheck:
test: ['CMD', 'mysqladmin', 'ping', '-h', '127.0.0.1', '-p${MYSQL_ROOT_PASSWORD}']
interval: 10s
timeout: 5s
retries: 10
start_period: 40s
networks: [classhelper]
# ---------------------------------------------------------------- 数据库迁移(一次性)
migrate:
build:
context: ..
dockerfile: deploy/Dockerfile
target: build
restart: 'no'
working_dir: /app/packages/server
environment:
DATABASE_PROVIDER: mysql
DATABASE_URL: mysql://${MYSQL_USER:-classhelper}:${MYSQL_PASSWORD}@db:3306/${MYSQL_DATABASE:-classhelper}
# MySQL 需要 mariadb 驱动适配器(切换数据库时按 docs/mysql.md 安装)
NODE_ENV: production
command: >
sh -c "pnpm --filter @classhelper/server add @prisma/adapter-mariadb &&
npx prisma migrate deploy"
depends_on:
db: { condition: service_healthy }
networks: [classhelper]
# ---------------------------------------------------------------- 服务端 + Web 管理端
server:
build:
context: ..
dockerfile: deploy/Dockerfile
target: runtime
image: classhelper-server:${APP_VERSION:-0.1.0}
restart: unless-stopped
environment:
NODE_ENV: production
HOST: 0.0.0.0
PORT: 4000
DATABASE_PROVIDER: mysql
DATABASE_URL: mysql://${MYSQL_USER:-classhelper}:${MYSQL_PASSWORD}@db:3306/${MYSQL_DATABASE:-classhelper}
JWT_SECRET: ${JWT_SECRET:?请在 deploy/.env 中设置(48 字节随机串)}
JWT_EXPIRES_IN: ${JWT_EXPIRES_IN:-7d}
CORS_ORIGIN: ${CORS_ORIGIN:-*}
TRUST_PROXY: '1'
RATE_LIMIT_ENABLED: 'true'
STARTUP_DB_CHECK: 'true'
LOG_LEVEL: ${LOG_LEVEL:-info}
TERM_START_DATE: ${TERM_START_DATE:-}
INITIAL_ADMIN_USERNAME: ${INITIAL_ADMIN_USERNAME:-admin}
INITIAL_ADMIN_PASSWORD: ${INITIAL_ADMIN_PASSWORD:-admin123}
DEFAULT_STUDENT_PASSWORD: ${DEFAULT_STUDENT_PASSWORD:-123456}
DEFAULT_CLASS_PASSWORD: ${DEFAULT_CLASS_PASSWORD:-123456}
DEFAULT_TEACHER_PASSWORD: ${DEFAULT_TEACHER_PASSWORD:-123456}
ports:
- '${SERVER_PORT:-4000}:4000'
depends_on:
db: { condition: service_healthy }
migrate: { condition: service_completed_successfully }
networks: [classhelper]
networks:
classhelper:
driver: bridge
volumes:
db-data: