Skip to content

docs: adapt for the new start script#768

Closed
Stream29 wants to merge 5 commits intorelease/1.14.1from
feat/easier-simpler-deploy
Closed

docs: adapt for the new start script#768
Stream29 wants to merge 5 commits intorelease/1.14.1from
feat/easier-simpler-deploy

Conversation

@Stream29
Copy link
Copy Markdown

No description provided.

@Stream29 Stream29 requested a review from RiskeyL as a code owner April 29, 2026 21:01
Copilot AI review requested due to automatic review settings April 29, 2026 21:01
@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented Apr 29, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
dify-core-product 🟢 Ready View Preview Apr 29, 2026, 9:03 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@dosubot dosubot Bot added the size:M This PR changes 30-99 lines, ignoring generated files. label Apr 29, 2026
@dosubot dosubot Bot added the documentation Improvements or additions to documentation label Apr 29, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 .env copy + docker compose up instructions with dify-compose / dify-compose.ps1 wrapper commands.
  • Update environment variable reference to reflect wrapper-generated SECRET_KEY.
  • Document MAIL_TYPE as 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.

Comment thread en/self-host/quick-start/docker-compose.mdx Outdated
Comment thread en/self-host/configuration/environments.mdx
Comment thread en/self-host/configuration/environments.mdx Outdated
@github-actions
Copy link
Copy Markdown
Contributor

🌐 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
@dosubot dosubot Bot added size:L This PR changes 100-499 lines, ignoring generated files. and removed size:M This PR changes 30-99 lines, ignoring generated files. labels May 4, 2026
@RiskeyL
Copy link
Copy Markdown
Contributor

RiskeyL commented May 6, 2026

#35708

@Stream29
Copy link
Copy Markdown
Author

Stream29 commented May 7, 2026

@RiskeyL langgenius/dify#35708 is merged. This doc update is ready to merge.

Copilot AI review requested due to automatic review settings May 7, 2026 09:23
@dosubot dosubot Bot added size:M This PR changes 30-99 lines, ignoring generated files. and removed size:L This PR changes 100-499 lines, ignoring generated files. labels May 7, 2026
@RiskeyL
Copy link
Copy Markdown
Contributor

RiskeyL commented May 7, 2026

@Stream29 Thx. I'll handle the rest and complete the merge today.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

Comment thread en/self-host/configuration/environments.mdx
@dosubot dosubot Bot added size:L This PR changes 100-499 lines, ignoring generated files. and removed size:M This PR changes 30-99 lines, ignoring generated files. labels May 7, 2026
@RiskeyL
Copy link
Copy Markdown
Contributor

RiskeyL commented May 7, 2026

Hi @Stream29, a few things from my side:

  • Translations: The auto-translation workflow has some issues right now, so I've manually translated the zh/ja docs in this PR. I'll close the associated auto-sync PR.

  • Doc updates after testing: I ran through the new deployment flow end-to-end and made some refinements: clearer first-run prompt walkthrough, exposition of the three-file model (.env, .env.default, .env.example), and the conditional MAIL_DEFAULT_SEND_FROM fix per Copilot feedback. Please take a look when you have a moment.

  • Release timing: The deployment guide directs users to clone the latest release tag, not main. The dify-compose script and .env.default from #35708 only become reachable for users once shipped in a release, so this docs PR's merge should align with that release. Could you confirm which version of Dify will include #35708?

@Stream29
Copy link
Copy Markdown
Author

Stream29 commented May 7, 2026

@RiskeyL Thank you for the translation work!

  • Your revision is reasonable and correct.
  • This document update has no relation with Dify CE releasing. As the PR chore: easier and simpler deploy dify#35708 is merged, the new deployment shorthand is available already.

@RiskeyL
Copy link
Copy Markdown
Contributor

RiskeyL commented May 7, 2026

@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):

git clone --branch "$(curl -s https://api.github.com/repos/langgenius/dify/releases/latest | jq -r .tag_name)" https://github.com/langgenius/dify.git

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?

@Stream29
Copy link
Copy Markdown
Author

Stream29 commented May 7, 2026

OK. I will announce you when I get further information.

@Stream29
Copy link
Copy Markdown
Author

Stream29 commented May 8, 2026

The next release date is estimated on next Mon. or Tue..

@Stream29
Copy link
Copy Markdown
Author

Stream29 commented May 8, 2026

@RiskeyL According to langgenius/dify#35708 (comment), this PR needs update.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.

```bash macOS/Linux/WSL
./init-env.sh
```
```powershell Windows PowerShell
.\init-env.ps1
```
</CodeGroup>

Comment on lines +53 to 57
```powershell Windows PowerShell
.\init-env.ps1
```
</CodeGroup>

@Stream29
Copy link
Copy Markdown
Author

Stream29 commented May 8, 2026

@RiskeyL according to langgenius/dify#31586, this PR
can be closed.

@Stream29 Stream29 closed this May 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size:L This PR changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants