Skip to content

Commit 4ced86f

Browse files
authored
docs: move cookie-domain guidance to troubleshooting faq (#770)
1 parent fa3e219 commit 4ced86f

6 files changed

Lines changed: 86 additions & 49 deletions

File tree

en/self-host/quick-start/docker-compose.mdx

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,6 @@ Make sure your machine meets the following minimum system requirements.
4848
```bash
4949
cp .env.example .env
5050
```
51-
<Note>
52-
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.
53-
54-
The frontend and backend must be under the same top-level domain to share authentication cookies.
55-
</Note>
5651

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

@@ -144,7 +139,7 @@ Make sure your machine meets the following minimum system requirements.
144139

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

147-
```
142+
```bash
148143
docker compose down
149144
docker compose up -d
150145
```

en/self-host/quick-start/faqs.mdx

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: FAQs
44

55
## Deployment Methods
66

7-
### Install older version
7+
### Install Older Version
88

99
Use the `--branch` flag to install a specific version:
1010

@@ -14,7 +14,7 @@ git clone https://github.com/langgenius/dify.git --branch 0.15.3
1414

1515
The rest of the setup is identical to installing the latest version.
1616

17-
### Install using ZIP archive
17+
### Install Using ZIP Archive
1818

1919
For network-restricted environments or when git is unavailable:
2020

@@ -39,7 +39,7 @@ docker compose up -d
3939

4040
## Backup Procedures
4141

42-
### Create backup before upgrading
42+
### Create Backup Before Upgrading
4343

4444
Always backup before upgrading to prevent data loss:
4545

@@ -48,3 +48,21 @@ cp -r dify "dify.bak.$(date +%Y%m%d%H%M%S)"
4848
```
4949

5050
This creates a timestamped backup for easy restoration.
51+
52+
## Reverse Proxy Setup
53+
54+
### Login Session Drops with Split Frontend and Backend Subdomains
55+
56+
If you have split web and API across subdomains behind a reverse proxy (for example, `app.example.com` for the UI and `api.example.com` for the backend), authentication cookies cannot reach both hosts. Login appears to succeed, but the session is dropped on the next request.
57+
58+
Set both variables in `.env`, then restart Dify:
59+
60+
- **`COOKIE_DOMAIN`**: set to the shared top-level domain (e.g., `example.com`). Leading dots are optional.
61+
- **`NEXT_PUBLIC_COOKIE_DOMAIN`**: set to `1` to enable cross-subdomain cookies on the frontend.
62+
63+
```bash
64+
docker compose down
65+
docker compose up -d
66+
```
67+
68+
Cookies cannot cross top-level domains, so the frontend and backend must share the same registrable domain. For full details, see [environment variables](/en/self-host/configuration/environments).

ja/self-host/quick-start/docker-compose.mdx

Lines changed: 23 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
title: Docker ComposeでDifyをデプロイする
2+
title: Docker Compose で Dify をデプロイする
33
sidebarTitle: Docker Compose
44
---
55

66
<Note> ⚠️ このドキュメントは AI によって自動翻訳されています。不正確な部分がある場合は、[英語版](/en/self-host/quick-start/docker-compose) を参照してください。</Note>
77

88
<Tip>
9-
一般的なデプロイに関する質問については、[FAQ](/ja/self-host/quick-start/faqs)を参照してください。
9+
一般的なデプロイに関する質問については、[FAQ](/ja/self-host/quick-start/faqs) を参照してください。
1010
</Tip>
1111

1212
## デプロイ前の準備
@@ -15,31 +15,30 @@ sidebarTitle: Docker Compose
1515

1616
### ハードウェア
1717

18-
- CPU >= 2コア
18+
- CPU >= 2 コア
1919
- RAM >= 4 GiB
2020

2121
### ソフトウェア
2222

23-
| オペレーティングシステム | 必要なソフトウェア | 備考 |
24-
| :----------------------------- | :---------------------------------------- | :----- |
25-
| macOS 10.14以降 | Docker Desktop | Docker仮想マシンを最低2つの仮想CPUと8 GiBのメモリで設定してください。<br></br><br></br>インストール手順については、[Mac用Docker Desktopのインストール](https://docs.docker.com/desktop/mac/install/)を参照してください。 |
26-
| 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/)を参照してください。 |
27-
| 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)を参照してください。 |
28-
23+
| オペレーティングシステム | 必要なソフトウェア | 備考 |
24+
| :----------------------------- | :---------------------------------------- | :----- |
25+
| macOS 10.14 以降 | Docker Desktop | Docker 仮想マシンを最低 2 つの仮想 CPU と 8 GiB のメモリで設定してください。<br></br><br></br>インストール手順については、[Mac 用 Docker Desktop のインストール](https://docs.docker.com/desktop/mac/install/) を参照してください。 |
26+
| 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/) を参照してください。 |
27+
| 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) を参照してください。 |
2928

