# 部署运维工具箱

> **版本**: v1.0 | **日期**: 2026-07-10 | **维护人**: 宋献
> **定位**: 部署运维过程中可复用的脚本、配置模板和调试工具的统一存放点。
> **规则**: 每次故障排查或部署完成后，可复用的工具应归档到此目录并在本 README 中登记。

---

## 工具索引

### 上传部署工具

| 工具 | 用途 | 使用方式 |
|------|------|----------|
| `fast_upload.py` | 堡垒机大文件快速上传（已被 jumpserver-V2 的 psftp 通道替代，仅供参考） | `python fast_upload.py <本地文件> <远程路径>` |
| `deploy_to_container.py` | 一键部署到 Docker 容器（打包→上传→cp→重启） | `python deploy_to_container.py <服务名> <本地路径> <容器路径>` |

### Nginx 配置模板

| 工具 | 用途 | 使用方式 |
|------|------|----------|
| `nginx-access-control.conf` | 三端访问控制配置模板（企微 UA OR IP 白名单双条件放行 + CSP 头） | 上传到服务器 `/opt/wecom-it-desk/nginx/nginx.conf` 后 `docker restart wecom_it_nginx` |

### 调试检查工具

| 工具 | 用途 | 使用方式 |
|------|------|----------|
| `check_html.py` | Python f-string HTML 花括号平衡检查器（排查 `{{ }}` 转义问题） | `python check_html.py <file.py>` |
| `render_test.py` | 容器内 HTML 渲染验证（模拟 f-string 渲染并输出实际 HTML/JS） | `docker exec wecom_it_backend python /tmp/render_test.py` |
| `extract_html.py` | 从 Python f-string 中提取 HTML 模板到独立文件 | `python extract_html.py <file.py>` |

### 历史修复脚本（archive/）

以下脚本为一次性修复用途，保留在 `archive/` 子目录中供参考，不建议直接复用。

| 脚本 | 修复场景 | 日期 |
|------|----------|------|
| `fix_admin_role.py` | 修复扫码登录角色写死为 agent 的问题 | 2026-07-08 |
| `fix_compose_redis.py` / `fix_compose_redis2.py` | 修复 docker-compose Redis 密码 URL 编码 | 2026-07-07 |
| `fix_itdesk.py` / `fix_itdesk2.py` / `fix_itdesk3.py` | 修复 nginx /itdesk/ 路由问题 | 2026-07-08 |
| `patch.py` / `patch-mini.py` / `patch-redis-url.py` | Redis 密码 URL 编码补丁 | 2026-07-02 |
| `update_password.py` | 数据库密码更新脚本 | 2026-07-05 |
| `check_logs.py` / `check_roles.py` / `verify_logs.py` | 日志和角色检查（一次性诊断） | 2026-07-08~09 |
| `upload_chunked.py` / `upload_split.py` | 早期分块上传方案（已被 fast_upload.py 替代） | 2026-07-08 |
| `nginx_*.conf` / `itdesk-nginx-block.conf` | 历史 nginx 配置快照 | 2026-07-06~08 |
| `extract_and_migrate.py` / `_ctrt_transform.py` | 数据迁移和格式转换 | 2026-07-06 |

---

## 工具沉淀流程

1. **排查完成** → 评估是否有可复用的脚本/配置模板
2. **归档** → 复制到 `toolbox/`（活跃工具）或 `toolbox/archive/`（历史脚本）
3. **登记** → 在本 README 的工具索引表中添加条目
4. **清理** → 删除项目根目录的临时文件（渲染输出、中间产物等）

## 堡垒机使用说明

所有工具涉及服务器操作时，通过堡垒机（`sxn@10.212.189.210:2222`）执行：
- 统一使用 `v2_ops.py`（jumpserver-V2 技能）
- 详见 `docs/04-运维文档/部署运维/11-堡垒机运维工具.md`

---

## 相关文档

| 文档 | 位置 |
|------|------|
| 标准故障排查手册 | `docs/04-运维文档/部署运维/00-标准故障排查手册.md` |
| 堡垒机运维工具 | `docs/04-运维文档/部署运维/11-堡垒机运维工具.md` |
| 项目管理 SOP | `docs/07-项目管理/IT智能服务台-标准作业流程SOP.md` |
| Nginx 基线配置 | `docs/04-运维文档/部署运维/01-nginx-prod-baseline-20260708.conf` |

---

> **维护说明**: 新增工具时请同步更新本 README。archive/ 中的脚本仅供历史参考，不保证可用性。