OARS Docs

Appearance

部署 ​

面向实施与运维的检查清单。配置项全量说明见 monorepo oars-java/CONFIG.md；Redis 安装见 oars-java/REDIS-SETUP-GUIDE.md；国产库驱动见 oars-java/INSTALL-NATIVE-DB-DRIVERS.md。

前置条件 ​

  • 后端：Spring Boot，默认 server.port=8080、server.servlet.context-path=/oars。
  • 数据库：默认 MySQL 8.0+，库名 oars，连接项在 application-dev.yml，生产需覆盖；可选 demo profile（oars_demo）。
  • Redis：默认 localhost:6379，开发环境密码为 redis123。
  • 文件：默认本地存储 file.storage.local.path=./uploads，单文件上限 50MB。
  • 接口文档：/oars/swagger-ui.html（联调见 oars-java/SWAGGER-GUIDE.md）。
  • 健康检查：/oars/actuator/health。

部署检查项 ​

  • 数据库已创建，字符集建议 utf8mb4。
  • Redis 可 PING，密码与配置一致。
  • 上传目录存在，后端进程有读写权限。
  • JWT 密钥生产环境已替换，不使用默认开发密钥（认证细节 oars-java/AUTH-GUIDE.md）。
  • 登出须携带 Authorization: Bearer {accessToken} 才能使 Token 黑名单生效；Redis 故障时黑名单 fail-open（见 AUTH-GUIDE）。
  • 前端 API 地址指向带 /oars 的后端地址。
  • 如果启用 ONLYOFFICE，浏览器能访问 Document Server，Document Server 能回调 OARS（见 ONLYOFFICE 实施）。
  • 如采用 Docker 部署，确认镜像 tag、.env、数据卷、健康检查和备份策略已归档。

配置项参考 ​

后端配置中的关键参数（完整列表见 oars-java/CONFIG.md）：

  • 数据库：spring.datasource.*
  • Redis：spring.data.redis.*
  • Flyway：spring.flyway.*
  • 文件存储：file.storage.*
  • 消息：message.inner.enabled
  • 演示环境：application-demo.yml / OARS_DEMO_* 环境变量

Nginx/网关是否保留 /oars context path、上传目录是否纳入备份、生产是否使用对象存储，需根据部署环境确认。

Docker 部署 ​

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

详细步骤见 Docker 部署。

L2 详细说明（monorepo） ​

主题文档
多环境配置oars-java/CONFIG.md
Redisoars-java/REDIS-SETUP-GUIDE.md
数据库连接/多数据源oars-java/DATABASE-GUIDE.md
国产库驱动oars-java/INSTALL-NATIVE-DB-DRIVERS.md
JWT / 登录oars-java/AUTH-GUIDE.md