89 lines
5.3 KiB
Markdown
89 lines
5.3 KiB
Markdown
# 配置与运行（OPERATIONS）
|
||
|
||
> 文档定位：**配置 / 启动 / 环境 / 运维硬性要求的唯一归属**。
|
||
> 部署入口与部署文档分工见 [DEPLOYMENT.md](DEPLOYMENT.md)，Linux 详细步骤见 [deployment/LINUX_SETUP.md](deployment/LINUX_SETUP.md)；当前状态见 [STATUS.md](STATUS.md)，架构见 [ARCHITECTURE.md](ARCHITECTURE.md)。
|
||
|
||
---
|
||
|
||
## 1. 配置来源与优先级
|
||
|
||
- 配置统一走**环境变量**，代码侧由 [src/shared/config/settings.py](../src/shared/config/settings.py) 的 `Settings` 单例经 `dotenv` + `os.getenv` 读取。
|
||
- **本地运行**：仓库根 `.env`（`load_dotenv()` 自动加载；不在仓库内，参照 [.env.example](../.env.example) 复制编辑）。
|
||
- **Compose 运行**：compose 文件用 `${VAR}` 从同目录 `.env` 注入容器环境变量（见 [docker-compose.yml](../docker-compose.yml)）。
|
||
- **键值约定**：
|
||
- `DB_HOST / DB_PORT / DB_NAME / DB_USER / DB_PASSWORD`：**惰性校验、无代码默认**——缺失时 import 不报错（便于测试/静态分析），真正连库时才失败。生产必须显式配置。
|
||
- `SECRET_KEY`：JWT 签名密钥，**无默认**；生产必须 ≥32 字符强随机。
|
||
- `ADMIN_PASSWORD`：初始管理员密码，**无默认**；首次建库前必须设置。
|
||
- `RUSTFS_*`：对象存储（兼容 `MINIO_*` 别名写法）；本地开发缺省值仅为占位，连不上会在用到存储的链路报错。
|
||
- `REDIS_*`：默认 `localhost:6379` 无密码（本地开发语义），生产必须显式覆盖。
|
||
- `CORS_ORIGINS`：逗号分隔白名单；不设默认放行 `*`，**生产必须显式设置**。
|
||
- `LOG_FORMAT`：`json`（生产默认，结构化）/ `text`（开发人可读）；`LOG_LEVEL`：DEBUG/INFO/WARNING/ERROR。
|
||
- `DEBUG`：`true` 时额外注册 `/api/debug/*` 调试路由（仍需登录），**生产必须为 false**。
|
||
- 新增配置项的规则：只加 `settings.py` + `.env.example`，关键依赖项不给 localhost/弱口令兜底（见 [AGENTS.md](../AGENTS.md) §2）。
|
||
|
||
## 2. 安装与环境
|
||
|
||
- 后端依赖：`pip install -r requirements.txt`。
|
||
- **OCC 几何能力**：PythonOCC 不走 pip 主路径，通过 conda 环境提供（本项目实践环境名 `gemold`）。无 OCC 环境时项目可启动，但几何分析契约测试自动 skip。
|
||
- 前端：`cd frontend && npm install`。
|
||
- 数据库迁移：`alembic/`（`alembic.ini` 在仓库根）；数据修复类一次性脚本在 `scripts/migrations/` 与 `scripts/db/`，**不是运行时代码**，勿在服务内引用。
|
||
|
||
## 3. 本地启动
|
||
|
||
后端三入口（均含 sys.path 修正，可从仓库根直接跑）：
|
||
|
||
```bash
|
||
# unified（moldinsight + inventory，推荐）：8000
|
||
uvicorn src.entrypoints.unified:app --reload --host 0.0.0.0 --port 8000
|
||
# moldinsight-only：8000
|
||
uvicorn src.entrypoints.moldinsight:app --reload --host 0.0.0.0 --port 8000
|
||
# inventory-only：8001
|
||
uvicorn src.entrypoints.inventory:app --reload --host 0.0.0.0 --port 8001
|
||
```
|
||
|
||
Celery worker（moldinsight 异步分析链路；本地从 `src` 目录跑，与 [deploy/Dockerfile.celery](../deploy/Dockerfile.celery) CMD 同参）：
|
||
|
||
```bash
|
||
cd src && celery -A celery_app worker --concurrency=2 --loglevel=info
|
||
```
|
||
|
||
前端：
|
||
|
||
```bash
|
||
cd frontend
|
||
npm run dev # Vite 开发服务器
|
||
npm run gen:api # 从根目录 openapi.json 重新生成 src/types/api.ts（见 API_CONTRACT §4）
|
||
```
|
||
|
||
探活：unified/moldinsight `GET /health` 与 `GET /api/health`；inventory `GET /health`。
|
||
|
||
## 4. Docker Compose
|
||
|
||
```bash
|
||
docker compose --profile full up -d # frontend + unified backend + moldinsight-celery（推荐）
|
||
docker compose --profile moldinsight up -d # moldinsight 单模块栈
|
||
docker compose --profile inventory up -d # inventory 单模块栈
|
||
```
|
||
|
||
- 镜像构建：`deploy/build.bat` / `deploy/build.sh`（base → 各服务镜像，见 `deploy/Dockerfile.*`）。
|
||
- PostgreSQL / Redis / RustFS 通常**复用服务器已有服务**，不由项目 compose 自带；容器只注入连接配置。
|
||
|
||
## 5. 运行时硬性要求
|
||
|
||
- **生产环境必须显式设置**：`SECRET_KEY`、`ADMIN_PASSWORD`、`DB_*`、`CORS_ORIGINS`、`RUSTFS_*`、`REDIS_PASSWORD`、`DEBUG=false`、`LOG_FORMAT=json`。
|
||
- **单数据库**：moldinsight 与 inventory 共享同一 PostgreSQL（刻意设计，不拆库）。
|
||
- **后台任务一律走 `task_dispatcher`** 与 Celery，不要在路由里 fire-and-forget。
|
||
- **uploads/ 与 html_output/ 为运行时产物目录**，不提交、不作为配置源头。
|
||
- `scripts/` 下的一次性脚本执行前先确认目标环境（多为不可逆数据迁移）。
|
||
|
||
## 6. 排障指针
|
||
|
||
| 症状 | 先看 |
|
||
|---|---|
|
||
| 起服务连不上数据库 | `.env` 的 `DB_*` 是否与服务器一致（惰性校验：import 成功 ≠ 连接正常） |
|
||
| 上传/导出报对象存储错误 | `RUSTFS_*` 四项 + [topics/storage/RUSTFS_STORAGE.md](topics/storage/RUSTFS_STORAGE.md) |
|
||
| 分析任务一直 pending | Celery worker 是否在跑；Redis 连通性；`task_dispatcher` 日志 |
|
||
| 前端类型与接口对不上 | `openapi.json` 是否重新导出、`npm run gen:api` 是否执行（[API_CONTRACT.md](API_CONTRACT.md) §4） |
|
||
| 登录 401 | `SECRET_KEY` 是否跨进程一致（JWT 校验依赖同一密钥） |
|
||
| 部署端口/反代问题 | [deployment/DEPLOY_PORT.md](deployment/DEPLOY_PORT.md)、[deployment/PORT_CONFIG.md](deployment/PORT_CONFIG.md) |
|