Docker 部署说明文档

Docker 部署说明文档
欢迎使用全新的 Docker 目录通过 Docker Compose 部署 Dify。本文档将说明更新内容、部署指南以及现有用户的迁移细节。

重要更新
• Certbot 容器：docker-compose.yaml 现已集成 certbot 用于管理 SSL 证书。该容器可自动续期证书并确保 HTTPS 安全连接。更多信息请参阅 docker/certbot/README.md。

• 持久化环境变量：现在通过 .env 文件统一管理环境变量配置，确保部署配置可持久化保存。

什么是 .env 文件？
.env 是 Docker 和 Docker Compose 环境中的核心配置文件，用于集中定义容器运行时所需的环境变量。该文件简化了开发、测试和生产等不同阶段的环境配置管理，为部署提供一致的配置体验。

• 向量数据库服务整合：所有向量数据库服务现已统一通过 docker-compose.yaml 文件管理。您只需在 .env 文件中设置 VECTOR_STORE 环境变量即可切换不同的向量数据库（如 milvus/weaviate/opensearch 等）。

• 强制 .env 文件要求：现在执行 docker compose up 必须提供 .env 文件。该文件对配置持久化和升级维护至关重要。

• 旧版支持：旧版部署文件已迁移至 docker-legacy 目录，后续将不再维护。

Docker Compose 部署指南
前提条件
确保系统已安装 Docker 和 Docker Compose

环境配置

1. 进入 docker 目录
2. 执行 cp .env.example .env 创建配置文件
3. 按需编辑 .env 文件（配置说明详见 .env.example）

启动服务
• 在 docker 目录下执行 docker compose up
• 在 .env 文件中设置 VECTOR_STORE 变量指定向量数据库（如 milvus/weaviate/opensearch）

SSL 证书配置
请参阅 docker/certbot/README.md 通过 Certbot 配置 SSL 证书

中间件开发环境部署
中间件配置

1. 使用 docker-compose.middleware.yaml 部署数据库/缓存等核心中间件
2. 执行 cp middleware.env.example middleware.env 创建配置文件（参考 middleware.env.example）

启动中间件
执行 docker-compose -f docker-compose.middleware.yaml up --env-file middleware.env -d

现有用户迁移指南
迁移步骤

1. 变更审查：熟悉新的 .env 配置体系和 Docker Compose 结构
2. 配置迁移：
   • 原 docker-compose.yaml 自定义配置需转换为 .env 配置项
   • ssrf_proxy/squid.conf 和 nginx/conf.d/default.conf 等配置需相应调整
3. 数据迁移：
   • 确保数据库/缓存等服务的备份数据迁移至新结构

.env 文件详解
核心模块与定制
• 向量数据库服务：根据 VECTOR_STORE 类型配置对应端点/端口/认证信息
• 存储服务：通过 STORAGE_TYPE 配置 S3/Azure Blob/Google Storage 等存储方案
• API 与 Web 服务：定义 API 接口和前端运行的各类参数

其他关键变量
提供的 .env.example 包含全面的配置选项，主要分为以下模块：

通用配置
• CONSOLE_API_URL/SERVICE_API_URL：API 服务地址
• APP_WEB_URL：前端应用地址
• FILES_URL：文件下载/预览基础地址

服务器配置
• LOG_LEVEL/DEBUG/FLASK_DEBUG：日志与调试设置
• SECRET_KEY：会话加密密钥

数据库配置
• DB_USERNAME/DB_PASSWORD/DB_HOST/DB_PORT：PostgreSQL 连接参数

Redis 配置
• REDIS_HOST/REDIS_PORT/REDIS_PASSWORD：Redis 连接参数

Celery 配置
• CELERY_BROKER_URL：消息代理地址

存储配置
• STORAGE_TYPE/S3_BUCKET_NAME/AZURE_BLOB_ACCOUNT_NAME：文件存储方案配置

向量数据库配置
• VECTOR_STORE：数据库类型（weaviate/milvus 等）
• 各数据库专属配置（WEAVIATE_ENDPOINT/MILVUS_URI 等）

CORS 配置
• WEB_API_CORS_ALLOW_ORIGINS/CONSOLE_CORS_ALLOW_ORIGINS：跨域资源共享设置

服务专属变量
nginx/redis/db/向量数据库等组件在 docker-compose.yaml 中均有对应的环境变量定义

其他说明
• 持续优化阶段：我们正积极收集社区反馈以完善部署流程
• 技术支持：详细配置请参考 docker 目录下的 .env.example 和 Docker Compose 文件
• 官方文档：如需进一步协助，请查阅官方文档或联系技术支持团队

本说明文档旨在指导您使用新版 Docker Compose 完成部署。如遇问题，请参考相关技术文档获取支持。