Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
dosubot
Bot
added
the
size:M
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.
| <Note> | ||
| The wrapper creates `.env` if one does not exist and writes a generated `SECRET_KEY` to it. Press Enter to use the default deployment, or answer `y` to edit `.env` first. Use `.env.example` as the full environment variable reference. | ||
|
|
||
| <Tip> | ||
| Run `docker compose version` to check your Docker Compose version. | ||
| </Tip> | ||
| When the frontend and backend run on different subdomains, set `COOKIE_DOMAIN` to the site's top-level domain (e.g., `example.com`) and set `NEXT_PUBLIC_COOKIE_DOMAIN` to `1` in the `.env` file. | ||
|
|
||
| The frontend and backend must be under the same top-level domain to share authentication cookies. | ||
| </Note> |
There was a problem hiding this comment.
The note says to use .env.example as the environment variable reference, but later the upgrade guidance tells users to review changes to .env.default as well. This introduces a new file concept without explaining what .env.default is (baseline defaults vs. example reference) or how users should merge/override values between .env.default, .env.example, and their local .env. Consider briefly defining each file’s role here and recommending a single upgrade workflow (e.g., which files to diff/compare, and whether .env should contain only overrides plus the generated SECRET_KEY).
| |---|---|---| | ||
| | `MAIL_TYPE` | `resend` | Mail provider: `resend`, `smtp`, or `sendgrid`. | | ||
| | `MAIL_TYPE` | (empty) | Mail provider: `resend`, `smtp`, or `sendgrid`. Leave empty to disable email sending. | | ||
| | `MAIL_DEFAULT_SEND_FROM` | (empty) | Default "From" address for all outgoing emails. Required. | |
There was a problem hiding this comment.
MAIL_TYPE is now documented as optional/empty to disable email sending, but MAIL_DEFAULT_SEND_FROM is still described as “Required.” This is ambiguous—if email is disabled, it likely shouldn’t be required. Suggest clarifying that MAIL_DEFAULT_SEND_FROM is required only when MAIL_TYPE is set (and possibly per-provider requirements), or otherwise explain why it must always be set even when MAIL_TYPE is empty.
| | `MAIL_DEFAULT_SEND_FROM` | (empty) | Default "From" address for all outgoing emails. Required. | | |
| | `MAIL_DEFAULT_SEND_FROM` | (empty) | Default "From" address for all outgoing emails. Required when `MAIL_TYPE` is set. | |
| Default: generated into `.env` by the Docker Compose wrapper. | ||
|
|
||
| Used for session cookie signing, JWT authentication tokens, file URL signatures (HMAC-SHA256), and encrypting third-party OAuth credentials (AES-256). Generate a strong key before first launch: | ||
| Used for session cookie signing, JWT authentication tokens, file URL signatures (HMAC-SHA256), and encrypting third-party OAuth credentials (AES-256). The Docker Compose wrapper generates a strong key before first launch. For manual deployments, generate one with: |
There was a problem hiding this comment.
This update changes the documented defaults/behavior for SECRET_KEY (generated by wrapper) and MAIL_TYPE (empty disables email) in English, but the corresponding JA/ZH environment docs still describe the previous defaults (e.g., JA/ZH SECRET_KEY says pre-filled in .env.example; JA/ZH MAIL_TYPE default resend). To avoid inconsistent guidance across locales, please update the translated pages (e.g., ja/self-host/configuration/environments.mdx around the SECRET_KEY section and mail table, and the same sections in zh/...).
🌐 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
Bot
added
size:L
No description provided.