docs(redcap): 重构REDCap文档体系并创建Docker部署操作手册
核心成果: 创建REDCap模块文档体系（4个分类目录） 完成《REDCap Docker部署操作手册》- 最核心文档 梳理从0到1的完整部署流程 明确Docker文件的可复用性 文档体系: - 00-模块概览/ 系统介绍、方案设计、决策报告 - 01-部署与配置/ 部署手册、问题排查（核心） - 02-系统配置与运维/ 日常管理（规划中） - 03-API对接与开发/ API开发、二次开发 - 04-参考资料/ 旧版文档存档 核心文档: 10-REDCap_Docker部署操作手册.md（最重要） - 完整的从0到1部署流程 - Docker文件复用说明和可复用性分析 - 3种环境差异配置（本地/ECS/医院） - 5大常见问题与解决方案 - 部署检查清单 - 日常维护命令 13-部署问题排查手册.md - 基于实际踩坑经验 - ERR_CONTENT_DECODING_FAILED - CRLF污染问题 - Base URL配置错误 - MySQL连接问题 Docker文件可复用性: 100%可复用（无需修改）: - Dockerfile.redcap - docker-entrypoint.sh - config/php/php.ini - .gitattributes 需根据环境调整: - docker-compose.yml（端口、卷路径） - config/apache/redcap.conf（域名） - config/database.php（数据库连接） 文档重组: - 移动文档到对应分类目录 - 重命名为标准格式（数字前缀） - 旧版文档归档到参考资料 - 创建README快速入口 下一步: - Day 2: 开发REDCap API Adapter - 创建API使用指南 - 创建对接设计文档
This commit is contained in:
140
docs/03-业务模块/Redcap/README.md
Normal file
140
docs/03-业务模块/Redcap/README.md
Normal file
@@ -0,0 +1,140 @@
|
||||
# REDCap模块文档
|
||||
|
||||
**版本：** v1.0
|
||||
**最后更新：** 2026-01-02
|
||||
**模块状态：** 🟢 本地环境已部署，API开发中
|
||||
|
||||
---
|
||||
|
||||
## 🚀 快速开始
|
||||
|
||||
### 我想部署REDCap
|
||||
👉 **[10-REDCap_Docker部署操作手册.md](./01-部署与配置/10-REDCap_Docker部署操作手册.md)** ⭐
|
||||
|
||||
这是最核心的文档！包含：
|
||||
- ✅ 从0到1的完整部署流程
|
||||
- ✅ Docker文件复用说明
|
||||
- ✅ 常见问题与解决方案
|
||||
- ✅ 适用于本地/ECS/医院环境
|
||||
|
||||
**30分钟完成部署！**
|
||||
|
||||
---
|
||||
|
||||
### 我遇到问题了
|
||||
👉 **[13-部署问题排查手册.md](./01-部署与配置/13-部署问题排查手册.md)** 🔧
|
||||
|
||||
基于实际踩坑经验，包含：
|
||||
- ERR_CONTENT_DECODING_FAILED解决方案
|
||||
- 登录失败（CRLF污染）解决方案
|
||||
- Base URL配置错误修复
|
||||
- MySQL连接问题排查
|
||||
|
||||
---
|
||||
|
||||
## 📚 完整文档目录
|
||||
|
||||
### [00-模块概览](./00-模块概览/)
|
||||
- [00-REDCap模块文档导航.md](./00-模块概览/00-REDCap模块文档导航.md) - 完整文档索引
|
||||
- [02-REDCap对接总体方案.md](./00-模块概览/02-REDCap对接总体方案.md) - 技术架构设计
|
||||
- [03-REDCap对接风险评估与技术挑战分析.md](./00-模块概览/03-REDCap对接风险评估与技术挑战分析.md) - 风险评估
|
||||
- [04-生产环境部署决策报告_ECS_vs_SAE.md](./00-模块概览/04-生产环境部署决策报告_ECS_vs_SAE.md) - ECS vs SAE对比
|
||||
|
||||
### [01-部署与配置](./01-部署与配置/) ⭐
|
||||
- **[10-REDCap_Docker部署操作手册.md](./01-部署与配置/10-REDCap_Docker部署操作手册.md)** - 核心部署文档
|
||||
- [13-部署问题排查手册.md](./01-部署与配置/13-部署问题排查手册.md) - 问题解决记录
|
||||
|
||||
### [02-系统配置与运维](./02-系统配置与运维/)
|
||||
- 🚧 20-REDCap系统配置手册.md（规划中）
|
||||
- 🚧 21-REDCap日常运维手册.md（规划中）
|
||||
- 🚧 22-REDCap升级指南.md（规划中）
|
||||
|
||||
### [03-API对接与开发](./03-API对接与开发/)
|
||||
- [33-REDCap二次开发深度指南.md](./03-API对接与开发/33-REDCap二次开发深度指南.md) - External Modules开发
|
||||
- 🚧 30-REDCap_API使用指南.md（开发中）
|
||||
- 🚧 31-IIT_Manager与REDCap对接设计.md（开发中）
|
||||
- 🚧 32-REDCap_API_Adapter开发指南.md（开发中）
|
||||
|
||||
### [04-参考资料](./04-参考资料/)
|
||||
- 旧版文档存档
|
||||
|
||||
---
|
||||
|
||||
## 📊 当前进度
|
||||
|
||||
| 阶段 | 状态 | 完成日期 |
|
||||
|------|------|----------|
|
||||
| 技术调研 | ✅ 完成 | 2025-12 |
|
||||
| 部署方案设计 | ✅ 完成 | 2026-01-01 |
|
||||
| **本地环境部署** | ✅ **完成** | **2026-01-02** |
|
||||
| API Adapter开发 | ⏳ 进行中 | 预计2026-01-03 |
|
||||
| 生产环境部署 | 📅 计划中 | 待定 |
|
||||
|
||||
**访问地址：** http://localhost:8080/
|
||||
**管理员账户：** Admin / Admin123!
|
||||
|
||||
---
|
||||
|
||||
## 🎯 REDCap在IIT Manager中的角色
|
||||
|
||||
```
|
||||
IIT Manager Agent (企业微信)
|
||||
↓
|
||||
REDCap API Adapter
|
||||
↓
|
||||
REDCap系统 (EDC)
|
||||
↓
|
||||
研究数据采集与管理
|
||||
```
|
||||
|
||||
**核心功能：**
|
||||
- 📋 电子数据采集（EDC）
|
||||
- 📊 数据字典管理
|
||||
- 🔍 数据质量控制
|
||||
- 📈 报表与导出
|
||||
- 👥 用户权限管理
|
||||
|
||||
---
|
||||
|
||||
## 🛠️ Docker配置文件位置
|
||||
|
||||
**所有Docker配置文件都在：**
|
||||
```
|
||||
AIclinicalresearch/redcap-docker-dev/
|
||||
├── Dockerfile.redcap ✅ 100%可复用
|
||||
├── docker-compose.yml ⚠️ 需微调
|
||||
├── docker-compose.prod.yml ⚠️ 需修改数据库配置
|
||||
├── docker-entrypoint.sh ✅ 100%可复用
|
||||
├── config/
|
||||
│ ├── apache/redcap.conf ⚠️ 需修改域名
|
||||
│ ├── php/php.ini ✅ 100%可复用
|
||||
│ └── database.php ❌ 必须根据环境定制
|
||||
├── scripts/ 可选辅助脚本
|
||||
└── .gitattributes ✅ 100%可复用
|
||||
```
|
||||
|
||||
详见：[10-REDCap_Docker部署操作手册.md](./01-部署与配置/10-REDCap_Docker部署操作手册.md)
|
||||
|
||||
---
|
||||
|
||||
## 📞 获取帮助
|
||||
|
||||
- **部署问题**：查看 [13-部署问题排查手册.md](./01-部署与配置/13-部署问题排查手册.md)
|
||||
- **REDCap官方**：https://projectredcap.org/
|
||||
- **技术支持**：查看相关文档或提Issue
|
||||
|
||||
---
|
||||
|
||||
## 🔄 最近更新
|
||||
|
||||
| 日期 | 更新内容 |
|
||||
|------|----------|
|
||||
| 2026-01-02 | ✅ 完成本地Docker环境部署 |
|
||||
| 2026-01-02 | ✅ 创建REDCap Docker部署操作手册 |
|
||||
| 2026-01-02 | ✅ 创建部署问题排查手册 |
|
||||
| 2026-01-02 | ✅ 重组文档体系 |
|
||||
|
||||
---
|
||||
|
||||
**准备好开始了吗？** 👉 [开始部署](./01-部署与配置/10-REDCap_Docker部署操作手册.md)
|
||||
|
||||
Reference in New Issue
Block a user