baodan/scripts/README.md

88 lines
2.5 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 脚本目录说明
## 目录结构
```
scripts/
├── deploy/ # 部署相关脚本
├── build/ # 构建打包脚本
├── tools/ # 工具脚本
├── setup/ # 初始化/配置脚本
└── README.md # 本文件
```
## deploy/ — 部署脚本
| 脚本 | 用途 |
|------|------|
| `deploy-baodanagent.sh` | **主部署脚本**Linux |
| `deploy-baodanagent.bat` | **主部署脚本**Windows |
| `quick-deploy.sh` | 快速部署(最小化) |
| `quick-deploy.bat` | 快速部署Windows |
| `quick-start.sh` | 一条命令启动 |
| `server-setup.sh` | 服务器首次安装 |
| `server-deploy.sh` | 服务器一键部署 |
| `server-update.sh` | 服务器更新镜像 |
| `migrate.sh` | 数据迁移(导出/导入) |
| `sync-to-server.sh` | rsync 同步代码到服务器 |
| `update-code.sh` | 仅更新代码 |
| `update-frontend.sh` | 仅更新前端 |
| `deploy-package.sh` | 服务器端部署包解压启动 |
| `entrypoint.sh` | Docker 容器入口脚本 |
| `start-api.sh` | 启动 API 服务 |
## build/ — 构建脚本
| 脚本 | 用途 |
|------|------|
| `build-and-push.sh` | 构建镜像并推送到 Docker Hub |
| `build-web-from-source.sh` | 从源码构建 Web 镜像 |
| `package.sh` | 精简打包自研代码(约 1-2MB |
## tools/ — 工具脚本
| 脚本 | 用途 |
|------|------|
| `check-env.sh` | 环境检查 |
| `docker-cleanup.sh` | Docker 清理(释放磁盘) |
| `export-images.sh` | 导出镜像(离线部署) |
| `export-data.ps1` | 导出数据Windows PowerShell |
## setup/ — 初始化脚本
| 脚本 | 用途 |
|------|------|
| `create_admin.py` | 创建管理员账号 |
| `init_admin_docker.py` | Docker 环境初始化管理员 |
| `make_admin.sql` | SQL 直接添加管理员 |
| `auto_init.py` | 自动初始化 |
| `setup_dify_api_keys.py` | 配置 Dify API Keys |
| `setup_workflow.py` | 导入 Workflow 配置 |
| `import_workflow.py` | 导入工作流 |
| `upload_kb_docs.py` | 上传知识库文档 |
| `run_migration.py` | 运行数据库迁移 |
| `patch_app.py` | 修补 BaoDan 应用 |
| `add_baodan_conversation_id.py` | 添加对话 ID 字段 |
## 常用命令
```bash
# 本地开发启动
bash scripts/deploy/quick-start.sh
# 服务器部署
bash scripts/deploy/deploy-baodanagent.sh
# 构建镜像
bash scripts/build/build-and-push.sh
# 精简打包
bash scripts/build/package.sh
# 环境检查
bash scripts/tools/check-env.sh
# 清理 Docker
bash scripts/tools/docker-cleanup.sh
```