重组为 backend/clients/docs 三层结构,并清理 git 污染。

将后端迁入 backend/,完善根目录 .gitignore,删除误提交的 .mypy_cache 缓存文件。

Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
Kevin
2026-05-21 16:02:25 +08:00
parent 6bc6801df9
commit 1af442481e
142 changed files with 175 additions and 212 deletions

View File

@@ -2,7 +2,7 @@
本文说明 **方式 B**:厂商在可联网环境构建并导出 API 镜像为 `tar`/`tar.gz`,客户在目标服务器 **不拉取 API 镜像构建上下文** 的情况下,通过 `docker load` 加载后启动完整后端PostgreSQL + MinIO + API
> 说明:仓库默认的 `docker-compose.yml` 中 `api` 使用 `build:`。客户侧使用 tarball 时,必须使用下方 **「仅使用已加载镜像」** 的 Compose 片段(将 `build` 换成 `image`),否则仍会尝试本地构建。
> 说明:仓库默认的 `backend/docker-compose.yml` 中 `api` 使用 `build:`。客户侧使用 tarball 时,必须使用下方 **「仅使用已加载镜像」** 的 Compose 片段(将 `build` 换成 `image`),否则仍会尝试本地构建。
---
@@ -13,7 +13,7 @@
### 1. 构建并打标签
```bash
cd /path/to/operation-room-monitor-server
cd /path/to/operation-room-monitor/backend
docker compose build api
docker tag operation-room-monitor-server-api:latest <交付镜像名>:<版本号>
# 示例docker tag operation-room-monitor-server-api:latest acme/or-monitor-api:1.0.0
@@ -51,8 +51,8 @@ docker save \
|------|------|
| `or-monitor-api_*.tar.gz`(或全栈 `*_offline.tar.gz` | 镜像包 |
| 本文档 | 客户部署步骤 |
| `docker-compose.yml` **或** 下文「离线 Compose」全文 | `api` 使用 `image:` 而非 `build:` |
| `.env.example`(按项目实际改名) | 环境变量模板,勿包含真实密钥 plaintext 于公共渠道 |
| `docker-compose.yml` **或** 下文「离线 Compose」全文 | `api` 使用 `image:` 而非 `build:`(位于 `backend/` |
| `backend/.env.example`(按项目实际改名) | 环境变量模板,勿包含真实密钥 plaintext 于公共渠道 |
|(可选)语音确认前端静态包、`OR_SITE_CONFIG` 样例 | 按需 |
---
@@ -212,7 +212,7 @@ volumes:
## 五、环境变量与密钥
在同一目录放置 `.env`(可参考仓库内 `.env.example`)。至少建议关注:
在同一目录`backend/`放置 `.env`(可参考 `backend/.env.example`)。至少建议关注:
- `POSTGRES_PASSWORD`:生产请务必改为强密码。
- `API_PORT`:宿主机监听端口。