Skip to content

Commit ea59046

Browse files
author
Riskey
committed
changes after review
1 parent 2805cfd commit ea59046

7 files changed

Lines changed: 85 additions & 82 deletions

File tree

en/self-host/configuration/environments.mdx

Lines changed: 41 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -116,20 +116,18 @@ Only effective when starting with docker image or docker-compose.
116116
- GUNICORN_TIMEOUT: Request handling timeout. Default is 200. Recommended value is 360 to support longer SSE (Server-Sent Events) connection times.
117117
- CELERY_WORKER_CLASS: Similar to `SERVER_WORKER_CLASS`. Default is gevent. If using windows, it can be switched to sync or solo.
118118
- CELERY_WORKER_AMOUNT: The number of Celery workers. The default is 1, and can be set as needed.
119-
- HTTP_PROXY: HTTP proxy address, used to solve the problem of accessing OpenAI and HuggingFace in China. Note that if the proxy is deployed on the host machine (e.g. `http://127.0.0.1:7890`), the proxy address should be the same as when connecting to a local model, using the host machine address inside the Docker container (e.g. `http://192.168.1.100:7890` or `http://172.17.0.1:7890`).
120-
- HTTPS_PROXY: HTTPS proxy address, used to solve the problem of accessing OpenAI and HuggingFace in China. Same as above.
121-
- COMPOSE_PROFILES: Selectively start service groups. The default value is `${VECTOR_STORE:-weaviate},${DB_TYPE:-postgresql}`, which will be automatically assigned by `VECTOR_STORE` and `DB_TYPE`. Generally, no adjustment is needed, only when the metadata selection is oceanbase or seekdb, or the vector database selection is seekdb, manual adjustment is required.
119+
- COMPOSE_PROFILES: Selectively start service groups. The default value is `${VECTOR_STORE:-weaviate},${DB_TYPE:-postgresql}`, which is automatically derived from `VECTOR_STORE` and `DB_TYPE`.
122120

123121
### Database Configuration
124122

125123
The database uses PostgreSQL. Please use the public schema.
126124

127-
- DB_TYPE: Database type. Default is postgresql.
125+
- DB_TYPE: Database type.
128126

129-
**Available enumeration types include:**
127+
Available values include:
130128

131-
- `postgresql`
132-
- `mysql` (other mysql-compatible databases can also use this value. Example: OceanBase, seekdb, etc.)
129+
- `postgresql`(default)
130+
- `mysql` (MySQL-compatible databases like OceanBase and seekdb can also use this value)
133131

134132
- DB_USERNAME: username
135133
- DB_PASSWORD: password
@@ -252,18 +250,18 @@ Used to store uploaded data set files, team/tenant encryption keys, and other fi
252250

253251
- VECTOR_STORE
254252

255-
**Available enumeration types include:**
253+
Available values include:
256254

257255
- `weaviate`
258-
- `oceanbase`
259-
- `seekdb` (share the same configuration as `oceanbase`)
260256
- `qdrant`
261257
- `milvus`
262258
- `zilliz` (share the same configuration as `milvus`)
263259
- `myscale`
264260
- `pinecone` (not yet open)
265261
- `analyticdb`
266262
- `couchbase`
263+
- `oceanbase`
264+
- `seekdb` (share the same configuration as `oceanbase`)
267265
- `tablestore`
268266
- `lindorm`
269267
- `tencent`
@@ -287,38 +285,6 @@ Used to store uploaded data set files, team/tenant encryption keys, and other fi
287285

288286
Whether to use the gRPC method to interact with Weaviate, performance will greatly increase when enabled, may not be usable locally, default is true.
289287

