docs: adapt for the new start script#768
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
There was a problem hiding this comment.
Pull request overview
Updates the self-hosting documentation to reflect using the new Docker Compose “wrapper” start script instead of calling Docker Compose directly.
Changes:
- Replace manual
.envcopy +docker compose upinstructions withdify-compose/dify-compose.ps1wrapper commands. - Update environment variable reference to reflect wrapper-generated
SECRET_KEY. - Document
MAIL_TYPEas optional (empty disables email sending).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| en/self-host/quick-start/docker-compose.mdx | Switch quick-start commands to the new compose wrapper and update restart/upgrade guidance. |
| en/self-host/configuration/environments.mdx | Adjust documented defaults/behavior for SECRET_KEY and MAIL_TYPE, plus minor formatting. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
🌐 Multi-language Sync✅ Created sync PR #769 Synced 2 files to cn + jp Both PRs can merge independently. Future commits here will auto-update the sync PR. |
…eploy # Conflicts: # en/self-host/quick-start/docker-compose.mdx
|
@RiskeyL langgenius/dify#35708 is merged. This doc update is ready to merge. |
|
@Stream29 Thx. I'll handle the rest and complete the merge today. |
|
Hi @Stream29, a few things from my side:
|
|
@RiskeyL Thank you for the translation work!
|
|
@Stream29 I take the point that #35708 is merged into main, but the deployment guide pins the clone to the latest release tag (not main):
I just cloned the latest release in a fresh directory and confirmed docker/dify-compose, docker/dify-compose.ps1, and docker/.env.default are all missing. A user following the docs today would land on a clone without the wrapper script or .env.default, so the rest of the deployment steps would fail. Keeping the clone command pinned to the latest release is the right call (releases are stable, main isn't), so the cleanest path is to merge this docs PR alongside the release that ships #35708. Could you confirm which Dify version that will be? |
|
OK. I will announce you when I get further information. |
|
The next release date is estimated on next Mon. or Tue.. |
|
@RiskeyL According to langgenius/dify#35708 (comment), this PR needs update. |
| ```bash macOS/Linux/WSL | ||
| ./init-env.sh | ||
| ``` | ||
| ```powershell Windows PowerShell |
| .\init-env.ps1 | ||
| ``` | ||
| </CodeGroup> | ||
|
|
| ```powershell Windows PowerShell | ||
| .\init-env.ps1 | ||
| ``` | ||
| </CodeGroup> | ||
|
|
|
@RiskeyL according to langgenius/dify#31586, this PR |
No description provided.