3029
## デプロイと起動
3130

3231
<Steps>
33-
<Step title="Difyをクローン">
34-
Difyのソースコードをローカルマシンにクローンします
32+
<Step title="Dify をクローン">
33+
Dify のソースコードをローカルマシンにクローンします
3534

3635
```bash
3736
git clone --branch "$(curl -s https://api.github.com/repos/langgenius/dify/releases/latest | jq -r .tag_name)" https://github.com/langgenius/dify.git
3837
```
3938
</Step>
40-
<Step title="Difyを起動">
39+
<Step title="Dify を起動">
4140

42-
1. Difyソースコード内の`docker`ディレクトリに移動します:
41+
1. Dify ソースコード内の `docker` ディレクトリに移動します:
4342

4443
```bash
4544
cd dify/docker
@@ -50,13 +49,8 @@ sidebarTitle: Docker Compose
5049
```bash
5150
cp .env.example .env
5251
```
53-
<Note>
54-
フロントエンドとバックエンドが異なるサブドメインで動作する場合は、`.env`ファイルで`COOKIE_DOMAIN`をサイトのトップレベルドメイン(例:`example.com`)に設定し、`NEXT_PUBLIC_COOKIE_DOMAIN``1`に設定してください。
55-
56-
認証Cookieを共有するためには、フロントエンドとバックエンドが同じトップレベルドメイン下にある必要があります。
57-
</Note>
5852

59-
3. お使いのDocker Composeバージョンに合わせたコマンドでコンテナを起動します
53+
3. お使いの Docker Compose バージョンに合わせたコマンドでコンテナを起動します
6054

6155
<CodeGroup>
6256
```bash Docker Compose V2
@@ -68,13 +62,13 @@ sidebarTitle: Docker Compose
6862
</CodeGroup>
6963

7064
<Tip>
71-
`docker compose version`を実行してDocker Composeのバージョンを確認してください
72-
</Tip>
65+
`docker compose version` を実行して Docker Compose のバージョンを確認してください
66+
</Tip>
7367

7468
以下のコンテナが起動されます:
7569

76-
- 5つのコアサービス`api``worker``worker_beat``web``plugin_daemon`
77-
- 6つの依存コンポーネント`weaviate``db_postgres``redis``nginx``ssrf_proxy``sandbox`
70+
- 5 つのコアサービス`api``worker``worker_beat``web``plugin_daemon`
71+
- 6 つの依存コンポーネント`weaviate``db_postgres``redis``nginx``ssrf_proxy``sandbox`
7872

7973
各コンテナのステータスと起動時間を示す以下のような出力が表示されるはずです:
8074

@@ -132,7 +126,7 @@ sidebarTitle: Docker Compose
132126
http://your_server_ip/install
133127
```
134128

135-
2. 管理者アカウントの設定が完了したら、以下のアドレスでDifyにログインします
129+
2. 管理者アカウントの設定が完了したら、以下のアドレスで Dify にログインします
136130

137131
```bash
138132
# ローカル環境
@@ -144,23 +138,23 @@ sidebarTitle: Docker Compose
144138

145139
## カスタマイズ
146140

147-
ローカルの`.env`ファイルの環境変数値を変更し、Difyを再起動して変更を適用します
141+
ローカルの `.env` ファイルの環境変数値を変更し、Dify を再起動して変更を適用します
148142

