Skip to content

docs: adapt for the new start script #768

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Stream29 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: adapt for the new start script #768

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4c87ba3
docs: adapt for the new start script
Stream29 Apr 29, 2026
e388eb4
Merge remote-tracking branch 'origin/main' into feat/easier-simpler-d…
Stream29 May 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions en/self-host/configuration/environments.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@ If you use your own reverse proxy, forward `Upgrade` and `Connection` headers on

### SECRET_KEY

Default: (pre-filled in `.env.example`; must be replaced for production)
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:
Comment on lines +144 to +146
Copy link

Copilot AI Apr 29, 2026

Choose a reason for hiding this comment

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

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/...).

Copilot uses AI. Check for mistakes.

```bash
openssl rand -base64 42
Expand Down Expand Up @@ -1046,7 +1046,7 @@ Dify sends emails for account invitations, password resets, login codes, and Hum

| Variable | Default | Description |
|---|---|---|
| `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. |
Copy link

Copilot AI Apr 29, 2026

Choose a reason for hiding this comment

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

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.

Suggested change
| `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. |

Copilot uses AI. Check for mistakes.

<AccordionGroup>
Expand Down Expand Up @@ -1614,4 +1614,4 @@ The plugin daemon can store plugin packages in different storage backends. Confi
| `PLUGIN_VOLCENGINE_TOS_REGION` | (empty) | Volcengine TOS region. |

</Accordion>
</AccordionGroup>
</AccordionGroup>
67 changes: 41 additions & 26 deletions en/self-host/quick-start/docker-compose.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ Make sure your machine meets the following minimum system requirements.
| Linux distributions | Docker 19.03+<br></br><br></br>Docker Compose 1.28+ | For installation instructions, see [Install Docker Engine](https://docs.docker.com/engine/install/) and [Install Docker Compose](https://docs.docker.com/compose/install/). |
| Windows with WSL 2 enabled | Docker Desktop | Store source code and data bound to Linux containers in the Linux file system rather than Windows. <br></br><br></br>For installation instructions, see [Install Docker Desktop on Windows](https://docs.docker.com/desktop/windows/install/#wsl-2-backend). |


## Deploy and Start

<Steps>
Expand All @@ -34,6 +33,7 @@ Make sure your machine meets the following minimum system requirements.
```bash
git clone --branch "$(curl -s https://api.github.com/repos/langgenius/dify/releases/latest | jq -r .tag_name)" https://github.com/langgenius/dify.git
```

</Step>
<Step title="Start Dify">

Expand All @@ -42,27 +42,24 @@ Make sure your machine meets the following minimum system requirements.
```bash
cd dify/docker
```

2. Copy the example environment configuration file:

```bash
cp .env.example .env
```

3. Start the containers using the command that matches your Docker Compose version:
2. Start the containers:

<CodeGroup>
```bash Docker Compose V2
docker compose up -d

```bash macOS / Linux / WSL
./dify-compose up -d
```
```bash Docker Compose V1
docker-compose up -d

```powershell Windows PowerShell
.\dify-compose.ps1 up -d
```

</CodeGroup>

<Tip>
Run `docker compose version` to check your Docker Compose version.
</Tip>
<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.
</Note>

The following containers will be started:

Expand All @@ -87,12 +84,20 @@ Make sure your machine meets the following minimum system requirements.
✔ Container docker-plugin_daemon-1 Started 3.2s
✔ Container docker-nginx-1 Started 3.4s
```

4. Verify that all containers are running successfully:

```bash
docker compose ps
```
3. Verify that all containers are running successfully:

<CodeGroup>

```bash macOS / Linux / WSL
./dify-compose ps
```

```powershell Windows PowerShell
.\dify-compose.ps1 ps
```

</CodeGroup>

You should see output similar to the following, with each container in the `Up` or `healthy` status:

