Skip to content

部署

实施与运维上线前的检查清单。

前置条件

  • 后端:默认端口 8080。直接启动时应用上下文为 /
  • 数据库:默认 MySQL 8.0+,库名 oars。生产必须覆盖连接信息。
  • Redis:生产必须配置地址与密码,不使用开发默认值。
  • 文件:默认本地存储 file.storage.local.path=./uploads,单文件上限 50MB。
  • 接口文档:开发/测试环境直接访问后端为 /swagger-ui.html;生产环境默认关闭。
  • 健康检查:直接访问后端时为 /actuator/health(不返回组件详情)。容器交付经前端访问时,接口前缀以现场 Nginx 为准(常见为 /oars)。

部署检查项

  • 数据库已创建,字符集建议 utf8mb4
  • Redis 可连通,密码与配置一致。生产环境 Redis 故障时,接口限流会拒绝请求(HTTP 429)。
  • 上传目录存在,后端进程有读写权限。
  • 生产环境已设置 JWT_SECRET(至少 32 个字符的随机串),不使用仓库示例值或开发密钥。
  • 生产环境接口文档默认关闭;如需跨域访问后端,在配置中填写 oars.cors.allowed-origin-patterns,不要使用 *
  • 登出请求须携带当前登录令牌,服务端才能使该令牌立即失效。
  • 前端 API 地址指向实际后端入口(直接连后端用根路径;经前端容器反代时常见为 /oars)。
  • 如果启用 ONLYOFFICE,浏览器能访问 Document Server,Document Server 能回调 OARS(见 ONLYOFFICE 实施)。
  • 如采用容器部署,确认镜像标签、环境配置、数据卷、健康检查和备份策略已归档。

配置项参考

后端配置中的关键参数:

  • JWT:生产必须提供 JWT_SECRET(至少 32 字符)
  • CORSoars.cors.allowed-origin-patterns(空则仅同源;开发环境已允许本机 Vite 端口)
  • 限流oars.rate-limit.*(默认每 IP 每秒 100 次;生产 Redis 不可用时返回 429)
  • 出站地址oars.outbound.*(生产默认禁止访问回环和私网)
  • 分页oars.page.max-size(默认每页最多 200 条)
  • 登录锁定oars.auth.max-failures / oars.auth.lock-minutes
  • 数据库spring.datasource.*(生产密码由 SPRING_DATASOURCE_PASSWORD 注入)
  • Redisspring.data.redis.*
  • 数据库迁移spring.flyway.*
  • 文件存储file.storage.*
  • 消息message.inner.enabled

Nginx/网关是否把接口挂在独立路径、上传目录是否纳入备份、生产是否使用对象存储,按现场方案确认。

Docker 部署

OARS 支持前后端容器化部署。标准容器文件位于 deploy/docker/

详细步骤见 Docker 部署