docs: update docker compose container list and add tool prerequisites (#843) (backport to release/1.15.0)#844
Open
RiskeyL wants to merge 1 commit into
Open
Conversation
…#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 (cherry picked from commit a81c306)
Contributor
There was a problem hiding this comment.
Pull request overview
Backports documentation updates from release/1.16.0 to release/1.15.0 for the Docker Compose quick start, aligning the described Compose services with current defaults and improving prerequisite guidance for the clone command.
Changes:
- Add an
<Info>callout noting thegit clonecommand requiresgit,curl, andjq, with guidance forcommand not found. - Update the “started containers” list to include
api_websocketand the one-timeinit_permissionstask. - Remove outdated example outputs for
docker compose up/docker compose psand replace with a brief status expectation statement.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| en/self-host/deploy/quick-start/docker-compose.mdx | Adds prerequisites info, updates container list, and simplifies verification output guidance. |
| zh/self-host/deploy/quick-start/docker-compose.mdx | Mirrors the English updates in the Chinese translation. |
| ja/self-host/deploy/quick-start/docker-compose.mdx | Mirrors the English updates in the Japanese translation. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| docker-worker-1 langgenius/dify-api:1.10.1 "/bin/bash /entrypoi…" worker 26 seconds ago Up 22 seconds 5001/tcp | ||
| docker-worker_beat-1 langgenius/dify-api:1.10.1 "/bin/bash /entrypoi…" worker_beat 26 seconds ago Up 22 seconds 5001/tcp | ||
| ``` | ||
| Each container should be in the `Up` or `healthy` status. |
| docker-worker-1 langgenius/dify-api:1.10.1 "/bin/bash /entrypoi…" worker 26 seconds ago Up 22 seconds 5001/tcp | ||
| docker-worker_beat-1 langgenius/dify-api:1.10.1 "/bin/bash /entrypoi…" worker_beat 26 seconds ago Up 22 seconds 5001/tcp | ||
| ``` | ||
| 每个容器的状态应为 `Up` 或 `healthy`。 |
| docker-worker-1 langgenius/dify-api:1.10.1 "/bin/bash /entrypoi…" worker 26 seconds ago Up 22 seconds 5001/tcp | ||
| docker-worker_beat-1 langgenius/dify-api:1.10.1 "/bin/bash /entrypoi…" worker_beat 26 seconds ago Up 22 seconds 5001/tcp | ||
| ``` | ||
| 各コンテナのステータスが `Up` または `healthy` になっていれば正常です。 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Backport
This will backport the following commits from
release/1.16.0torelease/1.15.0: