Skip to content

docs(readme): update docker quick start requirements - #45394

Merged
41tair merged 1 commit into
mainfrom
laipz8200/readme-docker-quick-start
Nov 3, 2026
Merged

41tair merged 1 commit into
mainfrom
laipz8200/readme-docker-quick-start

Conversation

@laipz8200

Copy link
Copy Markdown
Member

Summary

The root README still recommends Compose 2.24.0 and starts services before setting the required local Agent sandbox token. Update the quick start to require Compose 2.35.0 and OpenSSL, generate the token, and set DIFY_AGENT_LOCAL_SANDBOX_AUTH_TOKEN before running docker compose up -d.

Clarify that commands start from the repository root and that bundled service defaults load automatically. Add the service-status command and expected init_permissions exit, and link to the Docker guide for customization and upgrades that preserve existing .env files.

Documentation follow-up to #45359 and #45376. Related to #45358 and langgenius/dify-docs#1171.

Checklist

  • The existing configuration issue and related documentation work are linked above.
  • The root README quick start is updated to match the Docker deployment workflow.

Raise the documented Compose minimum to 2.35.0 and include OpenSSL and
the required local Agent sandbox token before starting services.

Clarify the repository-root starting directory, automatic service defaults,
and the expected init_permissions exit. Preserve existing environment
files by linking to the Docker upgrade and customization instructions.
@github-actions github-actions Bot added the size:S This PR changes 10-29 lines, ignoring generated files. label Nov 3, 2026
@laipz8200
laipz8200 marked this pull request as ready for review November 3, 2026 05:43
@laipz8200
laipz8200 requested a review from crazywoola as a code owner November 3, 2026 05:43
@41tair
41tair added this pull request to the merge queue Nov 3, 2026
Merged via the queue into main with commit eef50ad Nov 3, 2026
39 checks passed
@41tair
41tair deleted the laipz8200/readme-docker-quick-start branch November 3, 2026 06:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:S This PR changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants