Skip to content

Commit a81c306

Browse files
RiskeyLRiskeyL
authored
docs: update docker compose container list and add tool prerequisites (#843)
* docs: update docker compose container list and add tool prerequisites - Add api_websocket and init_permissions to the started-container list per the current compose defaults - Remove outdated sample outputs for docker compose up and docker compose ps - Add a callout noting the clone command requires git, curl, and jq, with recovery guidance on command not found errors - Mirror all changes to zh and ja * docs: note expected exited status for init_permissions container
1 parent 5f8252d commit a81c306

3 files changed

Lines changed: 21 additions & 109 deletions

File tree

‎en/self-host/deploy/quick-start/docker-compose.mdx‎

Lines changed: 7 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,11 @@ Make sure your machine meets the following minimum system requirements.
3232

3333
```bash
3434
git clone --branch "$(curl -s https://api.github.com/repos/langgenius/dify/releases/latest | jq -r .tag_name)" https://github.com/langgenius/dify.git
35-
3635
```
36+
37+
<Info>
38+
This command requires `git`, `curl`, and `jq`. If you see a `command not found` error, install the missing tool and run the command again.
39+
</Info>
3740
</Step>
3841
<Step title="Start Dify">
3942

@@ -62,50 +65,17 @@ Make sure your machine meets the following minimum system requirements.
6265

6366
The following containers will be started:
6467

65-
- 5 core services: `api`, `worker`, `worker_beat`, `web`, `plugin_daemon`
68+
- 6 core services: `api`, `api_websocket`, `worker`, `worker_beat`, `web`, `plugin_daemon`
6669
- 6 dependent components: `weaviate`, `db_postgres`, `redis`, `nginx`, `ssrf_proxy`, `sandbox`
67-
68-
You should see output similar to the following, showing the status and start time of each container:
69-
70-
```bash
71-
[+] Running 13/13
72-
✔ Network docker_ssrf_proxy_network Created 10.0s
73-
✔ Network docker_default Created 0.1s
74-
✔ Container docker-sandbox-1 Started 0.3s
75-
✔ Container docker-db_postgres-1 Healthy 2.8s
76-
✔ Container docker-web-1 Started 0.3s
77-
✔ Container docker-redis-1 Started 0.3s
78-
✔ Container docker-ssrf_proxy-1 Started 0.4s
79-
✔ Container docker-weaviate-1 Started 0.3s
80-
✔ Container docker-worker_beat-1 Started 3.2s
81-
✔ Container docker-api-1 Started 3.2s
82-
✔ Container docker-worker-1 Started 3.2s
83-
✔ Container docker-plugin_daemon-1 Started 3.2s
84-
✔ Container docker-nginx-1 Started 3.4s
85-
```
70+
- 1 one-time task: `init_permissions`, which sets storage file permissions and exits when done (an `Exited` status is expected)
8671

8772
4. Verify that all containers are running successfully:
8873

8974
```bash
9075
docker compose ps
9176
```
9277

93-
You should see output similar to the following, with each container in the `Up` or `healthy` status:
94-
95-
```bash
96-
NAME IMAGE COMMAND SERVICE CREATED STATUS PORTS
97-
docker-api-1 langgenius/dify-api:1.10.1 "/bin/bash /entrypoi…" api 26 seconds ago Up 22 seconds 5001/tcp
98-
docker-db_postgres-1 postgres:15-alpine "docker-entrypoint.s…" db_postgres 26 seconds ago Up 25 seconds (healthy) 5432/tcp
99-
docker-nginx-1 nginx:latest "sh -c 'cp /docker-e…" nginx 26 seconds ago Up 22 seconds 0.0.0.0:80->80/tcp, :::80->80/tcp, 0.0.0.0:443->443/tcp, :::443->443/tcp
100-
docker-plugin_daemon-1 langgenius/dify-plugin-daemon:0.4.1-local "/bin/bash -c /app/e…" plugin_daemon 26 seconds ago Up 22 seconds 0.0.0.0:5003->5003/tcp, :::5003->5003/tcp
101-
docker-redis-1 redis:6-alpine "docker-entrypoint.s…" redis 26 seconds ago Up 25 seconds (health: starting) 6379/tcp
102-
docker-sandbox-1 langgenius/dify-sandbox:0.2.12 "/main" sandbox 26 seconds ago Up 25 seconds (health: starting)
103-
docker-ssrf_proxy-1 ubuntu/squid:latest "sh -c 'cp /docker-e…" ssrf_proxy 26 seconds ago Up 25 seconds 3128/tcp
104-
docker-weaviate-1 semitechnologies/weaviate:1.27.0 "/bin/weaviate --hos…" weaviate 26 seconds ago Up 25 seconds
105-
docker-web-1 langgenius/dify-web:1.10.1 "/bin/sh ./entrypoin…" web 26 seconds ago Up 25 seconds 3000/tcp
106-
docker-worker-1 langgenius/dify-api:1.10.1 "/bin/bash /entrypoi…" worker 26 seconds ago Up 22 seconds 5001/tcp
107-
docker-worker_beat-1 langgenius/dify-api:1.10.1 "/bin/bash /entrypoi…" worker_beat 26 seconds ago Up 22 seconds 5001/tcp
108-
```
78+
Each container should be in the `Up` or `healthy` status.
10979

11080
</Step>
11181
</Steps>

‎ja/self-host/deploy/quick-start/docker-compose.mdx‎

Lines changed: 7 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,10 @@ sidebarTitle: Docker Compose
3535
```bash
3636
git clone --branch "$(curl -s https://api.github.com/repos/langgenius/dify/releases/latest | jq -r .tag_name)" https://github.com/langgenius/dify.git
3737
```
38+
39+
<Info>
40+
このコマンドには `git`、`curl`、`jq` が必要です。`command not found` エラーが表示された場合は、不足しているツールをインストールしてから再実行してください。
41+
</Info>
3842
</Step>
3943
<Step title="Dify を起動">
4044

@@ -63,50 +67,17 @@ sidebarTitle: Docker Compose
6367

6468
以下のコンテナが起動します：
6569

66-
- 5 つのコアサービス：`api`、`worker`、`worker_beat`、`web`、`plugin_daemon`
70+
- 6 つのコアサービス：`api`、`api_websocket`、`worker`、`worker_beat`、`web`、`plugin_daemon`
6771
- 6 つの依存コンポーネント：`weaviate`、`db_postgres`、`redis`、`nginx`、`ssrf_proxy`、`sandbox`
68-
69-
各コンテナのステータスと起動時間を示す以下のような出力が表示されます：
70-
71-
```bash
72-
[+] Running 13/13
73-
✔ Network docker_ssrf_proxy_network Created 10.0s
74-
✔ Network docker_default Created 0.1s
75-
✔ Container docker-sandbox-1 Started 0.3s
76-
✔ Container docker-db_postgres-1 Healthy 2.8s
77-
✔ Container docker-web-1 Started 0.3s
78-
✔ Container docker-redis-1 Started 0.3s
79-
✔ Container docker-ssrf_proxy-1 Started 0.4s
80-
✔ Container docker-weaviate-1 Started 0.3s
81-
✔ Container docker-worker_beat-1 Started 3.2s
82-
✔ Container docker-api-1 Started 3.2s
83-
✔ Container docker-worker-1 Started 3.2s
84-
✔ Container docker-plugin_daemon-1 Started 3.2s
85-
✔ Container docker-nginx-1 Started 3.4s
86-
```
72+
- 1 つの一時タスク：`init_permissions`（ストレージのファイル権限を設定し、完了後に終了します。`Exited` と表示されるのは正常です）
8773

8874
4. すべてのコンテナが正常に動作しているか確認します：
8975

9076
```bash
9177
docker compose ps
9278
```
9379

94-
各コンテナのステータスが `Up` または `healthy` となっている、以下のような出力が表示されます：
95-
96-
```bash
97-
NAME IMAGE COMMAND SERVICE CREATED STATUS PORTS
98-
docker-api-1 langgenius/dify-api:1.10.1 "/bin/bash /entrypoi…" api 26 seconds ago Up 22 seconds 5001/tcp
99-
docker-db_postgres-1 postgres:15-alpine "docker-entrypoint.s…" db_postgres 26 seconds ago Up 25 seconds (healthy) 5432/tcp
100-
docker-nginx-1 nginx:latest "sh -c 'cp /docker-e…" nginx 26 seconds ago Up 22 seconds 0.0.0.0:80->80/tcp, :::80->80/tcp, 0.0.0.0:443->443/tcp, :::443->443/tcp
101-
docker-plugin_daemon-1 langgenius/dify-plugin-daemon:0.4.1-local "/bin/bash -c /app/e…" plugin_daemon 26 seconds ago Up 22 seconds 0.0.0.0:5003->5003/tcp, :::5003->5003/tcp
102-
docker-redis-1 redis:6-alpine "docker-entrypoint.s…" redis 26 seconds ago Up 25 seconds (health: starting) 6379/tcp
103-
docker-sandbox-1 langgenius/dify-sandbox:0.2.12 "/main" sandbox 26 seconds ago Up 25 seconds (health: starting)
104-
docker-ssrf_proxy-1 ubuntu/squid:latest "sh -c 'cp /docker-e…" ssrf_proxy 26 seconds ago Up 25 seconds 3128/tcp
105-
docker-weaviate-1 semitechnologies/weaviate:1.27.0 "/bin/weaviate --hos…" weaviate 26 seconds ago Up 25 seconds
106-
docker-web-1 langgenius/dify-web:1.10.1 "/bin/sh ./entrypoin…" web 26 seconds ago Up 25 seconds 3000/tcp
107-
docker-worker-1 langgenius/dify-api:1.10.1 "/bin/bash /entrypoi…" worker 26 seconds ago Up 22 seconds 5001/tcp
108-
docker-worker_beat-1 langgenius/dify-api:1.10.1 "/bin/bash /entrypoi…" worker_beat 26 seconds ago Up 22 seconds 5001/tcp
109-
```
80+
各コンテナのステータスが `Up` または `healthy` になっていれば正常です。
11081
</Step>
11182
</Steps>
11283

‎zh/self-host/deploy/quick-start/docker-compose.mdx‎

Lines changed: 7 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,10 @@ sidebarTitle: Docker Compose
3535
```bash
3636
git clone --branch "$(curl -s https://api.github.com/repos/langgenius/dify/releases/latest | jq -r .tag_name)" https://github.com/langgenius/dify.git
3737
```
38+
39+
<Info>
40+
此命令需要 `git`、`curl` 和 `jq`。如提示 `command not found`，安装缺少的工具后重新运行命令。
41+
</Info>
3842
</Step>
3943
<Step title="启动 Dify">
4044

@@ -63,50 +67,17 @@ sidebarTitle: Docker Compose
6367

6468
启动以下容器：
6569

66-
- 5 个核心服务：`api`、`worker`、`worker_beat`、`web`、`plugin_daemon`
70+
- 6 个核心服务：`api`、`api_websocket`、`worker`、`worker_beat`、`web`、`plugin_daemon`
6771
- 6 个依赖组件：`weaviate`、`db_postgres`、`redis`、`nginx`、`ssrf_proxy`、`sandbox`
68-
69-
应看到类似以下的输出，显示每个容器的状态和启动时间：
70-
71-
```bash
72-
[+] Running 13/13
73-
✔ Network docker_ssrf_proxy_network Created 10.0s
74-
✔ Network docker_default Created 0.1s
75-
✔ Container docker-sandbox-1 Started 0.3s
76-
✔ Container docker-db_postgres-1 Healthy 2.8s
77-
✔ Container docker-web-1 Started 0.3s
78-
✔ Container docker-redis-1 Started 0.3s
79-
✔ Container docker-ssrf_proxy-1 Started 0.4s
80-
✔ Container docker-weaviate-1 Started 0.3s
81-
✔ Container docker-worker_beat-1 Started 3.2s
82-
✔ Container docker-api-1 Started 3.2s
83-
✔ Container docker-worker-1 Started 3.2s
84-
✔ Container docker-plugin_daemon-1 Started 3.2s
85-
✔ Container docker-nginx-1 Started 3.4s
86-
```
72+
- 1 个一次性任务：`init_permissions`，用于设置存储文件权限，完成后自动退出（状态显示为 `Exited` 是正常的）
8773

8874
4. 验证所有容器是否成功运行：
8975

9076
```bash
9177
docker compose ps
9278
```
9379

94-
应看到类似以下的输出，每个容器的状态应为 `Up` 或 `healthy`：
95-
96-
```bash
97-
NAME IMAGE COMMAND SERVICE CREATED STATUS PORTS
98-
docker-api-1 langgenius/dify-api:1.10.1 "/bin/bash /entrypoi…" api 26 seconds ago Up 22 seconds 5001/tcp
99-
docker-db_postgres-1 postgres:15-alpine "docker-entrypoint.s…" db_postgres 26 seconds ago Up 25 seconds (healthy) 5432/tcp
100-
docker-nginx-1 nginx:latest "sh -c 'cp /docker-e…" nginx 26 seconds ago Up 22 seconds 0.0.0.0:80->80/tcp, :::80->80/tcp, 0.0.0.0:443->443/tcp, :::443->443/tcp
101-
docker-plugin_daemon-1 langgenius/dify-plugin-daemon:0.4.1-local "/bin/bash -c /app/e…" plugin_daemon 26 seconds ago Up 22 seconds 0.0.0.0:5003->5003/tcp, :::5003->5003/tcp
102-
docker-redis-1 redis:6-alpine "docker-entrypoint.s…" redis 26 seconds ago Up 25 seconds (health: starting) 6379/tcp
103-
docker-sandbox-1 langgenius/dify-sandbox:0.2.12 "/main" sandbox 26 seconds ago Up 25 seconds (health: starting)
104-
docker-ssrf_proxy-1 ubuntu/squid:latest "sh -c 'cp /docker-e…" ssrf_proxy 26 seconds ago Up 25 seconds 3128/tcp
105-
docker-weaviate-1 semitechnologies/weaviate:1.27.0 "/bin/weaviate --hos…" weaviate 26 seconds ago Up 25 seconds
106-
docker-web-1 langgenius/dify-web:1.10.1 "/bin/sh ./entrypoin…" web 26 seconds ago Up 25 seconds 3000/tcp
107-
docker-worker-1 langgenius/dify-api:1.10.1 "/bin/bash /entrypoi…" worker 26 seconds ago Up 22 seconds 5001/tcp
108-
docker-worker_beat-1 langgenius/dify-api:1.10.1 "/bin/bash /entrypoi…" worker_beat 26 seconds ago Up 22 seconds 5001/tcp
109-
```
80+
每个容器的状态应为 `Up` 或 `healthy`。
11081
</Step>
11182
</Steps>
11283

0 commit comments

Comments
 (0)