部署与运行指南
前置条件
- Node.js 18+(建议)
- MySQL 5.7+/8.0+
- 可选:PM2(进程管理)或 Docker(容器化部署)
项目启动
- 安装依赖:
npm install - 配置环境变量:复制
.env.example为.env并修改 - 启动服务:
npm start - 访问:
- 基础健康检查:
http://localhost:[PORT]/ - Swagger 文档(非生产环境):
http://localhost:[PORT]/openapi
- 基础健康检查:
PM2 部署
使用 ecosystem.config.cjs:
npm i -g pm2
pm2 start ecosystem.config.cjs --env production
pm2 status
pm2 logs- 日志位置:
logs/ - 关闭:
pm2 stop umo-office-convert
Docker 部署
见 Docker 部署 。
- 注意:将 MySQL 服务暴露给容器,并确保服务可达(如使用主机网络或容器网络)。
数据库准备
- 创建数据库与用户(示例):
CREATE DATABASE IF NOT EXISTS `umo_office_convert` DEFAULT CHARACTER SET utf8mb4; CREATE USER 'convert_user'@'%' IDENTIFIED BY 'strong_password'; GRANT ALL PRIVILEGES ON `umo_office_convert`.* TO 'convert_user'@'%'; FLUSH PRIVILEGES; - 服务启动后会自动创建表
convert_tasks
运行时目录
- 原始文件保存目录(可选)
- 转换后的文档保存目录
- 日志目录
生产建议
- 使用对象存储(S3/OSS)替代本地磁盘
- 通过反向代理(Nginx)启用 HTTPS 与限流
- 配置
WHITE_LIST严格控制跨域来源 - 调整
MAX_FILE_SIZE与FILE_HASH_ALGORITHM以适配业务