Expand All @@ -110,6 +115,7 @@ Make sure your machine meets the following minimum system requirements.
docker-worker-1 langgenius/dify-api:1.10.1 "/bin/bash /entrypoi…" worker 26 seconds ago Up 22 seconds 5001/tcp
docker-worker_beat-1 langgenius/dify-api:1.10.1 "/bin/bash /entrypoi…" worker_beat 26 seconds ago Up 22 seconds 5001/tcp
```

</Step>
</Steps>

Expand Down Expand Up @@ -139,10 +145,19 @@ Make sure your machine meets the following minimum system requirements.

Modify the environment variable values in your local `.env` file, then restart Dify to apply the changes:

```bash
docker compose down
docker compose up -d
```
<CodeGroup>

```bash macOS / Linux / WSL
./dify-compose down
./dify-compose up -d
```

```powershell Windows PowerShell
.\dify-compose.ps1 down
.\dify-compose.ps1 up -d
```

</CodeGroup>

<Tip>
For more information, see [environment variables](/en/self-host/configuration/environments).
Expand All @@ -154,6 +169,6 @@ Upgrade steps may vary between releases. Refer to the upgrade guide for your tar

<Note>

After upgrading, check whether the `.env.example` file has changed and update your local `.env` file accordingly.
After upgrading, review changes to `.env.default` and `.env.example`. Keep only local overrides in `.env`.

</Note>
</Note>
1 change: 1 addition & 0 deletions en/self-host/quick-start/faqs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ unzip dify.zip && rm dify.zip
Alternatively, download the ZIP on another device and transfer it manually.

**To upgrade**:

```bash
wget -O dify-latest.zip "$(curl -s https://api.github.com/repos/langgenius/dify/releases/latest | jq -r '.zipball_url')"
unzip dify-latest.zip && rm dify-latest.zip
Expand Down
21 changes: 13 additions & 8 deletions ja/self-host/quick-start/docker-compose.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ sidebarTitle: Docker Compose

### ソフトウェア