290-
- OCEANBASE_VECTOR_HOST
291-
292-
The hostname or IP address of OceanBase vector database.
293-
294-
- OCEANBASE_VECTOR_PORT
295-
296-
The port of OceanBase vector database.
297-
298-
- OCEANBASE_VECTOR_USER
299-
300-
The username of OceanBase vector database.
301-
302-
- OCEANBASE_VECTOR_PASSWORD
303-
304-
The password of OceanBase vector database user.
305-
306-
- OCEANBASE_VECTOR_DATABASE
307-
308-
The database name of OceanBase vector database.
309-
310-
- OCEANBASE_CLUSTER_NAME
311-
312-
The cluster name of OceanBase vector database, only available for Docker deployment.
313-
314-
- OCEANBASE_MEMORY_LIMIT
315-
316-
The memory limit of OceanBase vector database, only available for Docker deployment.
317-
318-
- SEEKDB_MEMORY_LIMIT
319-
320-
The memory limit of Seekdb, only available for Docker deployment.
321-
322288
- QDRANT_URL
323289

324290
Qdrant endpoint address, such as: `https://your-qdrant-cluster-url.qdrant.tech/`
@@ -427,6 +393,38 @@ Used to store uploaded data set files, team/tenant encryption keys, and other fi
427393

428394
The name of the scope to use.
429395

396+
- OCEANBASE_VECTOR_HOST
397+
398+
The hostname or IP address of OceanBase vector database.
399+
400+
- OCEANBASE_VECTOR_PORT
401+
402+
The port of OceanBase vector database.
403+
404+
- OCEANBASE_VECTOR_USER
405+
406+
The username of OceanBase vector database.
407+
408+
- OCEANBASE_VECTOR_PASSWORD
409+
410+
The password of OceanBase vector database user.
411+
412+
- OCEANBASE_VECTOR_DATABASE
413+
414+
The database name of OceanBase vector database.
415+
416+
- OCEANBASE_CLUSTER_NAME
417+
418+
The cluster name of OceanBase vector database, only available for Docker deployment.
419+
420+
- OCEANBASE_MEMORY_LIMIT
421+
422+
The memory limit of OceanBase vector database, only available for Docker deployment.
423+
424+
- SEEKDB_MEMORY_LIMIT
425+
426+
The memory limit of seekdb, only available for Docker deployment.
427+
430428
- TABLESTORE_ENDPOINT
431429

432430
The endpoint address of the TableStore server (e.g. 'https://instance-name.cn-hangzhou.ots.aliyuncs.com')
@@ -545,7 +543,7 @@ Used to store uploaded data set files, team/tenant encryption keys, and other fi
545543
- UPLOAD_FILE_BATCH_LIMIT: The maximum number of files that can be uploaded at a time, default 5.
546544
- ETL_TYPE
547545

548-
**Available enumeration types include:**
546+
Available values include
549547

550548
- dify: Dify's proprietary file extraction scheme
551549
- Unstructured: Unstructured.io file extraction scheme

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

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -40,15 +40,15 @@ title: Docker Compose
4040
</tbody>
4141
</table>
4242

43-
### Clone Dify
43+
## Clone Dify
4444

4545
Clone the Dify source code to your local machine:
4646

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

51-
### Starting Dify
51+
## Start Dify
5252

5353
1. Navigate to the Docker directory in the Dify source code
5454

@@ -125,7 +125,7 @@ docker-worker_beat-1 langgenius/dify-api:1.10.1 "/bin/bash
125125

126126
With these steps, you should be able to install Dify successfully.
127127

128-
### Upgrade Dify
128+
## Upgrade Dify
129129

130130
Enter the docker directory of the dify source code and execute the following commands:
131131

@@ -137,12 +137,13 @@ docker compose pull
137137
docker compose up -d
138138
```
139139

140-
#### Sync Environment Variable Configuration (Important)
140+
<Note>
141+
* If the `.env.example` file has been updated, be sure to modify your local `.env` file accordingly.
141142

142-
* If the `.env.example` file has been updated, be sure to modify your local `.env` file accordingly.
143-
* Check and modify the configuration items in the `.env` file as needed to ensure they match your actual environment. You may need to add any new variables from `.env.example` to your `.env` file, and update any values that have changed.
143+
* Check and modify the configuration items in the `.env` file as needed to ensure they match your actual environment. You may need to add any new variables from `.env.example` to your `.env` file, and update any values that have changed.
144+
</Note>
144145

145-
### Access Dify
146+
## Access Dify
146147

147148
Access administrator initialization page to set up the admin account:
148149

@@ -164,19 +165,19 @@ http://localhost
164165
http://your_server_ip
165166
```
166167