149-
```
143+
```bash
150144
docker compose down
151145
docker compose up -d
152146
```
153147

154148
<Tip>
155-
詳細については、[環境変数](/ja/self-host/configuration/environments)を参照してください。
149+
詳細については、[環境変数](/ja/self-host/configuration/environments) を参照してください。
156150
</Tip>
157151

158152
## アップグレード
159153

160-
アップグレード手順はリリースによって異なる場合があります。[Releases](https://github.com/langgenius/dify/releases)ページで提供されている対象バージョンのアップグレードガイドを参照してください。
154+
アップグレード手順はリリースによって異なる場合があります。[Releases](https://github.com/langgenius/dify/releases) ページで提供されている対象バージョンのアップグレードガイドを参照してください。
161155

162156
<Note>
163157

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

166160
</Note>

ja/self-host/quick-start/faqs.mdx

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,15 @@ git clone https://github.com/langgenius/dify.git --branch 0.15.3
1818

1919
### ZIP アーカイブを使用したインストール
2020

21-
ネットワーク制限がある環境やgitが利用できない場合
21+
ネットワーク制限がある環境や git が利用できない場合
2222

2323
```bash
2424
# 最新リリースをダウンロード
2525
wget -O dify.zip "$(curl -s https://api.github.com/repos/langgenius/dify/releases/latest | jq -r '.zipball_url')"
2626
unzip dify.zip && rm dify.zip
2727
```
2828

29-
または、別のデバイスでZIPをダウンロードして手動で転送することもできます
29+
または、別のデバイスで ZIP をダウンロードして手動で転送することもできます
3030

3131
**アップグレードするには**
3232
```bash
@@ -50,3 +50,21 @@ cp -r dify "dify.bak.$(date +%Y%m%d%H%M%S)"
5050
```
5151

5252
これにより、復元しやすいタイムスタンプ付きのバックアップが作成されます。
53+
54+
## リバースプロキシ設定
55+
56+
### フロントエンドとバックエンドが異なるサブドメインで動作する場合のログインセッション切れ
57+
58+
Web と API を異なるサブドメインに分けてリバースプロキシ経由で公開している場合、認証 Cookie が両方のホストに届きません。たとえば UI が `app.example.com`、バックエンドが `api.example.com` の構成です。ログインは成功したように見えても、次のリクエストでセッションが切れます。
59+
60+
`.env` で両方の変数を設定し、Dify を再起動してください:
61+
62+
- **`COOKIE_DOMAIN`**:共有するトップレベルドメインを指定します(例:`example.com`)。先頭のドットは省略可能です。
63+
- **`NEXT_PUBLIC_COOKIE_DOMAIN`**`1` を設定すると、フロントエンドでサブドメイン間の Cookie 共有が有効になります。
64+
65+
```bash
66+
docker compose down
67+
docker compose up -d
68+
```
69+
70+
Cookie はトップレベルドメインを越えて共有できないため、フロントエンドとバックエンドは同じ登録可能ドメイン内にある必要があります。詳細は [環境変数](/ja/self-host/configuration/environments) を参照してください。

zh/self-host/quick-start/docker-compose.mdx

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebarTitle: Docker Compose
66
<Note> ⚠️ 本文档由 AI 自动翻译。如有任何不准确之处,请参考 [英文原版](/en/self-host/quick-start/docker-compose)。</Note>
77

88
<Tip>
9-
如需了解常见部署问题,请参阅[常见问题解答](/zh/self-host/quick-start/faqs)
9+
如需了解常见部署问题,请参阅 [常见问题解答](/zh/self-host/quick-start/faqs)
1010
</Tip>
1111

1212
## 部署前准备
@@ -50,11 +50,6 @@ sidebarTitle: Docker Compose
5050
```bash
5151
cp .env.example .env
5252
```
53-
<Note>
54-
当前端和后端运行在不同子域名时,需要在 `.env` 文件中将 `COOKIE_DOMAIN` 设置为站点的顶级域名(例如 `example.com`),并将 `NEXT_PUBLIC_COOKIE_DOMAIN` 设置为 `1`
55-
56-
前端和后端必须位于同一顶级域名下才能共享认证 Cookie。
57-
</Note>
5853

5954
3. 根据你的 Docker Compose 版本选择相应命令启动容器:
6055

@@ -146,13 +141,13 @@ sidebarTitle: Docker Compose
146141

147142
修改本地 `.env` 文件中的环境变量值,然后重启 Dify 以应用更改:
148143

149-
```
144+
```bash
150145
docker compose down
151146
docker compose up -d
152147
```
153148

154149
<Tip>
155-
更多信息请参阅[环境变量](/zh/self-host/configuration/environments)
150+
更多信息请参阅 [环境变量](/zh/self-host/configuration/environments)
156151
</Tip>
157152

158153
## 升级

zh/self-host/quick-start/faqs.mdx

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ title: 常见问题
44

55
<Note> ⚠️ 本文档由 AI 自动翻译。如有任何不准确之处,请参考 [英文原版](/en/self-host/quick-start/faqs)。</Note>
66

7-
87
## 部署方法
98

109
### 安装旧版本
@@ -51,3 +50,21 @@ cp -r dify "dify.bak.$(date +%Y%m%d%H%M%S)"
5150
```
5251

5352
这将创建一个带时间戳的备份,便于轻松恢复。
53+
54+
## 反向代理配置
55+
56+
### 前端和后端使用不同子域名时登录会话失效
57+
58+
若已将 Web 和 API 拆分到不同子域名并部署在反向代理之后(例如 `app.example.com` 用于 UI,`api.example.com` 用于后端),认证 Cookie 无法同时到达两个主机。登录看似成功,但下一次请求时会话即丢失。
59+
60+
`.env` 中设置以下两个变量,然后重启 Dify:
61+
62+
- **`COOKIE_DOMAIN`**:设为前后端共享的顶级域名(例如 `example.com`),前导点可省略。
63+
- **`NEXT_PUBLIC_COOKIE_DOMAIN`**:设为 `1`,启用前端的跨子域名 Cookie。
64+
65+
```bash
66+
docker compose down
67+
docker compose up -d
68+
```
69+
70+
Cookie 无法跨顶级域名共享,因此前端和后端必须位于同一可注册域名下。详见 [环境变量](/zh/self-host/configuration/environments)

0 commit comments

Comments
 (0)