dosubot[bot]
commented
2 months ago I found a similar open issue: [Enhancement] Optimization of the docker-compose.yaml file, which is closed. This issue was addressed by adding a .env.example file and updating the docker-compose.yaml to streamline configuration management by using environment variables. You can refer to the related pull request here for more details.
To keep the writing format in Dify Docker Compose configuration files consistent, you should follow these guidelines:
- Use Markdown for Documentation: Continue using Markdown syntax for headings, lists, code blocks, and other formatting.
- Consistent Heading Levels: Use appropriate heading levels (
##,###, etc.) to organize sections and subsections. - Code Blocks for Commands: Use triple backticks (
``) to create code blocks for commands and outputs. Specify the language for syntax highlighting (e.g.,bash` for shell commands). - Consistent Indentation and Spacing: Ensure consistent indentation and spacing within code blocks and lists.
- Use Tables for System Requirements: Use tables to list system requirements and other tabular data.
- Important Notes and Warnings: Use blockquotes (
>) for important notes and warnings.
Here is an example of a consistent format based on the provided documentation:
# Docker Compose 部署
### 前提条件
> 安装 Dify 之前, 请确保你的机器已满足最低安装要求：
> - CPU >= 2 Core
> - RAM >= 4GB
| 操作系统 | 软件 | 描述 |
| -------------------------- | -------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| macOS 10.14 or later | Docker Desktop | 为 Docker 虚拟机（VM）至少分配 2 个虚拟 CPU(vCPU) 和 8GB 初始内存，否则安装可能会失败。有关更多信息，请参考 [《在 Mac 内安装 Docker 桌面端》](https://docs.docker.com/desktop/install/mac-install/)。 |
| Linux platforms | <p>Docker 19.03 or later<br>Docker Compose 1.25.1 or later</p> | 请参阅[安装 Docker](https://docs.docker.com/engine/install/) 和[安装 Docker Compose](https://docs.docker.com/compose/install/) 以获取更多信息。 |
| Windows with WSL 2 enabled | <p>Docker Desktop<br></p> | 我们建议将源代码和其他数据绑定到 Linux 容器中时，将其存储在 Linux 文件系统中，而不是 Windows 文件系统中。有关更多信息，请参阅[使用 WSL 2 后端在 Windows 上安装 Docker Desktop](https://docs.docker.com/desktop/windows/install/#wsl-2-backend)。 |
### 克隆 Dify 代码仓库
克隆 Dify 源代码至本地环境。
```bash
git clone https://github.com/langgenius/dify.git启动 Dify
-
进入 Dify 源代码的 Docker 目录
cd dify/docker -
复制环境配置文件
cp .env.example .env -
启动 Docker 容器
根据你系统上的 Docker Compose 版本，选择合适的命令来启动容器。你可以通过
$ docker compose version命令检查版本，详细说明请参考 Docker 官方文档：-
如果版本是 Docker Compose V2，使用以下命令：
docker compose up -d -
如果版本是 Docker Compose V1，使用以下命令：
docker-compose up -d
-
运行命令后，你应该会看到类似以下的输出，显示所有容器的状态和端口映射：
[+] Running 11/11
✔ Network docker_ssrf_proxy_network Created 0.1s
✔ Network docker_default Created 0.0s
✔ Container docker-redis-1 Started 2.4s
✔ Container docker-ssrf_proxy-1 Started 2.8s
✔ Container docker-sandbox-1 Started 2.7s
✔ Container docker-web-1 Started 2.7s
✔ Container docker-weaviate-1 Started 2.4s
✔ Container docker-db-1 Started 2.7s
✔ Container docker-api-1 Started 6.5s
✔ Container docker-worker-1 Started 6.4s
✔ Container docker-nginx-1 Started 7.1s最后检查是否所有容器都正常运行：
docker compose ps在这个输出中，你应该可以看到包括 3 个业务服务 api / worker / web，以及 6 个基础组件 weaviate / db / redis / nginx / ssrf_proxy / sandbox 。
NAME IMAGE COMMAND SERVICE CREATED STATUS PORTS
docker-api-1 langgenius/dify-api:0.6.13 "/bin/bash /entrypoi…" api About a minute ago Up About a minute 5001/tcp
docker-db-1 postgres:15-alpine "docker-entrypoint.s…" db About a minute ago Up About a minute (healthy) 5432/tcp
docker-nginx-1 nginx:latest "sh -c 'cp /docker-e…" nginx About a minute ago Up About a minute 0.0.0.0:80->80/tcp, :::80->80/tcp, 0.0.0.0:443->443/tcp, :::443->443/tcp
docker-redis-1 redis:6-alpine "docker-entrypoint.s…" redis About a minute ago Up About a minute (healthy) 6379/tcp
docker-sandbox-1 langgenius/dify-sandbox:0.2.1 "/main" sandbox About a minute ago Up About a minute
docker-ssrf_proxy-1 ubuntu/squid:latest "sh -c 'cp /docker-e…" ssrf_proxy About a minute ago Up About a minute 3128/tcp
docker-weaviate-1 semitechnologies/weaviate:1.19.0 "/bin/weaviate --hos…" weaviate About a minute ago Up About a minute
docker-web-1 langgenius/dify-web:0.6.13 "/bin/sh ./entrypoin…" web About a minute ago Up About a minute 3000/tcp
docker-worker-1 langgenius/dify-api:0.6.13 "/bin/bash /entrypoi…" worker About a minute ago Up About a minute 5001/tcp通过这些步骤，你应该可以成功在本地安装 Dify。
更新 Dify
进入 dify 源代码的 docker 目录，按顺序执行以下命令：
cd dify/docker
docker compose down
git pull origin main
docker compose pull
docker compose up -d同步环境变量配置 (重要！)
- 如果
.env.example文件有更新，请务必同步修改您本地的.env文件。 - 检查
.env文件中的所有配置项，确保它们与您的实际运行环境相匹配。您可能需要将.env.example中的新变量添加到.env文件中，并更新已更改的任何值。
访问 Dify
在浏览器中输入 http://localhost 访问 Dify。
自定义配置
编辑 .env 文件中的环境变量值。然后，重新启动 Dify：
docker compose down
docker compose up -d完整的环境变量集合可以在 docker/.env.example 中找到[1][2].
By following these guidelines, you can maintain a consistent writing format in Dify Docker Compose configuration files.
To continue talking to Dosu, mention @dosu.
Self Checks
1. Is this request related to a challenge you're experiencing? Tell me about your story.
Currently, the way in which Dify's configuration files are written is inconsistent. A small number of configurations will be adjusted to be consistent with the way most container services write configurations, which is conducive to maintainability and the creation, testing and versioning of configuration files by external writing programs. Track management.
2. Additional context or comments
No response
3. Can you help us with this feature?