Repository navigation
docs: describe docker setup and configuration - #1171
Merged
RiskeyL merged 13 commits intoNov 4, 2026
Merged
Conversation
Update the Docker Compose, environment-variable, and Dify Premium pages in English, Chinese, and Japanese for the categorized defaults layout in langgenius/dify#45359. Explain root and service override precedence, shared credential placement, mapped inputs, and Docker Compose requirements. Preserve working configuration during upgrades and identify values that now become effective.
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
2 tasks done
Point sandbox and Code node customization to the current defaults templates in English, Chinese, and Japanese. Explain copying new overrides, editing existing files, and uncommenting optional assignments. Document preserved shared.env paths and cleanup of accidental empty Celery worker overrides when upgrading to the consolidated shared defaults.
Clarify Docker Compose setup, optional service overrides, precedence, and configuration application across English, Chinese, and Japanese guides. Use current-state explanations and a complete Nginx customization example. Correct secret-key persistence, sandbox behavior, Code limits, WebSocket setup, and bundled credential defaults. Preserve upgrade guidance for local overrides, persistent storage, and the agent's named volumes. Remove the AWS AMI additions from this PR because its packaging is not established by the companion Docker configuration change.
laipz8200
changed the title
Update Docker setup and environment references in English, Chinese, and Japanese to use api-worker.defaults and api-worker.env. Explain continued shared.env support and the precedence of the new file, and retain upgrade instructions for both existing and new override paths.
Update the Premium deployment guide in English, Chinese, and Japanese to use the current defaults templates and Docker Compose 2.35.0. Upgrade from a selected release while preserving local environment files, AWS Compose overrides, secrets, and persistent data. Replace outdated Agent template-sync advice with explicit override checks and web container recreation. Document the unset and empty true fallback from web.defaults, root precedence, and current navigation visibility.
2 tasks done
RiskeyL
reviewed
Nov 3, 2026
RiskeyL
left a comment
RiskeyL
left a comment
Contributor
There was a problem hiding this comment.
Fact-checked the three pages against dify dc36c3eb44 and tested the database/vector-store switch and the sandbox key on a local stack. The inline comments are factual issues; each applies to the zh and ja pages too.
RiskeyL
requested changes
Nov 3, 2026
This was referenced Nov 3, 2026
Bundled vector stores miss client defaults and Agent sandbox token can diverge
langgenius/dify#45405
Closed
Describe automatic bundled provider defaults and preserve the existing override workflow in English, Chinese, and Japanese. Clarify root Agent sandbox token placement, matching Code sandbox credentials, and architecture-independent network request restrictions.
Describe complete MySQL inputs, shared credential pairs, root override boundaries, middleware paths, and legacy variable replacements. Identify actual sandbox backup volumes and explain Code sandbox network reachability in English, Chinese, and Japanese.
Clarify provider selection, optional template copying, unchanged container mappings, and preservation of configured or stored keys without altering the English guidance.
Load middleware.env explicitly when managing Weaviate in the source-development stack. Document the Compose file and project options before the first command, and retain the existing project name across upgrades. Keep the English, Chinese, and Japanese migration instructions aligned.
Document OpenSearch certificate verification as enabled by default, require an explicit local demo-certificate opt-out, and explain that saved false overrides survive an upgrade. Preserve connections and Compose profiles for existing vector backends when choosing a new default. Explain legacy Weaviate fallbacks and continued provider override loading, with matching English, Chinese, and Japanese guidance.
Keep the first run to three steps and a sign-in, and give production hardening its own Secure the Deployment section. Cut Customize down to where settings go, how to apply them, and the Nginx worked example, and point to Environment Variables for vector stores, databases, and precedence. Keep Upgrade version-independent: back up (stop first, include named volumes), check out, review configuration, apply. Translate the restructured page into Chinese and Japanese.
Rewrite Configuration Files around finding the file for a variable, editing it, and applying the change, with a precedence order per service type. Say each rule once: drop the repeated precedence, keep-in-use, and sandbox-key reminders from the variable sections. Correct facts found in review: VECTOR_STORE switching steps (copy a non-Weaviate provider's defaults before switching, OceanBase and seekdb share settings), tidb_vector, client credentials that follow the bundled server settings, OpenSearch AWS defaults, Sentry inputs versus container variables, the agent stub URL exposure, and the DB_PLUGIN_DATABASE row's section. Drop shared.env notes, which move to the release notes. Carry the changes into Chinese and Japanese.
Contributor
|
@laipz8200 I pushed three commits to this branch: the quick start is restructured (a short first run, a separate Secure the Deployment section, a shorter Customize, and a version-independent Upgrade), Configuration Files is rewritten with the variable sections trimmed to match, and a few facts are corrected after another check against the code. Please pull before pushing again. For the quick start's Upgrade section, I kept only the version-independent steps. Could the 1.19.0 release notes carry the version-specific upgrade items?
Three smaller things:
|
RiskeyL
approved these changes
Nov 4, 2026
RiskeyL
added a commit
that referenced
this pull request
Nov 4, 2026
* docs: rename the agent knowledge section to Knowledge Retrieval in the glossary (#1172) * docs: sync self-host docs for ce 1.19.0 (#1170) * docs: add knowledge retrieval to the self-host agent build page * fix: describe the structured output fallback on the self-host llm page * docs: cover workflows bundled in app packages for 1.19.0 * docs: document the ops_trace_v2 queue and trace delivery settings * docs: add the gunicorn keep-alive variable * docs: add the plugin daemon uv cache directory variable * docs: update service api error codes and parameters for 1.19.0 * docs: add workspace skill commands to the cli reference * docs: list what disabling the marketplace hides in the console * docs: note the one-second limit of the skill import draft hash * docs: describe the skill import draft hash as a guard, not a guarantee * docs: shorten the skill package limit row in cli troubleshooting * docs: say which versions can import an app package exported from 1.19.0 * docs: note that include_all no longer filters the knowledge base list * docs: drop the outdated agents switch cause from the agent build page * Revert "docs: drop the outdated agents switch cause from the agent build page" This reverts commit f0e2252. dify-docs#1171 rewrites the same accordion for the new Docker configuration layout. * docs: allow null workflow inputs in the service api schema * docs: update cli stop run and get run event for run ids (#1146) * docs: update cli stop run and get run event for run ids * docs: say how to tell a stopped run or reply in cli stop docs * docs: correct the cli stop run docs against the 1.19.0 code * docs: restructure the cli stop sections to match the run apps page * docs: keep one example of a destructive command label * docs: split the incomplete and failed result bullets * docs: check the run state before handling run_not_stoppable * docs: limit the run_not_stoppable workaround to paused runs --------- Co-authored-by: RiskeyL <7a8y@163.com> * docs: name the plugin daemon version the 1.19.0 compose file ships (#1173) * docs: describe docker setup and configuration (#1171) * docs: align docker configuration and upgrade guidance Update the Docker Compose, environment-variable, and Dify Premium pages in English, Chinese, and Japanese for the categorized defaults layout in langgenius/dify#45359. Explain root and service override precedence, shared credential placement, mapped inputs, and Docker Compose requirements. Preserve working configuration during upgrades and identify values that now become effective. * docs: align shared defaults and code node configuration Point sandbox and Code node customization to the current defaults templates in English, Chinese, and Japanese. Explain copying new overrides, editing existing files, and uncommenting optional assignments. Document preserved shared.env paths and cleanup of accidental empty Celery worker overrides when upgrading to the consolidated shared defaults. * docs: describe current docker configuration workflow Clarify Docker Compose setup, optional service overrides, precedence, and configuration application across English, Chinese, and Japanese guides. Use current-state explanations and a complete Nginx customization example. Correct secret-key persistence, sandbox behavior, Code limits, WebSocket setup, and bundled credential defaults. Preserve upgrade guidance for local overrides, persistent storage, and the agent's named volumes. Remove the AWS AMI additions from this PR because its packaging is not established by the companion Docker configuration change. * docs: name api and worker configuration files explicitly Update Docker setup and environment references in English, Chinese, and Japanese to use api-worker.defaults and api-worker.env. Explain continued shared.env support and the precedence of the new file, and retain upgrade instructions for both existing and new override paths. * docs: correct premium upgrades and agent visibility guidance Update the Premium deployment guide in English, Chinese, and Japanese to use the current defaults templates and Docker Compose 2.35.0. Upgrade from a selected release while preserving local environment files, AWS Compose overrides, secrets, and persistent data. Replace outdated Agent template-sync advice with explicit override checks and web container recreation. Document the unset and empty true fallback from web.defaults, root precedence, and current navigation visibility. * docs: align bundled vector stores and sandbox configuration Describe automatic bundled provider defaults and preserve the existing override workflow in English, Chinese, and Japanese. Clarify root Agent sandbox token placement, matching Code sandbox credentials, and architecture-independent network request restrictions. * docs: clarify docker configuration and backup behavior Describe complete MySQL inputs, shared credential pairs, root override boundaries, middleware paths, and legacy variable replacements. Identify actual sandbox backup volumes and explain Code sandbox network reachability in English, Chinese, and Japanese. * docs: refine translated configuration instructions Clarify provider selection, optional template copying, unchanged container mappings, and preservation of configured or stored keys without altering the English guidance. * docs: preserve middleware config in weaviate commands Load middleware.env explicitly when managing Weaviate in the source-development stack. Document the Compose file and project options before the first command, and retain the existing project name across upgrades. Keep the English, Chinese, and Japanese migration instructions aligned. * docs: explain secure vector store upgrades Document OpenSearch certificate verification as enabled by default, require an explicit local demo-certificate opt-out, and explain that saved false overrides survive an upgrade. Preserve connections and Compose profiles for existing vector backends when choosing a new default. Explain legacy Weaviate fallbacks and continued provider override loading, with matching English, Chinese, and Japanese guidance. * docs: restructure the docker compose quick start Keep the first run to three steps and a sign-in, and give production hardening its own Secure the Deployment section. Cut Customize down to where settings go, how to apply them, and the Nginx worked example, and point to Environment Variables for vector stores, databases, and precedence. Keep Upgrade version-independent: back up (stop first, include named volumes), check out, review configuration, apply. Translate the restructured page into Chinese and Japanese. * docs: rewrite configuration files guidance and tighten env var sections Rewrite Configuration Files around finding the file for a variable, editing it, and applying the change, with a precedence order per service type. Say each rule once: drop the repeated precedence, keep-in-use, and sandbox-key reminders from the variable sections. Correct facts found in review: VECTOR_STORE switching steps (copy a non-Weaviate provider's defaults before switching, OceanBase and seekdb share settings), tidb_vector, client credentials that follow the bundled server settings, OpenSearch AWS defaults, Sentry inputs versus container variables, the agent stub URL exposure, and the DB_PLUGIN_DATABASE row's section. Drop shared.env notes, which move to the release notes. Carry the changes into Chinese and Japanese. * docs: restore the workspace role note in agent troubleshooting --------- Co-authored-by: RiskeyL <7a8y@163.com> * docs: fix the skill draft-hash order and stop weaviate gracefully before backup (#1176) * docs: read the skill draft hash before merging an export After draft_changed, read the new draft_hash with describe skill before exporting and merging, then import with that saved hash. Reading it after the merge could pick up a later edit and overwrite it. * docs: stop weaviate gracefully before an upgrade backup Stop the deployment with docker compose stop -t -1, so Compose doesn't force Weaviate down after its 10-second default and lose data. --------- Co-authored-by: Stephen Zhou <hi@hyoban.cc> Co-authored-by: Xiyuan Chen <52963600+GareArc@users.noreply.github.com> Co-authored-by: -LAN- <laipz8200@outlook.com>
This branch was successfully deployed
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.
Describe Docker Compose setup and customization with a minimal root
.env.example, automatically loaded service defaults, and local.envoverrides. New deployments copy the root template, generate the required Agent local sandbox token, and start withdocker compose up -d.Document the selected bundled vector store's automatic connection defaults and matching Compose profile. Explain provider overrides, external connection settings, and root
.envprecedence. Use the current Milvus, MyScale, MatrixOne, and Vastbase.defaultstemplates while preserving their existing.envpaths.Keep common API and worker settings in
api-worker.defaultsandapi-worker.env. Existingshared.envoverrides remain supported. Explain blank overrides, shared plugin credentials, and how to apply configuration changes without replacing existing secrets or persistent data.Keep the user-generated Agent local sandbox token in root
.env, shared by the Agent backend and local sandbox. Explain how to move an existing service-file token without changing its value. Document the separate Code sandbox's matching credentials and the networking requirement for Code nodes, Template nodes, Jinja2 prompts, and the built-in Code tool.Update the Docker Compose guide, environment-variable reference, Premium deployment guide, Code node deployment guidance, and Agent troubleshooting in English, Chinese, and Japanese. The Premium guide requires Compose 2.35.0 or later and uses templates from the selected release. Agent troubleshooting explains the
web.defaultstrue fallback and explicitNEXT_PUBLIC_ENABLE_AGENT_V2=falseoverrides.Aligns with langgenius/dify#45359, langgenius/dify#45376, and langgenius/dify#45407. Related to langgenius/dify#45358 and langgenius/dify#45405.