| オペレーティングシステム | 必要なソフトウェア | 備考 |
| :----------------------------- | :---------------------------------------- | :----- |
| macOS 10.14 以降 | Docker Desktop | Docker 仮想マシンを最低 2 つの仮想 CPU と 8 GiB のメモリで設定してください。<br></br><br></br>インストール手順については、[Mac 用 Docker Desktop のインストール](https://docs.docker.com/desktop/mac/install/) を参照してください。 |
| Linux ディストリビューション | Docker 19.03+<br></br><br></br>Docker Compose 1.28+ | インストール手順については、[Docker Engine のインストール](https://docs.docker.com/engine/install/) および [Docker Compose のインストール](https://docs.docker.com/compose/install/) を参照してください。 |
| WSL 2 が有効な Windows | Docker Desktop | Linux コンテナにバインドされるソースコードやデータは、Windows ファイルシステムではなく、Linux ファイルシステムに保存してください。<br></br><br></br>インストール手順については、[Windows 用 Docker Desktop のインストール](https://docs.docker.com/desktop/windows/install/#wsl-2-backend) を参照してください。 |
| オペレーティングシステム | 必要なソフトウェア | 備考 |
| :--- | :--- | :--- |
| macOS 10.14 以降 | Docker Desktop | 2 vCPU 以上、8 GiB 以上のメモリを割り当てます。<br></br><br></br>手順は [Mac 用 Docker Desktop のインストール](https://docs.docker.com/desktop/mac/install/) を参照してください。 |
| Linux | Docker 19.03+ / Docker Compose 1.28+ | 手順は以下を参照してください。<br></br><br></br>[Docker Engine のインストール](https://docs.docker.com/engine/install/) / [Docker Compose のインストール](https://docs.docker.com/compose/install/) |
| Windows (WSL 2) | Docker Desktop | ソースコードとデータは Linux ファイルシステムに保存します。<br></br><br></br>手順は [Windows 用 Docker Desktop のインストール](https://docs.docker.com/desktop/windows/install/#wsl-2-backend) を参照してください。 |

## デプロイと起動

Expand All @@ -35,6 +35,7 @@ sidebarTitle: Docker Compose
```bash
git clone --branch "$(curl -s https://api.github.com/repos/langgenius/dify/releases/latest | jq -r .tag_name)" https://github.com/langgenius/dify.git
```

</Step>
<Step title="Dify を起動">

Expand All @@ -43,7 +44,7 @@ sidebarTitle: Docker Compose
```bash
cd dify/docker
```

2. 環境設定ファイルの例をコピーします：

```bash
Expand All @@ -53,12 +54,15 @@ sidebarTitle: Docker Compose
3. お使いの Docker Compose バージョンに合わせたコマンドでコンテナを起動します：

<CodeGroup>

```bash Docker Compose V2
docker compose up -d
```

```bash Docker Compose V1
docker-compose up -d
```

</CodeGroup>

<Tip>
Expand Down Expand Up @@ -88,7 +92,7 @@ sidebarTitle: Docker Compose
✔ Container docker-plugin_daemon-1 Started 3.2s
✔ Container docker-nginx-1 Started 3.4s
```

4. すべてのコンテナが正常に動作しているか確認します：

```bash
Expand All @@ -111,6 +115,7 @@ sidebarTitle: Docker Compose
docker-worker-1 langgenius/dify-api:1.10.1 "/bin/bash /entrypoi…" worker 26 seconds ago Up 22 seconds 5001/tcp
docker-worker_beat-1 langgenius/dify-api:1.10.1 "/bin/bash /entrypoi…" worker_beat 26 seconds ago Up 22 seconds 5001/tcp
```

</Step>
</Steps>

Expand Down Expand Up @@ -157,4 +162,4 @@ docker compose up -d

アップグレード後、`.env.example` ファイルが変更されているかどうかを確認し、それに応じてローカルの `.env` ファイルを更新してください。

</Note>
</Note>
1 change: 1 addition & 0 deletions ja/self-host/quick-start/faqs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ unzip dify.zip && rm dify.zip
または、別のデバイスで ZIP をダウンロードして手動で転送することもできます。

**アップグレードするには**：

```bash
wget -O dify-latest.zip "$(curl -s https://api.github.com/repos/langgenius/dify/releases/latest | jq -r '.zipball_url')"
unzip dify-latest.zip && rm dify-latest.zip
Expand Down
12 changes: 8 additions & 4 deletions zh/self-host/quick-start/docker-compose.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ sidebarTitle: Docker Compose
| Linux 平台 | Docker 19.03+<br></br><br></br>Docker Compose 1.28+ | 安装说明请参阅 [Docker 引擎安装指南](https://docs.docker.com/engine/install/) 和 [Docker Compose 安装指南](https://docs.docker.com/compose/install/)。 |
| 启用了 WSL 2 的 Windows | Docker Desktop | 建议将源代码和绑定到 Linux 容器的数据存储在 Linux 文件系统中，而不是 Windows 文件系统中。<br></br><br></br>安装说明请参阅 [Windows 版 Docker Desktop 安装指南](https://docs.docker.com/desktop/windows/install/#wsl-2-backend)。 |


## 部署并启动

<Steps>
Expand All @@ -36,6 +35,7 @@ sidebarTitle: Docker Compose
```bash
git clone --branch "$(curl -s https://api.github.com/repos/langgenius/dify/releases/latest | jq -r .tag_name)" https://github.com/langgenius/dify.git
```

</Step>
<Step title="启动 Dify">

Expand All @@ -44,7 +44,7 @@ sidebarTitle: Docker Compose
```bash
cd dify/docker
```

2. 复制示例环境配置文件：

```bash
Expand All @@ -54,12 +54,15 @@ sidebarTitle: Docker Compose
3. 根据你的 Docker Compose 版本选择相应命令启动容器：

<CodeGroup>

```bash Docker Compose V2
docker compose up -d
```

```bash Docker Compose V1
docker-compose up -d
```

</CodeGroup>

<Tip>
Expand Down Expand Up @@ -89,7 +92,7 @@ sidebarTitle: Docker Compose
✔ Container docker-plugin_daemon-1 Started 3.2s
✔ Container docker-nginx-1 Started 3.4s
```

4. 验证所有容器是否成功运行：

```bash
Expand All @@ -112,6 +115,7 @@ sidebarTitle: Docker Compose
docker-worker-1 langgenius/dify-api:1.10.1 "/bin/bash /entrypoi…" worker 26 seconds ago Up 22 seconds 5001/tcp
docker-worker_beat-1 langgenius/dify-api:1.10.1 "/bin/bash /entrypoi…" worker_beat 26 seconds ago Up 22 seconds 5001/tcp
```

</Step>
</Steps>

Expand Down Expand Up @@ -158,4 +162,4 @@ docker compose up -d

升级后，请检查 `.env.example` 文件是否有变更，并相应更新你的本地 `.env` 文件。

</Note>
</Note>
1 change: 1 addition & 0 deletions zh/self-host/quick-start/faqs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ unzip dify.zip && rm dify.zip
或者，在另一台设备上下载 ZIP 文件并手动传输。

**升级方法**：

```bash
wget -O dify-latest.zip "$(curl -s https://api.github.com/repos/langgenius/dify/releases/latest | jq -r '.zipball_url')"
unzip dify-latest.zip && rm dify-latest.zip
Expand Down
Loading