167-
### Customize Dify
168+
## Customize Dify
168169

169170
Edit the environment variable values in your `.env` file directly. Then, restart Dify with:
170171

171-
You can switch the metadata database by modifying `DB_TYPE` and switch the vector database by modifying `VECTOR_STORE`. For more information, please refer to the [environment variables](https://docs.dify.ai/en/self-host/configuration/environments).
172-
173172
```
174173
docker compose down
175174
docker compose up -d
176175
```
177176

178-
The full set of annotated environment variables along can be found under docker/.env.example.
177+
<Tip>
178+
The full set of annotated environment variables along can be found under `docker/.env.example`. For more information, see [environment variables](/en/self-host/configuration/environments).
179+
</Tip>
179180

180-
### Read More
181+
## Read More
181182

182-
If you have any questions, please refer to [FAQs](/en/self-host/quick-start/faqs).
183+
If you have any questions, see [FAQs](/en/self-host/quick-start/faqs).

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: FAQs
99
Use the `--branch` flag to install a specific version:
1010

1111
```bash
12-
git clone https://github.com/langgenius/dify.git --branch 1.10.1
12+
git clone https://github.com/langgenius/dify.git --branch 0.15.3
1313
```
1414

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

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

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -42,15 +42,15 @@ title: Docker Compose
4242
</tbody>
4343
</table>
4444

45-
### Difyのクローン
45+
## Difyのクローン
4646

4747
Difyのソースコードをローカルマシンにクローンします:
4848

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

53-
### Difyの起動
53+
## Difyの起動
5454

5555
1. Difyソースコード内のDockerディレクトリに移動します
5656

@@ -127,7 +127,7 @@ docker-worker_beat-1 langgenius/dify-api:1.10.1 "/bin/bash
127127

128128
これらの手順により、Difyを正常にインストールできるはずです。
129129

130-
### Difyのアップグレード
130+
## Difyのアップグレード
131131

132132
difyソースコードのdockerディレクトリに移動し、以下のコマンドを実行します:
133133

@@ -139,12 +139,13 @@ docker compose pull
139139
docker compose up -d
140140
```
141141

142-
#### 環境変数設定の同期(重要)
142+
<Note>
143+
* `.env.example`ファイルが更新されている場合は、必ずローカルの`.env`ファイルをそれに応じて変更してください。
143144

144-
* `.env.example`ファイルが更新されている場合は、必ずローカルの`.env`ファイルをそれに応じて変更してください
145-
* 実際の環境に合わせて`.env`ファイルの設定項目を確認・変更してください。`.env.example`から新しい変数を`.env`ファイルに追加し、変更された値を更新する必要がある場合があります。
145+
* 実際の環境に合わせて`.env`ファイルの設定項目を確認・変更してください。`.env.example`から新しい変数を`.env`ファイルに追加し、変更された値を更新する必要がある場合があります
146+
</Note>
146147

147-
### Difyへのアクセス
148+
## Difyへのアクセス
148149

149150
管理者初期化ページにアクセスして、管理者アカウントを設定します:
150151

@@ -166,19 +167,19 @@ http://localhost
166167
http://your_server_ip
167168
```
168169

169-
### Difyのカスタマイズ
170+
## Difyのカスタマイズ
170171

171172
`.env`ファイルの環境変数値を直接編集します。その後、以下のコマンドでDifyを再起動します:
172173

173-
メタデータデータベースを変更するには、`DB_TYPE`を変更し、ベクトルデータベースを変更するには、`VECTOR_STORE`を変更してください。詳細については、[環境変数](https://docs.dify.ai/jp/self-host/configuration/environments)を参照してください。
174-
175174
```
176175
docker compose down
177176
docker compose up -d
178177
```
179178

180-
完全な注釈付き環境変数セットは docker/.env.example で見つけることができます。
179+
<Tip>
180+
完全な注釈付き環境変数セットは docker/.env.example で見つけることができます。詳細については、[環境変数](/ja/self-host/configuration/environments)を参照してください。
181+
</Tip>
181182

182-
### 詳細情報
183+
## 詳細情報
183184

184185
ご質問がある場合は、[FAQ](/ja/self-host/quick-start/faqs)を参照してください。

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ title: よくある質問
1111
`--branch` フラグを使用して特定のバージョンをインストールします:
1212

1313
```bash
14-
git clone https://github.com/langgenius/dify.git --branch 1.10.1
14+
git clone https://github.com/langgenius/dify.git --branch 0.15.3
1515
```
1616

1717
残りのセットアップは最新版のインストールと同じです。

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

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -42,15 +42,15 @@ title: Docker Compose
4242
</tbody>
4343
</table>
4444

45-
### 克隆 Dify
45+
## 克隆 Dify
4646

4747
将 Dify 源代码克隆到本地机器:
4848

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

53-
### 启动 Dify
53+
## 启动 Dify
5454

5555
1. 导航到 Dify 源代码中的 Docker 目录
5656

@@ -127,7 +127,7 @@ docker-worker_beat-1 langgenius/dify-api:1.10.1 "/bin/bash
127127

128128
通过这些步骤,你应该能够成功安装 Dify。
129129

130-
### 升级 Dify
130+
## 升级 Dify
131131

132132
进入 Dify 源代码的 docker 目录并执行以下命令:
133133

@@ -139,12 +139,13 @@ docker compose pull
139139
docker compose up -d
140140
```
141141

142-
#### 同步环境变量配置(重要)
142+
<Note>
143+
* 如果 `.env.example` 文件已更新,请确保相应地修改你的本地 `.env` 文件。
143144

144-
* 如果 `.env.example` 文件已更新,请确保相应地修改你的本地 `.env` 文件
145-
* 根据需要检查和修改 `.env` 文件中的配置项,确保它们与你的实际环境匹配。你可能需要将 `.env.example` 中的任何新变量添加到你的 `.env` 文件中,并更新任何已更改的值。
145+
* 根据需要检查和修改 `.env` 文件中的配置项,确保它们与你的实际环境匹配。你可能需要将 `.env.example` 中的任何新变量添加到你的 `.env` 文件中,并更新任何已更改的值
146+
</Note>
146147

147-
### 访问 Dify
148+
## 访问 Dify
148149

149150
访问管理员初始化页面以设置管理员账户:
150151

@@ -166,19 +167,21 @@ http://localhost
166167
http://your_server_ip
167168
```
168169

169-
### 自定义 Dify
170+
## 自定义 Dify
170171

171172
直接编辑你的 `.env` 文件中的环境变量值。然后,使用以下命令重启 Dify:
172173

173-
比如你可以通过修改`DB_TYPE`来切换元数据库,通过修改`VECTOR_STORE`来切换向量数据库,详细说明请参考[环境变量](https://docs.dify.ai/cn/self-host/configuration/environments)
174174

175175
```
176176
docker compose down
177177
docker compose up -d
178178
```
179179

180-
完整的带注释环境变量集合可在 docker/.env.example 下找到。
180+
<Tip>
181+
完整的带注释环境变量集合可在 `docker/.env.example` 中找到。详细说明请参考 [环境变量](/zh/self-host/configuration/environments)
182+
</Tip>
181183

182-
### 了解更多
184+
185+
## 了解更多
183186

184187
如果你有任何问题,请参阅 [常见问题解答](/zh/self-host/quick-start/faqs)

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ title: 常见问题
1212
使用 `--branch` 标志来安装特定版本:
1313

1414
```bash
15-
git clone https://github.com/langgenius/dify.git --branch 1.10.1
15+
git clone https://github.com/langgenius/dify.git --branch 0.15.3
1616
```
1717

1818
其余设置与安装最新版本相同。

0 commit comments

Comments
 (0)